Skip to main content
GET
/
api
/
monitors
/
automated
/
v1
/
deployment-rules
ListDeploymentRules
curl --request GET \
  --url https://developer.synq.io/api/monitors/automated/v1/deployment-rules \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://developer.synq.io/api/monitors/automated/v1/deployment-rules"

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

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

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

fetch('https://developer.synq.io/api/monitors/automated/v1/deployment-rules', 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://developer.synq.io/api/monitors/automated/v1/deployment-rules",
  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://developer.synq.io/api/monitors/automated/v1/deployment-rules"

	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://developer.synq.io/api/monitors/automated/v1/deployment-rules")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/monitors/automated/v1/deployment-rules")

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
{
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  },
  "deploymentRules": [
    {
      "exclusiveQueryConfig": {
        "query": {
          "parts": [
            {
              "identifierList": {
                "identifiers": [
                  {
                    "airflowDag": {
                      "integrationId": "<string>",
                      "dagId": "<string>"
                    }
                  }
                ]
              }
            }
          ]
        },
        "resolverQl": "<string>",
        "renderedResolverQl": "<string>"
      },
      "id": "<string>",
      "title": "<string>",
      "monitorCount": 123,
      "configId": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
sources
enum<string>[]
Available options:
SOURCE_APP,
SOURCE_API
​
configIds
string[]
deprecated
​
configsFilter.ids
string[]
​
ruleIds
string[]
​
ruleTypes
enum<string>[]

Filter by rule type. When empty, rules of every type are returned. When set, only rules whose type is listed are returned (e.g. pass [DEPLOYMENT_RULE_TYPE_QUERY, DEPLOYMENT_RULE_TYPE_PRODUCT] to exclude single-path rules). The filter is applied server-side before paging, so every page reflects only the selected types.

DeploymentRuleType identifies which kind of selection a deployment rule uses. The value corresponds to the populated config oneof arm on MonitorsDeploymentRule / MonitorsDeploymentRuleView. Use it with ListDeploymentRulesRequest.rule_types to return only rules of selected kinds.

Available options:
DEPLOYMENT_RULE_TYPE_UNSPECIFIED,
DEPLOYMENT_RULE_TYPE_QUERY,
DEPLOYMENT_RULE_TYPE_EXCLUSIVE_QUERY,
DEPLOYMENT_RULE_TYPE_STATIC_PATH,
DEPLOYMENT_RULE_TYPE_EXCLUSIVE_STATIC_PATH,
DEPLOYMENT_RULE_TYPE_PRODUCT
​
pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

​
pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

​
pageInfo
PageInfo · object
required

Paging information for this response. Always populated. This response carries at most one bounded page of rules, never the full set. The cursor is the paging contract: to retrieve every rule, repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty. page_info.count is the number of rules in this page. page_info.total_count is a best-effort total for the same filter, but it is deprecated — do not drive paging off it; loop on last_id instead.

​
deploymentRules
MonitorsDeploymentRuleView · object[]