Skip to main content
POST
/
environment
/
{environmentId}
/
service
/
deploy
Deploy services
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/service/deploy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "applications": [
    {
      "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "git_commit_id": "<string>"
    }
  ],
  "databases": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "containers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "image_tag": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "image_tag": "<string>",
      "git_commit_id": "<string>"
    }
  ],
  "helms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chart_version": "<string>",
      "git_commit_id": "<string>",
      "values_override_git_commit_id": "<string>"
    }
  ],
  "terraforms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "git_commit_id": "<string>",
      "dry_run": true,
      "force_unlock_state": true,
      "action": "PLAN"
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "BUILDING",
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "last_deployment_state": "BUILDING",
  "last_deployment_id": "<string>",
  "total_deployment_duration_in_seconds": 123,
  "origin": "API",
  "triggered_by": "<string>",
  "deployment_status": "NEVER_DEPLOYED"
}

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

​
environmentId
string<uuid>
required

Environment ID

Body

application/json
​
applications
object[]
​
databases
string<uuid>[]
​
containers
object[]
​
jobs
object[]
​
helms
object[]
​
terraforms
object[]

Response

Deployed services

​
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