Skip to main content
GET
/
project
/
{projectId}
/
deploymentRule
/
{deploymentRuleId}
Get a project deployment rule
curl --request GET \
  --url https://api.qovery.com/project/{projectId}/deploymentRule/{deploymentRuleId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.qovery.com/project/{projectId}/deploymentRule/{deploymentRuleId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/project/{projectId}/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/project/{projectId}/deploymentRule/{deploymentRuleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.qovery.com/project/{projectId}/deploymentRule/{deploymentRuleId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.qovery.com/project/{projectId}/deploymentRule/{deploymentRuleId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "project-rule",
  "mode": "PRODUCTION",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "UTC",
  "start_time": "1970-01-01T08:00:00.000Z",
  "stop_time": "1970-01-01T19:00:00.000Z",
  "weekdays": [
    "MONDAY"
  ],
  "wildcard": "",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "description project rule",
  "auto_stop": false,
  "priority_index": 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

projectId
string<uuid>
required

Project ID

deploymentRuleId
string<uuid>
required

Deployment Rule ID

Response

Get project deployment rule

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
name
string
required

name is case insensitive

Example:

"project-rule"

mode
enum<string>
required
Available options:
DEVELOPMENT,
PREVIEW,
PRODUCTION,
STAGING
Example:

"PRODUCTION"

cluster_id
string<uuid>
required
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
wildcard
string
default:""
required

wildcard pattern composed of '?' and/or '*' used to target new created environments

updated_at
string<date-time>
read-only
description
string | null
Example:

"description project rule"

auto_stop
boolean
default:false
priority_index
integer

used to select the first deployment rule to match new created environments