POST
/
api
/
monitors
/
automated
/
v1
/
deployment-rules
curl --request POST \
  --url https://developer.synq.io/api/monitors/automated/v1/deployment-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deploymentRule": {
    "id": "<string>",
    "title": "<string>",
    "queryConfig": {
      "query": {
        "parts": [
          {
            "identifierList": {
              "identifiers": [
                {
                  "dbtCoreNode": {
                    "integrationId": "<string>",
                    "nodeId": "<string>"
                  },
                  "dbtCloudNode": {
                    "projectId": "<string>",
                    "accountId": "<string>",
                    "nodeId": "<string>"
                  },
                  "bigqueryTable": {
                    "project": "<string>",
                    "dataset": "<string>",
                    "table": "<string>"
                  },
                  "snowflakeTable": {
                    "account": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "redshiftTable": {
                    "cluster": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "postgresTable": {
                    "host": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "mysqlTable": {
                    "host": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "clickhouseTable": {
                    "host": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "airflowDag": {
                    "integrationId": "<string>",
                    "dagId": "<string>"
                  },
                  "airflowTask": {
                    "integrationId": "<string>",
                    "dagId": "<string>",
                    "taskId": "<string>"
                  },
                  "custom": {
                    "id": "<string>"
                  },
                  "dataproduct": {
                    "id": "<string>"
                  },
                  "synqPath": {
                    "path": "<string>"
                  },
                  "databricksTable": {
                    "workspace": "<string>",
                    "catalog": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "trinoTable": {
                    "host": "<string>",
                    "catalog": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "sqlMeshModel": {
                    "integrationId": "<string>",
                    "fqn": "<string>"
                  },
                  "sqlMeshAudit": {
                    "integrationId": "<string>",
                    "fqn": "<string>",
                    "auditId": "<string>"
                  },
                  "monitor": {
                    "monitoredId": {},
                    "monitorId": "<string>",
                    "segment": "<string>",
                    "integrationId": "<string>"
                  }
                }
              ]
            },
            "withNameSearch": {
              "searchQuery": "<string>"
            },
            "withType": {
              "type": {
                "default": 123,
                "custom": 123
              },
              "types": [
                {
                  "default": 123,
                  "custom": 123
                }
              ]
            },
            "withAnnotation": {
              "name": "<string>",
              "acceptedValue": "<string>",
              "acceptedValues": [
                "<string>"
              ]
            },
            "inFolder": {
              "path": [
                "<string>"
              ]
            },
            "query": {},
            "unsupported": {
              "queryJson": "<string>"
            }
          }
        ],
        "operand": 123
      },
      "severity": 123,
      "sensitivity": 123,
      "metricIds": [
        123
      ],
      "keepDeletedMonitors": true
    },
    "exclusiveQueryConfig": {
      "query": {
        "parts": [
          {
            "identifierList": {
              "identifiers": [
                {
                  "dbtCoreNode": {
                    "integrationId": "<string>",
                    "nodeId": "<string>"
                  },
                  "dbtCloudNode": {
                    "projectId": "<string>",
                    "accountId": "<string>",
                    "nodeId": "<string>"
                  },
                  "bigqueryTable": {
                    "project": "<string>",
                    "dataset": "<string>",
                    "table": "<string>"
                  },
                  "snowflakeTable": {
                    "account": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "redshiftTable": {
                    "cluster": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "postgresTable": {
                    "host": "<string>",
                    "database": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "mysqlTable": {
                    "host": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "clickhouseTable": {
                    "host": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "airflowDag": {
                    "integrationId": "<string>",
                    "dagId": "<string>"
                  },
                  "airflowTask": {
                    "integrationId": "<string>",
                    "dagId": "<string>",
                    "taskId": "<string>"
                  },
                  "custom": {
                    "id": "<string>"
                  },
                  "dataproduct": {
                    "id": "<string>"
                  },
                  "synqPath": {
                    "path": "<string>"
                  },
                  "databricksTable": {
                    "workspace": "<string>",
                    "catalog": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "trinoTable": {
                    "host": "<string>",
                    "catalog": "<string>",
                    "schema": "<string>",
                    "table": "<string>"
                  },
                  "sqlMeshModel": {
                    "integrationId": "<string>",
                    "fqn": "<string>"
                  },
                  "sqlMeshAudit": {
                    "integrationId": "<string>",
                    "fqn": "<string>",
                    "auditId": "<string>"
                  },
                  "monitor": {
                    "monitoredId": {},
                    "monitorId": "<string>",
                    "segment": "<string>",
                    "integrationId": "<string>"
                  }
                }
              ]
            },
            "withNameSearch": {
              "searchQuery": "<string>"
            },
            "withType": {
              "type": {
                "default": 123,
                "custom": 123
              },
              "types": [
                {
                  "default": 123,
                  "custom": 123
                }
              ]
            },
            "withAnnotation": {
              "name": "<string>",
              "acceptedValue": "<string>",
              "acceptedValues": [
                "<string>"
              ]
            },
            "inFolder": {
              "path": [
                "<string>"
              ]
            },
            "query": {},
            "unsupported": {
              "queryJson": "<string>"
            }
          }
        ],
        "operand": 123
      }
    },
    "staticConfig": {
      "path": "<string>",
      "severity": 123,
      "sensitivity": 123,
      "metricIds": [
        123
      ]
    },
    "exclusiveStaticConfig": {
      "path": "<string>"
    },
    "productConfig": {
      "productId": "<string>",
      "severity": 123,
      "sensitivity": 123,
      "metricIds": [
        123
      ],
      "upstream": {
        "all": {},
        "sources": {}
      },
      "self": {
        "all": {},
        "selection": {
          "query": {
            "parts": [
              {
                "identifierList": {
                  "identifiers": [
                    {
                      "dbtCoreNode": {
                        "integrationId": "<string>",
                        "nodeId": "<string>"
                      },
                      "dbtCloudNode": {
                        "projectId": "<string>",
                        "accountId": "<string>",
                        "nodeId": "<string>"
                      },
                      "bigqueryTable": {
                        "project": "<string>",
                        "dataset": "<string>",
                        "table": "<string>"
                      },
                      "snowflakeTable": {
                        "account": "<string>",
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "redshiftTable": {
                        "cluster": "<string>",
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "postgresTable": {
                        "host": "<string>",
                        "database": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "mysqlTable": {
                        "host": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "clickhouseTable": {
                        "host": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "airflowDag": {
                        "integrationId": "<string>",
                        "dagId": "<string>"
                      },
                      "airflowTask": {
                        "integrationId": "<string>",
                        "dagId": "<string>",
                        "taskId": "<string>"
                      },
                      "custom": {
                        "id": "<string>"
                      },
                      "dataproduct": {
                        "id": "<string>"
                      },
                      "synqPath": {
                        "path": "<string>"
                      },
                      "databricksTable": {
                        "workspace": "<string>",
                        "catalog": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "trinoTable": {
                        "host": "<string>",
                        "catalog": "<string>",
                        "schema": "<string>",
                        "table": "<string>"
                      },
                      "sqlMeshModel": {
                        "integrationId": "<string>",
                        "fqn": "<string>"
                      },
                      "sqlMeshAudit": {
                        "integrationId": "<string>",
                        "fqn": "<string>",
                        "auditId": "<string>"
                      },
                      "monitor": {
                        "monitoredId": {},
                        "monitorId": "<string>",
                        "segment": "<string>",
                        "integrationId": "<string>"
                      }
                    }
                  ]
                },
                "withNameSearch": {
                  "searchQuery": "<string>"
                },
                "withType": {
                  "type": {
                    "default": 123,
                    "custom": 123
                  },
                  "types": [
                    {
                      "default": 123,
                      "custom": 123
                    }
                  ]
                },
                "withAnnotation": {
                  "name": "<string>",
                  "acceptedValue": "<string>",
                  "acceptedValues": [
                    "<string>"
                  ]
                },
                "inFolder": {
                  "path": [
                    "<string>"
                  ]
                },
                "query": {},
                "unsupported": {
                  "queryJson": "<string>"
                }
              }
            ],
            "operand": 123
          }
        }
      },
      "keepDeletedMonitors": true
    }
  }
}'
{}

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200
application/json

OK

The response is of type object.