> ## Documentation Index > Fetch the complete documentation index at: https://docs.synq.io/llms.txt > Use this file to discover all available pages before exploring further. # GetDeployOverview ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/monitors/automated/v1/deployment-rule openapi: 3.1.0 info: version: '1.0' title: SYNQ servers: - url: https://developer.synq.io - url: https://api.us.synq.io security: - bearerAuth: [] tags: - name: synq.issues.issues.v1.IssuesService description: IssuesService is a service for managing Issues. - name: synq.issues.v2.IssuesService description: IssuesService is a service for managing Issues. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. - name: synq.alerts.services.v1.AlertsService description: AlertsService provides operations for managing alert configurations. - name: synq.agent.recon.v1.YamlService description: >- YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML. - name: synq.agent.recon.v1.SuiteDeploymentService description: |- SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace's behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn. - name: synq.agent.sre.v1.TriageService description: >- Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process. - name: synq.agent.sre.v1.LlmService description: Service for evaluating LLM requests and producing structured output. - name: synq.agent.sre.v1.FeatureRequestService description: >- FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user's request. - name: synq.integrations.v1.IntegrationsService description: |- IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque `etag`. Read it from `GetIntegration` / `ListIntegrations`, then pass it back on `UpdateIntegration` / `DeleteIntegration` to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is `optional`). - name: synq.auth.iam.v1.IamService - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.monitors.history.v1.HistoryService - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - name: synq.entities.executions.v2.EntityExecutionsService description: >- EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases: - Retrieve execution history for specific entities - Filter executions by time range, status, or execution type - Get aggregated summaries of execution activity - Track execution trends and patterns - name: synq.datachecks.sqltests.v1.SqlTestsService description: SqlTestsService is a service for managing SqlTests. - name: synq.datachecks.v1.TriggerService description: TriggerService provides synchronous execution of datachecks on entities. - name: synq.datachecks.testsuggestions.v1.TestSuggestionsService - name: synq.extensions.atlan.provider.v1.AtlanProviderService - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - name: synq.savedviews.v1.SavedViewsService description: >- SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace. - name: synq.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - name: synq.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.entities.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.status.v1.EntityIncidentsService description: EntityIncidentsService is the service which retrieves entity status. - name: synq.entities.status.v1.EntityIssuesService description: EntityIssuesService is the service which retrieves entity issues status. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies. - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.entities.checks.v1.ChecksCategoriesService description: |- ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace's categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload. - name: synq.entities.sql_insights.v1.SqlInsightsService description: >- SqlInsightsService exposes analytical information about the SQL used across a workspace's entities. It answers questions such as "which SQL constructs are used in my warehouse, and how often" and "what SQL constructs does this specific entity use", without requiring the caller to re-parse any SQL. - name: synq.entities.custom.v1.RelationshipsService description: >- RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.). - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.GroupsService description: >- It eliminates the need to keep state on client side to remember which assets were already created and which should be deleted. The server will keep track of the current state of the group and client can always send the intended new state. The server will calculate the diff and entities that are no longer present in the group will be removed. Example: 1. group has entities A, B, C at time t1 2. client sends group with entities B, C, D at time t2 3. server will remove entity A from the system and update the current state of the group to B, C, D The service is designed to be idempotent and can be called multiple times with the same state without causing any side effects. - name: synq.entities.custom.v1.EntityExecutionsService - name: synq.entities.custom.v1.EntitiesService description: >- custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted. - name: synq.entities.custom.v1.FeaturesService - name: synq.entities.impact.v1.ImpactService - name: synq.entities.schemas.v1.SchemaMismatchesService description: >- SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models). - name: synq.entities.schemas.v1.SchemasService description: EntitiesService is a service for retriving any entity. - name: synq.entities.constraints.v1.TableConstraintsService description: >- TableConstraintsService provides access to table constraint and index information. - name: synq.entities.changes.v1.ChangesService description: >- ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity: - Git commits: Changes to code files (dbt models, SQL files) tracked in version control - Schema changes: Database schema modifications (columns added/removed/changed) - SQL definition changes: View/materialized view definition updates detected by Coalesce Quality Changes are returned with structured metadata including: - For git commits: structured statistics (directories, file types, top changes) - For schema changes: detailed column-level diffs - For SQL changes: before/after SQL definitions Use cases: - "What changed in the last week for table X?" → Returns git commits, schema changes, SQL changes - "Show me all commits affecting this dbt model" → Returns git commits with lineage context - "What schema changes happened to this table?" → Returns schema changes detected by Coalesce Quality - name: synq.entities.lineage.v1.LineageService description: |- LineageService allows you to fetch: * Entity level lineage from a starting point of one or more entities. * Column Level lineage from a starting point of multiple columns of a single entity. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.annotations.v1.AnnotationsService description: >- AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering. - name: synq.entities.code.v1.CodeService description: >- CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.openlineage.v1.OpenlineageService - name: synq.ingest.dwh.v1.DwhService - name: synq.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - name: synq.git.commits.v1.CommitsService paths: /api/monitors/automated/v1/deployment-rule: get: tags: - synq.monitors.automated_monitors.v1.DeploymentRulesService summary: GetDeployOverview operationId: >- synq.monitors.automated_monitors.v1.DeploymentRulesService.GetDeployOverview parameters: - name: deploymentRule.id in: query schema: type: string title: id format: uuid - name: deploymentRule.title in: query schema: type: string title: title maxLength: 100 minLength: 1 - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.projectId in: query description: Your dbt Cloud project id required: true schema: type: string title: project_id description: Your dbt Cloud project id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.accountId in: query description: Your dbt Cloud account id schema: type: string title: account_id description: Your dbt Cloud account id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.project in: query description: BigQuery project required: true schema: type: string title: project description: BigQuery project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.dataset in: query description: BigQuery dataset id required: true schema: type: string title: dataset description: BigQuery dataset id - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.table in: query description: BigQuery table name required: true schema: type: string title: table description: BigQuery table name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.account in: query description: Snowflake account required: true schema: type: string title: account description: Snowflake account - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.database in: query description: Snowflake database required: true schema: type: string title: database description: Snowflake database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.schema in: query description: Snowflake schema required: true schema: type: string title: schema description: Snowflake schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.table in: query description: Snowflake table required: true schema: type: string title: table description: Snowflake table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.cluster in: query description: Redshift cluster schema: type: string title: cluster description: Redshift cluster - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.database in: query description: Redshift database required: true schema: type: string title: database description: Redshift database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.schema in: query description: Redshift schema required: true schema: type: string title: schema description: Redshift schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.table in: query description: Redshift table required: true schema: type: string title: table description: Redshift table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.host in: query description: Postgres hostname without port required: true schema: type: string title: host description: Postgres hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.database in: query description: Postgres database required: true schema: type: string title: database description: Postgres database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.schema in: query description: Postgres schema required: true schema: type: string title: schema description: Postgres schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.table in: query description: Postgres table required: true schema: type: string title: table description: Postgres table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.host in: query description: Mysql hostname without port required: true schema: type: string title: host description: Mysql hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.schema in: query description: Mysql database required: true schema: type: string title: schema description: Mysql database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.table in: query description: Mysql table required: true schema: type: string title: table description: Mysql table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.host in: query description: Clickhouse hostname without port required: true schema: type: string title: host description: Clickhouse hostname without port - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.schema in: query description: Clickhouse database required: true schema: type: string title: schema description: Clickhouse database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.table in: query description: Clickhouse table required: true schema: type: string title: table description: Clickhouse table - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.taskId in: query description: Airflow task_id that identifies the task within the DAG required: true schema: type: string title: task_id description: Airflow task_id that identifies the task within the DAG - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.custom.id in: query description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. required: true schema: type: string title: id description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.dataproduct.id in: query description: Dataproduct id that identifies the Dataproduct required: true schema: type: string title: id format: uuid description: Dataproduct id that identifies the Dataproduct - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.synqPath.path in: query description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths required: true schema: type: string title: path description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.workspace in: query description: URL of Databricks workspace required: true schema: type: string title: workspace description: URL of Databricks workspace - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.catalog in: query description: Databricks catalog required: true schema: type: string title: catalog description: Databricks catalog - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.schema in: query description: Databricks schema required: true schema: type: string title: schema description: Databricks schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.table in: query description: Databricks table or view required: true schema: type: string title: table description: Databricks table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.host in: query description: Hostname of the Trino instance required: true schema: type: string title: host description: Hostname of the Trino instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.catalog in: query description: Trino catalog required: true schema: type: string title: catalog description: Trino catalog - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.schema in: query description: Trino schema required: true schema: type: string title: schema description: Trino schema - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.table in: query description: Trino table or view required: true schema: type: string title: table description: Trino table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.auditId in: query description: Identifier of the audit required: true schema: type: string title: audit_id description: Identifier of the audit - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.host in: query description: Hostname of the SQL Server instance required: true schema: type: string title: host description: Hostname of the SQL Server instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.database in: query description: SQL Server database required: true schema: type: string title: database description: SQL Server database - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.schema in: query description: SQL Server schema (e.g. "dbo") required: true schema: type: string title: schema description: SQL Server schema (e.g. "dbo") - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.table in: query description: SQL Server table or view required: true schema: type: string title: table description: SQL Server table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.host in: query description: Hostname of the Oracle instance required: true schema: type: string title: host description: Hostname of the Oracle instance - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.serviceName in: query description: Oracle service name (PDB) required: true schema: type: string title: service_name description: Oracle service name (PDB) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.schema in: query description: Oracle schema (= owning user) required: true schema: type: string title: schema description: Oracle schema (= owning user) - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.table in: query description: Oracle table or view required: true schema: type: string title: table description: Oracle table or view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.instance in: query description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. required: true schema: type: string title: instance description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.catalog in: query description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. required: true schema: type: string title: catalog description: >- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.database in: query description: Glue database (the namespace users typically filter on). required: true schema: type: string title: database description: Glue database (the namespace users typically filter on). - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.table in: query description: Glue table or view name. required: true schema: type: string title: table description: Glue table or view name. - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.savedView.id in: query description: Saved view id (client-supplied UUID) that identifies the saved view required: true schema: type: string title: id format: uuid description: >- Saved view id (client-supplied UUID) that identifies the saved view - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitorId in: query description: Identifier of the monitor required: true schema: type: string title: monitor_id description: Identifier of the monitor - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.segment in: query description: Optional monitor segmentation identifier schema: type: string title: segment description: Optional monitor segmentation identifier - name: >- deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.integrationId in: query description: Coalesce Quality integration_id of the monitored identifier schema: type: string title: integration_id description: Coalesce Quality integration_id of the monitored identifier deprecated: true - name: deploymentRule.queryConfig.query.parts.withNameSearch.searchQuery in: query schema: type: string title: search_query - name: deploymentRule.queryConfig.query.parts.withType.type.default in: query description: Default Coalesce Quality types schema: $ref: '#/components/schemas/synq.entities.v1.EntityType' title: default description: Default Coalesce Quality types - name: deploymentRule.queryConfig.query.parts.withType.type.custom in: query description: Custom types as defined through synq.entities.custom.v1.TypesService schema: type: integer title: custom format: int32 description: >- Custom types as defined through synq.entities.custom.v1.TypesService - name: deploymentRule.queryConfig.query.parts.withAnnotation.name in: query schema: type: string title: name - name: deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValue in: query schema: type: string title: accepted_value deprecated: true - name: deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValues in: query schema: type: array items: type: string title: accepted_values - name: deploymentRule.queryConfig.query.parts.inFolder.path in: query schema: type: array items: type: string title: path - name: deploymentRule.queryConfig.query.parts.query.operand in: query schema: $ref: '#/components/schemas/synq.queries.v1.QueryOperand' title: operand - name: deploymentRule.queryConfig.query.parts.unsupported.queryJson in: query schema: type: string title: query_json - name: deploymentRule.queryConfig.severity in: query schema: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Severity' not: enum: - 0 title: severity - name: deploymentRule.queryConfig.sensitivity in: query schema: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity not: enum: - 0 title: sensitivity - name: deploymentRule.queryConfig.metricIds in: query schema: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MetricId title: metric_ids minItems: 1 uniqueItems: true - name: deploymentRule.queryConfig.keepDeletedMonitors in: query schema: type: boolean title: keep_deleted_monitors - name: deploymentRule.queryConfig.metricOptions.sensitivity in: query schema: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity not: enum: - 0 title: sensitivity - name: deploymentRule.queryConfig.metricOptions.metricId in: query schema: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.MetricId' not: enum: - 0 title: metric_id - name: deploymentRule.queryConfig.resolverQl in: query description: >- ResolverQL selection string — an advanced, more expressive alternative to `query`. ResolverQL is a superset of the structured `query`: use it for selections `query` cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, `resolver_ql` is the source of truth and the structured `query` is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured `query` — so writing a read response back unchanged preserves the rule's authored form (a structured rule stays structured rather than being silently rewritten to ResolverQL). To read the ResolverQL form of a structured rule, use `rendered_resolver_ql`. `query` is always populated regardless. schema: type: string title: resolver_ql description: >- ResolverQL selection string — an advanced, more expressive alternative to `query`. ResolverQL is a superset of the structured `query`: use it for selections `query` cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, `resolver_ql` is the source of truth and the structured `query` is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured `query` — so writing a read response back unchanged preserves the rule's authored form (a structured rule stays structured rather than being silently rewritten to ResolverQL). To read the ResolverQL form of a structured rule, use `rendered_resolver_ql`. `query` is always populated regardless. - name: deploymentRule.queryConfig.renderedResolverQl in: query description: >- Canonical ResolverQL rendering of this rule's selection, populated for every query rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL. Use it to read the ResolverQL form of a rule authored via the structured `query`; for ResolverQL-authored rules it equals `resolver_ql`. Empty only for selections that have no ResolverQL representation. schema: type: string title: rendered_resolver_ql description: >- Canonical ResolverQL rendering of this rule's selection, populated for every query rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL. Use it to read the ResolverQL form of a rule authored via the structured `query`; for ResolverQL-authored rules it equals `resolver_ql`. Empty only for selections that have no ResolverQL representation. - name: deploymentRule.exclusiveQueryConfig.resolverQl in: query description: |- ResolverQL selection string for the exclusion set. Same semantics as QueryConfig.resolver_ql: when set on write it takes precedence over `query`; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-`query` rules (whose ResolverQL form is in `rendered_resolver_ql`). `query` is always populated. schema: type: string title: resolver_ql description: >- ResolverQL selection string for the exclusion set. Same semantics as QueryConfig.resolver_ql: when set on write it takes precedence over `query`; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-`query` rules (whose ResolverQL form is in `rendered_resolver_ql`). `query` is always populated. - name: deploymentRule.exclusiveQueryConfig.renderedResolverQl in: query description: >- Canonical ResolverQL rendering of the exclusion selection. Same semantics as QueryConfig.rendered_resolver_ql: OUTPUT ONLY, populated for every rule, ignored on write. schema: type: string title: rendered_resolver_ql description: >- Canonical ResolverQL rendering of the exclusion selection. Same semantics as QueryConfig.rendered_resolver_ql: OUTPUT ONLY, populated for every rule, ignored on write. - name: deploymentRule.staticConfig.path in: query schema: type: string title: path - name: deploymentRule.staticConfig.severity in: query schema: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Severity' not: enum: - 0 title: severity - name: deploymentRule.staticConfig.sensitivity in: query schema: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity not: enum: - 0 title: sensitivity - name: deploymentRule.staticConfig.metricIds in: query schema: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MetricId title: metric_ids minItems: 1 uniqueItems: true - name: deploymentRule.exclusiveStaticConfig.path in: query schema: type: string title: path - name: deploymentRule.productConfig.productId in: query schema: type: string title: product_id - name: deploymentRule.productConfig.severity in: query schema: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Severity' not: enum: - 0 title: severity - name: deploymentRule.productConfig.sensitivity in: query schema: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity not: enum: - 0 title: sensitivity - name: deploymentRule.productConfig.metricIds in: query schema: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MetricId title: metric_ids minItems: 1 uniqueItems: true - name: deploymentRule.productConfig.keepDeletedMonitors in: query schema: type: boolean title: keep_deleted_monitors - name: deploymentRule.source in: query schema: $ref: '#/components/schemas/synq.v1.Source' title: source - name: deploymentRule.configId in: query schema: type: string title: config_id responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.GetDeployOverviewResponse components: schemas: synq.entities.v1.EntityType: type: string title: EntityType enum: - ENTITY_TYPE_UNSPECIFIED - ENTITY_TYPE_BQ_TABLE - ENTITY_TYPE_BQ_VIEW - ENTITY_TYPE_LOOKER_LOOK - ENTITY_TYPE_LOOKER_EXPLORE - ENTITY_TYPE_LOOKER_VIEW - ENTITY_TYPE_LOOKER_DASHBOARD - ENTITY_TYPE_DBT_MODEL - ENTITY_TYPE_DBT_TEST - ENTITY_TYPE_DBT_SOURCE - ENTITY_TYPE_DBT_PROJECT - ENTITY_TYPE_DBT_METRIC - ENTITY_TYPE_DBT_SNAPSHOT - ENTITY_TYPE_DBT_SEED - ENTITY_TYPE_DBT_ANALYSIS - ENTITY_TYPE_DBT_EXPOSURE - ENTITY_TYPE_DBT_GROUP - ENTITY_TYPE_DBT_SEMANTIC_MODEL - ENTITY_TYPE_DBT_CLOUD_PROJECT - ENTITY_TYPE_DBT_CLOUD_JOB - ENTITY_TYPE_SNOWFLAKE_TABLE - ENTITY_TYPE_SNOWFLAKE_VIEW - ENTITY_TYPE_SNOWFLAKE_STREAM - ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE - ENTITY_TYPE_SNOWFLAKE_TASK - ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE - ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW - ENTITY_TYPE_SNOWFLAKE_PROCEDURE - ENTITY_TYPE_SNOWFLAKE_FUNCTION - ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW - ENTITY_TYPE_REDSHIFT_TABLE - ENTITY_TYPE_REDSHIFT_VIEW - ENTITY_TYPE_REDSHIFT_PROCEDURE - ENTITY_TYPE_REDSHIFT_FUNCTION - ENTITY_TYPE_TABLEAU_EMBEDDED - ENTITY_TYPE_TABLEAU_PUBLISHED - ENTITY_TYPE_TABLEAU_CUSTOM_SQL - ENTITY_TYPE_TABLEAU_TABLE - ENTITY_TYPE_TABLEAU_SHEET - ENTITY_TYPE_TABLEAU_DASHBOARD - ENTITY_TYPE_AIRFLOW_DAG - ENTITY_TYPE_AIRFLOW_TASK - ENTITY_TYPE_CLICKHOUSE_TABLE - ENTITY_TYPE_CLICKHOUSE_VIEW - ENTITY_TYPE_ANOMALY_MONITOR - ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT - ENTITY_TYPE_SQLTEST_TEST - ENTITY_TYPE_RECON_SUITE - ENTITY_TYPE_RECON_CASE - ENTITY_TYPE_POSTGRES_TABLE - ENTITY_TYPE_POSTGRES_VIEW - ENTITY_TYPE_MYSQL_TABLE - ENTITY_TYPE_MYSQL_VIEW - ENTITY_TYPE_DATABRICKS_WAREHOUSE - ENTITY_TYPE_DATABRICKS_TABLE - ENTITY_TYPE_DATABRICKS_VIEW - ENTITY_TYPE_DATABRICKS_JOB - ENTITY_TYPE_DATABRICKS_JOB_TASK - ENTITY_TYPE_DATABRICKS_NOTEBOOK - ENTITY_TYPE_DATABRICKS_QUERY - ENTITY_TYPE_DATABRICKS_DASHBOARD - ENTITY_TYPE_SQLMESH_PROJECT - ENTITY_TYPE_SQLMESH_SQL_MODEL - ENTITY_TYPE_SQLMESH_PYTHON_MODEL - ENTITY_TYPE_SQLMESH_EXTERNAL - ENTITY_TYPE_SQLMESH_SEED - ENTITY_TYPE_SQLMESH_AUDIT - ENTITY_TYPE_SQLMESH_UNIT_TEST - ENTITY_TYPE_SQLMESH_ENVIRONMENT - ENTITY_TYPE_SQLMESH_SNAPSHOT - ENTITY_TYPE_DUCKDB_TABLE - ENTITY_TYPE_DUCKDB_VIEW - ENTITY_TYPE_TRINO_TABLE - ENTITY_TYPE_TRINO_VIEW - ENTITY_TYPE_ATLAN_ASSET - ENTITY_TYPE_ATLAN_INTEGRATION - ENTITY_TYPE_COALESCE_PROJECT - ENTITY_TYPE_COALESCE_ENVIRONMENT - ENTITY_TYPE_COALESCE_NODE - ENTITY_TYPE_COALESCE_NODE_TEST - ENTITY_TYPE_COALESCE_JOB - ENTITY_TYPE_CASTORDOC_TABLE - ENTITY_TYPE_CASTORDOC_DASHBOARD - ENTITY_TYPE_CASTORDOC_VIEW - ENTITY_TYPE_CASTORDOC_TILE - ENTITY_TYPE_CASTORDOC_VIZ_MODEL - ENTITY_TYPE_POWERBI_REPORT - ENTITY_TYPE_POWERBI_TILE - ENTITY_TYPE_POWERBI_DATASET - ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD - ENTITY_TYPE_THOUGHTSPOT_WORKSHEET - ENTITY_TYPE_SIGMA_WORKBOOK - ENTITY_TYPE_SIGMA_DATA_MODEL - ENTITY_TYPE_DOMO_PAGE - ENTITY_TYPE_DOMO_DATASET - ENTITY_TYPE_MSSQL_TABLE - ENTITY_TYPE_MSSQL_VIEW - ENTITY_TYPE_ORACLE_TABLE - ENTITY_TYPE_ORACLE_VIEW - ENTITY_TYPE_ATHENA_TABLE - ENTITY_TYPE_ATHENA_VIEW - ENTITY_TYPE_CUSTOM_ENTITY_GENERIC - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX synq.queries.v1.QueryOperand: type: string title: QueryOperand enum: - QUERY_OPERAND_UNSPECIFIED - QUERY_OPERAND_AND - QUERY_OPERAND_OR - QUERY_OPERAND_EXCEPT - QUERY_OPERAND_UPSTREAM - QUERY_OPERAND_DOWNSTREAM description: >- QueryOperand defines how multiple QueryParts within a Query are combined. synq.monitors.automated_monitors.v1.Severity: type: string title: Severity enum: - SEVERITY_UNSPECIFIED - SEVERITY_WARNING - SEVERITY_ERROR - SEVERITY_INFO synq.monitors.automated_monitors.v1.Sensitivity: type: string title: Sensitivity enum: - SENSITIVITY_UNSPECIFIED - SENSITIVITY_PRECISE - SENSITIVITY_BALANCED - SENSITIVITY_RELAXED synq.monitors.automated_monitors.v1.MetricId: type: string title: MetricId enum: - METRIC_ID_UNSPECIFIED - METRIC_ID_ROW_COUNT - METRIC_ID_DELAY - METRIC_ID_VOLUME_CHANGE_DELAY synq.v1.Source: type: string title: Source enum: - SOURCE_APP - SOURCE_API synq.monitors.automated_monitors.v1.GetDeployOverviewResponse: type: object properties: overview: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MonitorsDeploymentOverview title: GetDeployOverviewResponse additionalProperties: false synq.monitors.automated_monitors.v1.MonitorsDeploymentOverview: type: object properties: monitorsToCreateFor: type: array items: type: string monitorsToDeleteFor: type: array items: type: string activeMonitorsFor: type: array items: type: string monitorSettingsChanges: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MonitorSettingsChange customMonitorsToCreateFor: type: array items: type: string customMonitorsToDeleteFor: type: array items: type: string activeCustomMonitorsFor: type: array items: type: string customMonitorSettingsChanges: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.CustomMonitorSettingsChange skippedAssets: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.SkippedAsset title: MonitorsDeploymentOverview additionalProperties: false synq.monitors.automated_monitors.v1.MonitorSettingsChange: type: object properties: monitoredAssetPath: type: string originalSettings: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.AutomatedMonitorSettings newSettings: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.AutomatedMonitorSettings title: MonitorSettingsChange additionalProperties: false synq.monitors.automated_monitors.v1.CustomMonitorSettingsChange: type: object properties: monitoredAssetPath: type: string originalSettings: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.AutomatedMonitorSettings newSettings: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.AutomatedMonitorSettings resolvedFreshnessField: type: string nullable: true title: CustomMonitorSettingsChange additionalProperties: false synq.monitors.automated_monitors.v1.SkippedAsset: type: object properties: assetPath: type: string reason: type: string title: SkippedAsset additionalProperties: false synq.monitors.automated_monitors.v1.AutomatedMonitorSettings: type: object properties: severity: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Severity' sensitivity: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity' description: LEGACY - global sensitivity metricIds: type: array items: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.MetricId' description: LEGACY - which metrics to monitor metricOptions: type: array items: $ref: >- #/components/schemas/synq.monitors.automated_monitors.v1.MetricOption description: NEW - per-metric sensitivity title: AutomatedMonitorSettings additionalProperties: false synq.monitors.automated_monitors.v1.MetricOption: type: object properties: sensitivity: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.Sensitivity' not: enum: - 0 metricId: $ref: '#/components/schemas/synq.monitors.automated_monitors.v1.MetricId' not: enum: - 0 title: MetricOption additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer ````