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: Bearer <token>' \
  --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>"
    }
  ]
}
'
import requests

url = "https://api.qovery.com/environment/{environmentId}/service/deploy"

payload = {
    "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>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}]
  })
};

fetch('https://api.qovery.com/environment/{environmentId}/service/deploy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/service/deploy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/environment/{environmentId}/service/deploy"

	payload := strings.NewReader("{\n  \"applications\": [\n    {\n      \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"databases\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"containers\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\"\n    }\n  ],\n  \"jobs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"helms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"chart_version\": \"<string>\",\n      \"git_commit_id\": \"<string>\",\n      \"values_override_git_commit_id\": \"<string>\"\n    }\n  ],\n  \"terraforms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.qovery.com/environment/{environmentId}/service/deploy")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applications\": [\n    {\n      \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"databases\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"containers\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\"\n    }\n  ],\n  \"jobs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"helms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"chart_version\": \"<string>\",\n      \"git_commit_id\": \"<string>\",\n      \"values_override_git_commit_id\": \"<string>\"\n    }\n  ],\n  \"terraforms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/environment/{environmentId}/service/deploy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applications\": [\n    {\n      \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"databases\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"containers\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\"\n    }\n  ],\n  \"jobs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"image_tag\": \"<string>\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ],\n  \"helms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"chart_version\": \"<string>\",\n      \"git_commit_id\": \"<string>\",\n      \"values_override_git_commit_id\": \"<string>\"\n    }\n  ],\n  \"terraforms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"git_commit_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_deployment_date": "2023-11-07T05:31:56Z",
  "last_deployment_id": "<string>",
  "total_deployment_duration_in_seconds": 123,
  "origin": "API",
  "triggered_by": "<string>",
  "deployment_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metrics": [
    {
      "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_duration_sec": 123,
      "details": [
        {
          "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "duration_sec": 123
        }
      ]
    }
  ]
}

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
​
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,
UNAVAILABLE,
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,
UNAVAILABLE,
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
​
deployment_request_id
string<uuid> | null
​
metrics
object[] | null