> ## 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. # SetConnectionMappings ## OpenAPI ````yaml /api-reference/openapi.yaml post /api/extensions/atlan/workflows/v1/connection-mappings 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.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/extensions/atlan/workflows/v1/connection-mappings: post: tags: - synq.extensions.atlan.workflows.v1.AtlanWorkflowService summary: SetConnectionMappings operationId: >- synq.extensions.atlan.workflows.v1.AtlanWorkflowService.SetConnectionMappings requestBody: content: application/json: schema: $ref: >- #/components/schemas/synq.extensions.atlan.workflows.v1.SetConnectionMappingsRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.extensions.atlan.workflows.v1.SetConnectionMappingsResponse components: schemas: synq.extensions.atlan.workflows.v1.SetConnectionMappingsRequest: type: object properties: mappings: type: array items: $ref: >- #/components/schemas/synq.extensions.atlan.workflows.v1.ConnectionMapping title: SetConnectionMappingsRequest additionalProperties: false synq.extensions.atlan.workflows.v1.SetConnectionMappingsResponse: type: object title: SetConnectionMappingsResponse additionalProperties: false synq.extensions.atlan.workflows.v1.ConnectionMapping: type: object properties: atlanConnectionQualifiedName: type: string synqDataPlatformIdentifier: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformIdentifier' title: ConnectionMapping additionalProperties: false synq.platforms.v1.DataPlatformIdentifier: type: object oneOf: - properties: athena: $ref: '#/components/schemas/synq.platforms.v1.AthenaIdentifier' title: athena title: athena required: - athena - properties: bigquery: $ref: '#/components/schemas/synq.platforms.v1.BigqueryIdentifier' title: bigquery title: bigquery required: - bigquery - properties: clickhouse: $ref: '#/components/schemas/synq.platforms.v1.ClickhouseIdentifier' title: clickhouse title: clickhouse required: - clickhouse - properties: databricks: $ref: '#/components/schemas/synq.platforms.v1.DatabricksIdentifier' title: databricks title: databricks required: - databricks - properties: dbtCloud: $ref: '#/components/schemas/synq.platforms.v1.DbtCloudIdentifier' title: dbt_cloud title: dbt_cloud required: - dbtCloud - properties: duckdb: $ref: '#/components/schemas/synq.platforms.v1.DuckDbIdentifier' title: duckdb title: duckdb required: - duckdb - properties: mssql: $ref: '#/components/schemas/synq.platforms.v1.MssqlIdentifier' title: mssql title: mssql required: - mssql - properties: mysql: $ref: '#/components/schemas/synq.platforms.v1.MysqlIdentifier' title: mysql title: mysql required: - mysql - properties: oracle: $ref: '#/components/schemas/synq.platforms.v1.OracleIdentifier' title: oracle title: oracle required: - oracle - properties: postgres: $ref: '#/components/schemas/synq.platforms.v1.PostgresIdentifier' title: postgres title: postgres required: - postgres - properties: redshift: $ref: '#/components/schemas/synq.platforms.v1.RedshiftIdentifier' title: redshift title: redshift required: - redshift - properties: snowflake: $ref: '#/components/schemas/synq.platforms.v1.SnowflakeIdentifier' title: snowflake title: snowflake required: - snowflake - properties: sqlMesh: $ref: '#/components/schemas/synq.platforms.v1.SqlMeshIdentifier' title: sql_mesh title: sql_mesh required: - sqlMesh - properties: synqIntegrationId: type: string title: synq_integration_id description: >- Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform. title: synq_integration_id required: - synqIntegrationId - properties: trino: $ref: '#/components/schemas/synq.platforms.v1.TrinoIdentifier' title: trino title: trino required: - trino - properties: unknown: $ref: '#/components/schemas/synq.platforms.v1.UnknownDataPlatform' title: unknown title: unknown required: - unknown additionalProperties: false description: >- DataPlatformIdentifier is a unique reference to a data platform integrated with Coalesce Quality. synq.platforms.v1.AthenaIdentifier: type: object properties: instance: type: string description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time. catalog: type: string description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. title: AthenaIdentifier required: - instance - catalog additionalProperties: false synq.platforms.v1.BigqueryIdentifier: type: object properties: project: type: string description: BigQuery project title: BigqueryIdentifier required: - project additionalProperties: false synq.platforms.v1.ClickhouseIdentifier: type: object properties: host: type: string description: Clickhouse host inclusive of port schema: type: string description: Clickhouse database title: ClickhouseIdentifier required: - host - schema additionalProperties: false synq.platforms.v1.DatabricksIdentifier: type: object properties: workspace: type: string description: URL of the databricks workspace title: DatabricksIdentifier required: - workspace additionalProperties: false synq.platforms.v1.DbtCloudIdentifier: type: object properties: apiEndpoint: type: string description: API endpoint for Dbt Cloud accountId: type: string description: Account ID projectId: type: string description: Project ID title: DbtCloudIdentifier required: - apiEndpoint - accountId - projectId additionalProperties: false synq.platforms.v1.DuckDbIdentifier: type: object properties: motherduckAccount: type: string title: DuckDbIdentifier additionalProperties: false synq.platforms.v1.MssqlIdentifier: type: object properties: host: type: string description: SQL Server host database: type: string description: Database name title: MssqlIdentifier required: - host - database additionalProperties: false synq.platforms.v1.MysqlIdentifier: type: object properties: host: type: string description: Mysql host inclusive of port title: MysqlIdentifier required: - host additionalProperties: false synq.platforms.v1.OracleIdentifier: type: object properties: host: type: string description: Oracle host serviceName: type: string description: Oracle service name (PDB) title: OracleIdentifier required: - host - serviceName additionalProperties: false synq.platforms.v1.PostgresIdentifier: type: object properties: host: type: string description: Postgres host inclusive of port database: type: string description: Postgres database title: PostgresIdentifier required: - host - database additionalProperties: false synq.platforms.v1.RedshiftIdentifier: type: object properties: cluster: type: string description: Redshift cluster database: type: string description: Redshift database title: RedshiftIdentifier required: - cluster - database additionalProperties: false synq.platforms.v1.SnowflakeIdentifier: type: object properties: account: type: string description: Snowflake account database: type: string description: Snowflake database title: SnowflakeIdentifier required: - account - database additionalProperties: false synq.platforms.v1.SqlMeshIdentifier: type: object properties: defaultDatabaseInstance: type: string description: Default database instance for SQL Mesh title: SqlMeshIdentifier required: - defaultDatabaseInstance additionalProperties: false synq.platforms.v1.TrinoIdentifier: type: object properties: coordinator: type: string title: TrinoIdentifier additionalProperties: false synq.platforms.v1.UnknownDataPlatform: type: object title: UnknownDataPlatform additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer ````