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>'
{
  "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[]