Deploy an application

Fetch the latest version of an application and deploy it.

POST/api/v1/apps/{id}/deploy

Fetches the latest version of the application and deploys it, like the Update button in the dashboard: it pulls the image, or pulls the branch and rebuilds. The call returns as soon as the deployment has started. Poll GET /api/v1/apps/{id} to follow its state. Requires an admin token.

Authorizations

bearerAuthbearer
An API token created in Settings → API tokens. Tokens start with qsr_.

Path parameters

idstringrequired
Identifier of the application, as returned by GET /api/v1/apps.

Request

curl -X POST 'https://admin.your-domain.com/api/v1/apps/3f9c2a7e/deploy' \
  -H 'Authorization: Bearer $TOKEN'

Responses

202

202The deployment has started.

statusstringrequired
appstringrequired
Identifier of the application.

Response

{
  "status": "deploying",
  "app": "3f9c2a7e"
}

401

401The token is missing or invalid.

errorstringrequired
What went wrong.

Response

{
  "error": "invalid token"
}

403

403The token is a viewer token, and this call needs an admin one.

errorstringrequired
What went wrong.

Response

{
  "error": "this token is read-only"
}

404

404No application has this identifier.

errorstringrequired
What went wrong.

Response

{
  "error": "application not found"
}

409

409A deployment of this application is already running.

errorstringrequired
What went wrong.

Response

{
  "error": "a deploy is already in progress"
}