Endpoint
Authentication
Requires a Personal API Access Token.Header
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
NoneRequest Body
This endpoint does not require a request body.Response
Success Response (200 OK)
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 Response (401 Unauthorized)
cURL Example
Permissions
User must haveAPI_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

