Ana içeriğe atla

​
Endpoint

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

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name (must exist)

​
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"
    },
    {
      "revision": 11,
      "username": "admin",
      "deploymentTime": "2026-04-15T08:00:00Z",
      "description": "Undeployed for maintenance",
      "environment": "production",
      "deploy": false,
      "persistent": true,
      "backendApiVersion": "1.0.0"
    }
  ],
  "resultCount": 2
}

​
Response Fields

FieldTypeDescription
statusstringRequest status (SUCCESS or FAILURE)
resultListarrayList of deploy history records
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
resultCountintegerTotal number of records

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "ApiProxy with name (petstore-api) is not found!"
}

​
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/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Notes and Warnings

  • Revision Number: Each deploy/undeploy operation receives a sequentially incrementing revision per API Proxy. Use this value in detail, delete, and rollback endpoints.
  • Persistent Records: Records marked as persistent: true are never auto-deleted, even when the system-wide deploy history retention limit is exceeded.
  • Backend API Version: The backendApiVersion field shows the API version at the time of deployment, which may differ from the current version.

​
Permissions

User must have API_MANAGEMENT + VIEW permission in the project.