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
Response object of application deployment by ID requests
No or invalid API key provided to the request
Could not find the application deployment or the user does not have permissions to retrieve data
Error occurred while retrieving application deployment
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "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
}
}Manually deploy an application
Deployment created successfully
No or invalid API key provided to the request
Error occurred while creating the deployment
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "branch": "main"
}- 200
- 401
- 500
{- "deployment": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}
}Promote an application
App promoted successfully
No or invalid API key provided to the request
Error occurred while promoting the app
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "source_app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "target_app_ids": [
- "14fb80af-576c-4fdc-ba4f-b596c83f15a1"
]
}- 200
- 401
- 500
{- "promote": [
- {
- "target_app_id": "14fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "deployment_id": "34fb80af-576c-4fdc-ba4f-b596c83f15a1"
}
]
}