Application Deployments

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
Request
path Parameters
deployment_id
required
string
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
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
Response samples
application/json
{
  • "deployment": {
    }
}

Manually deploy an application

SecuritybearerAuth
Request
Request Body schema: application/json
required
app_id
required
string
branch
required
string
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
application/json
{
  • "app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "branch": "main"
}
Response samples
application/json
{
  • "deployment": {
    }
}

Promote an application

SecuritybearerAuth
Request
Request Body schema: application/json
required
source_app_id
required
string
target_app_ids
required
Array of strings
Responses
200

App promoted successfully

401

No or invalid API key provided to the request

500

Error occurred while promoting the app

post/applications/promote
Request samples
application/json
{
  • "source_app_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "target_app_ids": [
    ]
}
Response samples
application/json
{
  • "promote": [
    ]
}