Skip to main content
PUT
/
environment
/
{environmentId}
/
deploymentRule
/
{deploymentRuleId}
Edit an environment deployment rule
curl --request PUT \
  --url https://api.qovery.com/environment/{environmentId}/deploymentRule/{deploymentRuleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timezone": "UTC",
  "start_time": "1970-01-01T08:00:00.000Z",
  "stop_time": "1970-01-01T19:00:00.000Z",
  "weekdays": [
    "MONDAY"
  ],
  "on_demand_preview": false,
  "auto_preview": false,
  "auto_stop": false
}
'
import requests

url = "https://api.qovery.com/environment/{environmentId}/deploymentRule/{deploymentRuleId}"

payload = {
    "timezone": "UTC",
    "start_time": "1970-01-01T08:00:00.000Z",
    "stop_time": "1970-01-01T19:00:00.000Z",
    "weekdays": ["MONDAY"],
    "on_demand_preview": False,
    "auto_preview": False,
    "auto_stop": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    timezone: 'UTC',
    start_time: '1970-01-01T08:00:00.000Z',
    stop_time: '1970-01-01T19:00:00.000Z',
    weekdays: ['MONDAY'],
    on_demand_preview: false,
    auto_preview: false,
    auto_stop: false
  })
};

fetch('https://api.qovery.com/environment/{environmentId}/deploymentRule/{deploymentRuleId}', 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}/deploymentRule/{deploymentRuleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'timezone' => 'UTC',
    'start_time' => '1970-01-01T08:00:00.000Z',
    'stop_time' => '1970-01-01T19:00:00.000Z',
    'weekdays' => [
        'MONDAY'
    ],
    'on_demand_preview' => false,
    'auto_preview' => false,
    'auto_stop' => false
  ]),
  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}/deploymentRule/{deploymentRuleId}"

	payload := strings.NewReader("{\n  \"timezone\": \"UTC\",\n  \"start_time\": \"1970-01-01T08:00:00.000Z\",\n  \"stop_time\": \"1970-01-01T19:00:00.000Z\",\n  \"weekdays\": [\n    \"MONDAY\"\n  ],\n  \"on_demand_preview\": false,\n  \"auto_preview\": false,\n  \"auto_stop\": false\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.qovery.com/environment/{environmentId}/deploymentRule/{deploymentRuleId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"timezone\": \"UTC\",\n  \"start_time\": \"1970-01-01T08:00:00.000Z\",\n  \"stop_time\": \"1970-01-01T19:00:00.000Z\",\n  \"weekdays\": [\n    \"MONDAY\"\n  ],\n  \"on_demand_preview\": false,\n  \"auto_preview\": false,\n  \"auto_stop\": false\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"timezone\": \"UTC\",\n  \"start_time\": \"1970-01-01T08:00:00.000Z\",\n  \"stop_time\": \"1970-01-01T19:00:00.000Z\",\n  \"weekdays\": [\n    \"MONDAY\"\n  ],\n  \"on_demand_preview\": false,\n  \"auto_preview\": false,\n  \"auto_stop\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "timezone": "UTC",
  "start_time": "1970-01-01T08:00:00.000Z",
  "stop_time": "1970-01-01T19:00:00.000Z",
  "weekdays": [
    "MONDAY"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "on_demand_preview": false,
  "auto_preview": false,
  "auto_stop": false
}

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

deploymentRuleId
string<uuid>
required

Deployment Rule ID

Body

application/json
timezone
string
required
Example:

"UTC"

start_time
string<date-time>
required
Example:

"1970-01-01T08:00:00.000Z"

stop_time
string<date-time>
required
Example:

"1970-01-01T19:00:00.000Z"

weekdays
enum<string>[]
required
Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
on_demand_preview
boolean
default:false
auto_preview
boolean
default:false
auto_stop
boolean
default:false

Response

Edit environment deployment rule

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
timezone
string
required
Example:

"UTC"

start_time
string<date-time>
required
Example:

"1970-01-01T08:00:00.000Z"

stop_time
string<date-time>
required
Example:

"1970-01-01T19:00:00.000Z"

weekdays
enum<string>[]
required
Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
updated_at
string<date-time>
read-only
on_demand_preview
boolean
default:false
auto_preview
boolean
default:false
auto_stop
boolean
default:false