Get Deploy History Detail

Returns the full detail of a specific deploy history record identified by its revision number, including the API Proxy snapshot at the time of deployment.

​

Endpoint

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

​

Authentication

Requires a Personal API Access Token.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

Header	Value	Required
Authorization	Bearer	Yes

​

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
apiProxyName	string	Yes	API Proxy name
revision	integer	Yes	Deploy 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

Field	Type	Description
status	string	Request status (SUCCESS or FAILURE)
resultList	array	Single-element array with the deploy history record
resultList[].revision	integer	Sequentially incrementing revision number (per API Proxy)
resultList[].username	string	User who performed the deployment
resultList[].deploymentTime	string	ISO 8601 deployment timestamp
resultList[].description	string	Deployment description/notes
resultList[].environment	string	Target environment name
resultList[].deploy	boolean	true for deploy, false for undeploy
resultList[].persistent	boolean	Whether this record is protected from auto-deletion
resultList[].backendApiVersion	string	Backend API version at the time of deployment
resultCount	integer	Always 1 for a single record

​

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Deploy history with revision (12) is not found for ApiProxy (petstore-api)!"
}

​

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​

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.

​

Related Documentation

• List Deploy History - List all deploy history records
• Rollback Deploy History - Rollback API proxy to a previous deployment
• Delete Deploy History - Delete a deploy history record