Restart an application

Restart an application's containers.

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

Restarts the application's containers, without fetching or rebuilding anything. Requires an admin token.

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

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/restart' \
  -H 'Authorization: Bearer $TOKEN'

200

200The application was restarted.

Response

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

401

401The token is missing or invalid.

Response

{
  "error": "invalid token"
}

403

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

Response

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

404

404No application has this identifier.

Response

{
  "error": "application not found"
}

500

500Docker refused the restart.

Response

{
  "error": "string"
}