With the deployments endpoint, you can get deployment details like the deployment progress and more.
You can also send a POST request to the endpoint to manually or programmatically deploy an application. This request can be done from your terminal or using an automated script or CI/CD pipeline (e.g. CircleCI, Jenkins, etc.).
Get application deployment details
SecuritybearerAuth
Responses
200
Response object of application deployment by ID requests
401
No or invalid API key provided to the request
404
Could not find the application deployment or the user does not have permissions to retrieve data
500
Error occurred while retrieving application deployment
get/applications/deployments/{deployment_id}
Request samples
- curl
- Node.js
- Browser JavaScript
- PHP
Response samples
- 200
- 401
- 404
- 500
application/json
{- "deployment": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "branch": "main",
- "commit_sha": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "author_login": "john-doe",
- "commit_message": "docs: example",
- "status": "success",
- "created_at": 1665382600770,
- "rollout": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "started_at": 1665382601699,
- "finished_at": 1665382746172,
- "status": "success",
- "internal_error": "null"
}, - "build": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "started_at": 1665382601699,
- "finished_at": 1665382746172,
- "status": "success"
}
}
}Manually deploy an application
SecuritybearerAuth
Responses
200
Deployment created successfully
401
No or invalid API key provided to the request
500
Error occurred while creating the deployment
post/applications/deployments
Request samples
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
application/json
{- "app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "branch": "main"
}Response samples
- 200
- 401
- 500
application/json
{- "deployment": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}
}