Get Started
Monitors
Incidents
Analytics
Data Warehouse Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Security
Support
Developer API
- Getting Started
- REST API
- ChangesService
- CodeService
- DatabaseCoordinatesService
- SqlTestsService
- TestSuggestionsService
- DwhService
- EntitiesService
- EntityExecutionsService
- AtlanIntegrationService
- AtlanProviderService
- AtlanWorkflowService
- CommitsService
- ImpactService
- IncidentsService
- IssuesService
- LineageService
- DeploymentRulesService
- GETGet apimonitorsautomatedv1deployment rule
- DELDelete apimonitorsautomatedv1deployment rule
- GETGet apimonitorsautomatedv1deployment rule deleted
- GETGet apimonitorsautomatedv1deployment rules
- POSTPost apimonitorsautomatedv1deployment rules
- PATCHPatch apimonitorsautomatedv1deployment rules
- GETGet apimonitorsautomatedv1deployment rulesbatch
- POSTPost apimonitorsautomatedv1deployment rulesdeployed
- GETGet apimonitorsautomatedv1deployment rules 1
- GET
- HistoryService
- MonitorInfoService
- PlatformsService
- SchemasService
- EntityIncidentsService
- EntityIssuesService
- TriageService
- gRPC API
- Webhooks
DeploymentRulesService
Post apimonitorsautomatedv1deployment rules
POST
/
api
/
monitors
/
automated
/
v1
/
deployment-rules
Copy
Ask AI
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
}
}
}'
Copy
Ask AI
{}
Authorizations
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
.
Copy
Ask AI
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
}
}
}'
Copy
Ask AI
{}
Assistant
Responses are generated using AI and may contain mistakes.