Skip to main content
POST
/
environment
/
{environmentId}
/
cancelDeployment
Cancel environment deployment
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/cancelDeployment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "force_cancel": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "BUILDING",
  "last_deployment_state": "BUILDING",
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "last_deployment_id": "<string>",
  "total_deployment_duration_in_seconds": 123,
  "origin": "API",
  "triggered_by": "<string>",
  "deployment_status": "NEVER_DEPLOYED"
}

Authorizations

​
Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

​
environmentId
string<uuid>
required

Environment ID

Body

application/json
​
force_cancel
boolean
default:false

Force cancel everything running in this environment if set to true (e.q lifecycle jobs triggered during the deployment).

Response

environment deployment cancelling has been requested

​
id
string<uuid>
required
​
state
enum<string>
required
Available options:
BUILDING,
BUILD_ERROR,
CANCELED,
CANCELING,
DELETED,
DELETE_ERROR,
DELETE_QUEUED,
DELETING,
DEPLOYED,
DEPLOYING,
DEPLOYMENT_ERROR,
DEPLOYMENT_QUEUED,
EXECUTING,
QUEUED,
READY,
RECAP,
RESTARTED,
RESTARTING,
RESTART_ERROR,
RESTART_QUEUED,
STOPPED,
STOPPING,
STOP_ERROR,
STOP_QUEUED,
WAITING_DELETING,
WAITING_RESTARTING,
WAITING_RUNNING,
WAITING_STOPPING
​
last_deployment_state
enum<string>
required
Available options:
BUILDING,
BUILD_ERROR,
CANCELED,
CANCELING,
DELETED,
DELETE_ERROR,
DELETE_QUEUED,
DELETING,
DEPLOYED,
DEPLOYING,
DEPLOYMENT_ERROR,
DEPLOYMENT_QUEUED,
EXECUTING,
QUEUED,
READY,
RECAP,
RESTARTED,
RESTARTING,
RESTART_ERROR,
RESTART_QUEUED,
STOPPED,
STOPPING,
STOP_ERROR,
STOP_QUEUED,
WAITING_DELETING,
WAITING_RESTARTING,
WAITING_RUNNING,
WAITING_STOPPING
​
last_deployment_date
string<date-time> | null
​
last_deployment_id
string | null
​
total_deployment_duration_in_seconds
integer | null
​
origin
enum<string> | null

Origin of the organization event

Available options:
API,
CLI,
CONSOLE,
GIT,
QOVERY_INTERNAL,
TERRAFORM_PROVIDER
Example:

"API"

​
triggered_by
string | null
​
deployment_status
enum<string>
Available options:
NEVER_DEPLOYED,
UP_TO_DATE,
OUT_OF_DATE