Skip to main content
POST
/
environment
/
{environmentId}
/
service
/
stop
Stop services
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/service/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "application_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "container_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "database_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "job_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "helm_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "terraform_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
import requests

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

payload = {
    "application_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "container_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "database_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "job_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "helm_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "terraform_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
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({
    application_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    container_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    database_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    job_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    helm_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    terraform_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.qovery.com/environment/{environmentId}/service/stop', 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/stop",
  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([
    'application_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'container_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'database_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'job_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'helm_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'terraform_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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/stop"

	payload := strings.NewReader("{\n  \"application_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"container_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"database_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"job_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"helm_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"terraform_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/stop")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"application_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"container_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"database_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"job_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"helm_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"terraform_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"application_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"container_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"database_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"job_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"helm_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"terraform_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

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
application_ids
string<uuid>[]
container_ids
string<uuid>[]
database_ids
string<uuid>[]
job_ids
string<uuid>[]
helm_ids
string<uuid>[]
terraform_ids
string<uuid>[]

Response

Services have been triggered to be deleted