Deploy job

You must provide a git commit id or an image tag depending on the source location of your code (git vs image repository).

POST /job/{jobId}/deploy

Deploy job

cURL

curl --request POST \
  --url https://api.qovery.com/job/{jobId}/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_tag": "<string>",
  "git_commit_id": "<string>"
}
'

202

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "BUILDING",
  "service_deployment_status": "NEVER_DEPLOYED",
  "is_part_last_deployment": true,
  "status_details": {
    "action": "DEPLOY",
    "status": "QUEUED",
    "sub_action": "NONE"
  },
  "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_requests_count": 123,
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "steps": {
    "total_duration_sec": 123,
    "total_computing_duration_sec": 123,
    "details": [
      {
        "step_name": "REGISTRY_CREATE_REPOSITORY",
        "status": "SUCCESS",
        "duration_sec": 123
      }
    ]
  },
  "execution_id": "<string>"
}

Authorizations

bearerAuthApiKeyAuth

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

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

202

application/json

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, UNAVAILABLE, WAITING_DELETING, WAITING_RESTARTING, WAITING_RUNNING, WAITING_STOPPING

service_deployment_status · enum<string> · required

Available options: NEVER_DEPLOYED, OUT_OF_DATE, UP_TO_DATE

is_part_last_deployment · boolean · required

status_details · object · required

Show child attributes

deployment_request_id · string<uuid> | null · required

deployment_requests_count · integer · required

last_deployment_date · string<date-time>

steps · object

Show child attributes

execution_id · string