Skip to main content
POST
/
job
/
{jobId}
/
deploy
Deploy job
curl --request POST \
  --url https://api.qovery.com/job/{jobId}/deploy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "image_tag": "<string>",
  "git_commit_id": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "BUILDING",
  "service_deployment_status": "NEVER_DEPLOYED",
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "is_part_last_deployment": true,
  "steps": {
    "total_duration_sec": 123,
    "total_computing_duration_sec": 123,
    "details": [
      {
        "step_name": "REGISTRY_CREATE_REPOSITORY",
        "status": "SUCCESS",
        "duration_sec": 123
      }
    ]
  },
  "execution_id": "<string>",
  "status_details": {
    "action": "DEPLOY",
    "status": "QUEUED"
  },
  "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_requests_count": 123
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
jobId
string<uuid>
required

Job ID

Query Parameters

​
forceEvent
enum<string>

When filled, it indicates the target event to be deployed.
If the concerned job hasn't the target event provided, the job won't be deployed.

Available options:
START,
STOP,
DELETE,
CRON

Body

application/json
​
image_tag
string

Image tag to deploy.
Cannot be set if git_commit_id is defined

​
git_commit_id
string

Commit to deploy Cannot be set if image_tag is defined

Response

Deploy job

​
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
​
service_deployment_status
enum<string>
required
Available options:
NEVER_DEPLOYED,
OUT_OF_DATE,
UP_TO_DATE
​
status_details
object
required
​
last_deployment_date
string<date-time>
​
is_part_last_deployment
boolean
​
steps
object
​
execution_id
string
​
deployment_request_id
string<uuid> | null
​
deployment_requests_count
integer