Ana içeriğe geç

Get Deploy History Detail

Endpoint​

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/deploy-histories/{revision}/

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Headers​

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name
revisionintegerYesDeploy history revision number

Query Parameters​

None

Request Body​

This endpoint does not require a request body.

Response​

Success Response (200 OK)​

{
"status": "SUCCESS",
"resultList": [
{
"revision": 12,
"username": "admin",
"deploymentTime": "2026-04-16T10:30:00Z",
"description": "v2.1 release",
"environment": "production",
"deploy": true,
"persistent": false,
"backendApiVersion": "1.0.0"
}
],
"resultCount": 1
}

Response Fields​

FieldTypeDescription
statusstringRequest status (SUCCESS or FAILURE)
resultListarraySingle-element array with the deploy history record
resultList[].revisionintegerSequentially incrementing revision number (per API Proxy)
resultList[].usernamestringUser who performed the deployment
resultList[].deploymentTimestringISO 8601 deployment timestamp
resultList[].descriptionstringDeployment description/notes
resultList[].environmentstringTarget environment name
resultList[].deploybooleantrue for deploy, false for undeploy
resultList[].persistentbooleanWhether this record is protected from auto-deletion
resultList[].backendApiVersionstringBackend API version at the time of deployment
resultCountintegerAlways 1 for a single record

Error Response (400 Bad Request)​

{
"status": "FAILURE",
"resultMessage": "Deploy history with revision (12) is not found for ApiProxy (petstore-api)!"
}

Error Response (401 Unauthorized)​

{
"status": "FAILURE",
"resultMessage": "Token is not valid!"
}

cURL Example​

curl -X GET \
"https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/petstore-api/deploy-histories/12/" \
-H "Authorization: Bearer YOUR_TOKEN"

Permissions​

User must have API_MANAGEMENT + VIEW permission in the project.