Edit Issues
SCOPE_ISSUES_EDIT
Create and update data quality issues, including changing their status and assignees.
| Method | Description |
|---|---|
MarkExpectedsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-expected | Mark issue as expected. |
MarkFixedsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-fixed | Mark issue as fixed. |
MarkInvestigatingsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-investigating | Mark issue as being investigated. |
MarkNoActionNeededsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-no-action-needed | Mark issue as no action needed. |
PostCommentsynq.issues.issues.v1.IssuesService POST /api/issues/v1/{issue_id}/comment | Post a comment on an issue. |
ClearStatussynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/clear-status | Clear the triage status of an issue, returning it to an untriaged state. |
DeleteCommentsynq.issues.v2.IssuesService DELETE /api/issues/v2/{issue_id}/comment/{comment_id} | Delete a comment on an issue. |
MarkExpectedsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-expected | Mark issue as expected. |
MarkFixedsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-fixed | Mark issue as fixed. |
MarkInvestigatingsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-investigating | Mark issue as being investigated. |
MarkNoActionNeededsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-no-action-needed | Mark issue as no action needed. |
PostCommentsynq.issues.v2.IssuesService POST /api/issues/v2/{issue_id}/comment | Post a comment on an issue. |
Read Issues
SCOPE_ISSUES_READ
View data quality issues and their details.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetIssuessynq.issues.issues.v1.IssuesService POST /api/issues/v1/by-id | |
ListIssuessynq.issues.issues.v1.IssuesService GET /api/issues/v1 | |
BatchGetIssuessynq.issues.v2.IssuesService POST /api/issues/v2/by-id | |
ListIssuessynq.issues.v2.IssuesService GET /api/issues/v2 |
Edit Incidents
SCOPE_INCIDENTS_EDIT
Declare, update, and resolve incidents raised for confirmed issues with business impact.
| Method | Description |
|---|---|
AddIssuesToIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/issues | |
AssignIncidentOwnersynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/assign-owner | |
CancelIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/cancel | Cancel an incident |
CloseIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/close | Close an incident |
CreateIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1 | |
DeleteCommentsynq.incidents.v1.IncidentsService DELETE /api/incidents/v1/{incident_id}/comment/{comment_id} | Delete a comment on an incident. |
MergeIncidentssynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/merge | |
PostCommentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/comment | Post a comment on an incident. |
RemoveIssuesFromIncidentsynq.incidents.v1.IncidentsService DELETE /api/incidents/v1/{incident_id}/issues | |
RenameIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/rename | |
SplitIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/split | |
UpdateIncidentStatesynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/state |
Read Incidents
SCOPE_INCIDENTS_READ
View incidents, including their status and the issues they track.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetIncidentssynq.incidents.v1.IncidentsService POST /api/incidents/v1/by-id | |
ListIncidentssynq.incidents.v1.IncidentsService GET /api/incidents/v1 |
Edit Entities
SCOPE_ENTITY_EDIT
Create and update entities such as tables, dashboards, and jobs in the catalog.
| Method | Description |
|---|---|
DeleteCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService DELETE /api/entities/custom/v1/check-relationships | Delete relationships between checks and the entities they validate. |
UpsertCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService POST /api/entities/custom/v1/check-relationships | Create or update relationships that attach a check (e.g. a SQL test) to the entities it validates. |
DeleteEntitysynq.entities.custom.v1.EntitiesService DELETE /api/entities/custom/v1/entities | Delete a custom entity by its identifier. |
UpsertEntitysynq.entities.custom.v1.EntitiesService POST /api/entities/custom/v1/entities | Create or update a custom entity. |
DeleteEntityFeaturesynq.entities.custom.v1.FeaturesService DELETE /api/entities/custom/v1/features | Delete one feature of a custom entity, by the entity and the feature_id. |
UpsertEntityFeaturesynq.entities.custom.v1.FeaturesService POST /api/entities/custom/v1/features | Create or update a feature of a custom entity. |
DeleteEntitiesGroupsynq.entities.custom.v1.GroupsService DELETE /api/entities/custom/v1/groups | Delete a group by its identifier. |
UpsertEntitiesGroupsynq.entities.custom.v1.GroupsService POST /api/entities/custom/v1/groups | Set the entities of a group, and create the group if it does not exist. |
Read Entities
SCOPE_ENTITY_READ
View entities such as tables, dashboards, and jobs, along with their metadata.
| Method | Description |
|---|---|
GenerateConnectionsYamlsynq.agent.dwh.v1.ConnectionsService | Convert data warehouse connections to a YAML configuration. |
ListConnectionssynq.agent.dwh.v1.ConnectionsService | List the data warehouse connections of a workspace. |
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetEntityUsagesynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/usage | Read how each asked entity is used over the window, in one line: what loads it, what runs and builds it, what else writes it, and who reads it, such as “loaded by Fivetran, orchestrated by Airflow, transformed by dbt, read by Looker Studio, 3 people and 12 logins”. |
BatchGetPopularitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/popularity | Read how popular each asked entity is over the window: its counted reads and writes per measure, and its rank in each pool it has reads in. |
GetActivityOverviewsynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/overview | Read a workspace’s queries and their cost per group of logins, per platform, and its most read entities. |
GetEntityActivitySeriessynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/series | Read how access to one entity moves over the window: per direction, a point per UTC hour, a point per day in the asked time zone, and a weekday and hour grid. |
ListAccessSignalssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/signals | List the entities of the workspace, or of a selection, that one signal names, such as the tables a pipeline builds and nobody reads, or the tables nobody touched. |
ListActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-list | List the workspace’s actors, the service accounts, tools, people, logins nothing classifies and Coalesce Quality, each with the totals GetActorSummary has for it: its queries and their weights, its reads, inputs and writes, and the entities it read and wrote. |
BatchGetEntityAnnotationssynq.entities.annotations.v1.AnnotationsService POST /api/entities/annotations/v1/batchGet | Read the annotations carried by specific entities. |
ListAnnotationssynq.entities.annotations.v1.AnnotationsService GET /api/entities/annotations/v1 | List all available annotations with their usage counts across entities. |
BatchChangesynq.entities.changes.v1.ChangesService POST /api/changes/v1/by-id | Get multiple entity changes by their IDs in a single request. |
Listsynq.entities.changes.v1.ChangesService GET /api/changes/v1 | Retrieves the complete change history for specified entities. |
GetCoveragesynq.entities.checks.v1.ChecksCoverageService | Get the coverage of checks for a specific entity. |
GetTableConstraintssynq.entities.constraints.v1.TableConstraintsService GET /api/constraints/v1/table-constraints | Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity. |
BatchDatabaseCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-id | Get multiple DatabaseCoordinates for identifiers. |
BatchIdsByCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-fqn | Given database FQN return possible entity ids. |
ListCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService POST /api/entities/custom/v1/check-relationships/list | List every relationship that attaches a check to the entities it validates, across the whole workspace. |
ListEntitiessynq.entities.custom.v1.EntitiesService GET /api/entities/custom/v1/entities | List the custom entities of the workspace. |
ListEntityFeaturessynq.entities.custom.v1.FeaturesService POST /api/entities/custom/v1/features/list | List the features of one entity, or of every custom entity in the workspace when entity_id is left unset. |
ListEntityGroupssynq.entities.custom.v1.GroupsService POST /api/entities/custom/v1/groups/list | List the entity groups of the workspace, each with the ids of its entities. |
ListTypessynq.entities.custom.v1.TypesService POST /api/entities/custom/v1/types/list | List the custom entity types of the workspace. |
BatchGetEntitiessynq.entities.entities.v1.EntitiesService POST /api/entities/v1/by-id | Get multiple entities by their identifiers. |
GetEntitysynq.entities.entities.v1.EntitiesService | Get specific entity by its identifier. |
ListEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1 | List entities matching the given filter |
SearchEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1/search | Search for entities. |
Browsesynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/browseGET /api/entities/folders/v1/browse | Browse the hierarchy one level at a time. |
GetFolderOfsynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/folder-ofGET /api/entities/folders/v1/folder-of | Given entity ids, return the folder breadcrumb(s) each entity lives in — ordered root first, leaf (immediate parent) last. |
ListMemberssynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/membersGET /api/entities/folders/v1/members | List the entity ids contained in a folder, paginated. |
GetImpactsynq.entities.impact.v1.ImpactService POST /api/impact/v1 | |
BatchResolveIdentifierssynq.entities.resolve.v1.IdentifierResolveService POST /api/resolve/v1/by-id | Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups. |
BatchSchemaMismatchessynq.entities.schemas.v1.SchemaMismatchesService POST /api/schema-mismatches/v1 | Get schema mismatches for a batch of entities by their identifiers. |
GetSchemasynq.entities.schemas.v1.SchemasService GET /api/schema/v1 | Get the schema of an entity by its identifier. |
BatchSqlDetailssynq.entities.sql_insights.v1.SqlInsightsService POST /api/sql-insights/v1/details:batch | Return the SQL details for each of the requested entities, keyed by their Coalesce Quality path: the set of detected SQL constructs and, when the request asks for them, the joins that building the entity makes. |
ListJoinPatternssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/join-patterns | List how other SQL joins a table, or one of its columns: every join key that the SQL of a table, view or model in the workspace uses to join the requested entity, read from the requested entity’s side, and which SQL makes it. |
ListSqlConstructssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/constructs | Return the distribution of SQL constructs across all entities in the workspace. |
BatchGetTableInfosynq.entities.tableinfo.v1alpha.TableInfoService POST /api/entities/table-info/v1alpha/batch-get | Warehouse facts about tables and views: owner, creation time, row count, size, last modification and a link to the object in the warehouse console. |
ListEntityTraitDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-traits/list | List every trait a selection query can filter entities by. |
ListEntityTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-types/list | List every kind of entity in your workspace, the built-in types and your own. |
ListExecutionTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/execution-types/list | List every kind of run Coalesce Quality records against an entity. |
ListPlatformDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/platforms/list | List every platform Coalesce Quality connects to, with its display name. |
GetDiffByCommitsynq.git.commits.v1.CommitsService GET /api/git/v1/commit/{commit_sha} | |
BatchGetEntityKnowledgesynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/entities/by-id | Read the knowledge held about entities: the description people wrote for each one, and the knowledge pages pinned to it. |
BatchGetKnowledgePagessynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/pages/by-id | Read knowledge pages by id: their content, where they sit in the tree, who owns them and how they are tagged. |
ListKnowledgePageLinkssynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages/{page_id}/links | List what is pinned to a knowledge page, in either direction: the ids of the entities and of the other knowledge pages. |
ListKnowledgePagessynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages | List the ids of knowledge pages, ordered by name, optionally narrowed by a part of their name and by certification. |
BatchGetLatestEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService POST /api/monitors/predictions/v1/entity-metrics:batchLatest | Returns the most recent observed table-stats sample (row count, freshness) for each requested entity. |
GetEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1/entity-metrics | Returns raw metric timeseries for an entity. |
GenerateQuerysynq.queries.v1.NLQueryService POST /api/queries/v1/generate | Generate a Query from a natural language description. |
ResolveQuerysynq.queries.v1.QueriesService POST /api/queries/v1/resolve | Evaluate a selection and return the matched entity ids, paginated. |
TranslateResolverQlsynq.queries.v1.QueriesService POST /api/queries/v1/translate-resolver-ql | Compile a ResolverQL expression into a structured public Query. |
Edit Entity Types
SCOPE_ENTITY_TYPE_EDIT
Define and update custom entity types.
| Method | Description |
|---|---|
DeleteTypesynq.entities.custom.v1.TypesService DELETE /api/entities/custom/v1/types | Delete a custom entity type by its type_id. |
UpsertTypesynq.entities.custom.v1.TypesService POST /api/entities/custom/v1/types | Create or update a custom entity type. |
Read Entity Types
SCOPE_ENTITY_TYPE_READ
View entity type definitions.
| Method | Description |
|---|---|
ListTypessynq.entities.custom.v1.TypesService POST /api/entities/custom/v1/types/list | List the custom entity types of the workspace. |
ListEntityTraitDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-traits/list | List every trait a selection query can filter entities by. |
ListEntityTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-types/list | List every kind of entity in your workspace, the built-in types and your own. |
ListExecutionTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/execution-types/list | List every kind of run Coalesce Quality records against an entity. |
ListPlatformDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/platforms/list | List every platform Coalesce Quality connects to, with its display name. |
Edit Lineage
SCOPE_LINEAGE_EDIT
Create and update lineage relationships between entities.
| Method | Description |
|---|---|
DeleteRelationshipssynq.entities.custom.v1.RelationshipsService DELETE /api/entities/custom/v1/relationships | Delete relationships between entities. |
UpsertRelationshipssynq.entities.custom.v1.RelationshipsService POST /api/entities/custom/v1/relationships | Create or update relationships between entities. |
CreateFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha | Create a fold. |
DeleteFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/delete | Delete a fold. |
RenameFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/rename | Change the name shown on a fold’s node. |
SetFoldEnabledsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/enabled | Switch a fold on or off. |
UpdateFoldMatchersynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/matcher | Change which entities a fold matches. |
Read Lineage
SCOPE_LINEAGE_READ
View upstream and downstream lineage between entities.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetEntityUsagesynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/usage | Read how each asked entity is used over the window, in one line: what loads it, what runs and builds it, what else writes it, and who reads it, such as “loaded by Fivetran, orchestrated by Airflow, transformed by dbt, read by Looker Studio, 3 people and 12 logins”. |
GetActorSummarysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-summary | Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. |
ListEntityActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actors | Read who read and wrote each asked entity over the window: the jobs, the service accounts, the tools and the logins. |
ListRelationshipssynq.entities.custom.v1.RelationshipsService POST /api/entities/custom/v1/relationships/list | List relationships touching the given entities, or every relationship in the workspace when ids is left empty. |
GetImpactsynq.entities.impact.v1.ImpactService POST /api/impact/v1 | |
BatchGetFoldNodessynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/nodes/batch-get | Read fold nodes by entity id: which fold a node in a lineage response stands for, and which entities it showed. |
BatchGetFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/batch-get | Read folds by id. |
ListFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService GET /api/lineage/folds/v1alpha | List the ids of every fold in the workspace, switched off ones included, oldest first. |
PreviewFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/preview | Show what a matcher would fold, before it is saved: how many entities and lineage edges it matches, a sample of them, and the entities that stop being shown on the same node as a folded one. |
GetLineagesynq.entities.lineage.v1.LineageService POST /api/lineage/v1 | |
BatchOrchestrationsynq.entities.orchestration.v1.OrchestrationService GET /api/orchestration/v1 | Return, for each requested entity, the jobs, job steps and tasks that ran it in the last 31 days (upstream), and the entities it ran (downstream). |
Read Entity Code
SCOPE_CODE_READ
View the SQL or source code associated with an entity.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
ListCodesynq.entities.code.v1.CodeService GET /api/code/v1 | List all code artifacts associated with a specific entity. |
GetDiffByChangeIdsynq.git.commits.v1.CommitsService GET /api/git/v1/change/{change_id} |
Read Entity Status
SCOPE_STATUS_READ
View the health and status of entities, including status summaries and history.
| Method | Description |
|---|---|
BatchGetIncidentssynq.entities.status.v1.EntityIncidentsService POST /api/status/v1/incidents/by-id | Get the open incidents of multiple entities, and optionally of their upstream entities. |
GetIncidentssynq.entities.status.v1.EntityIncidentsService | Get the open incidents of one entity, and optionally of its upstream entities. |
BatchGetIssuesStatussynq.entities.status.v1.EntityIssuesService POST /api/status/v1/issues/by-id | Get the issues status of multiple entities, and optionally of their upstream entities. |
GetIssuesStatussynq.entities.status.v1.EntityIssuesService | Get the issues status of one entity, and optionally of its upstream entities. |
Edit SQL Tests
SCOPE_DATACHECKS_SQLTESTS_EDIT
Create, update, and delete SQL tests.
| Method | Description |
|---|---|
BatchDeleteSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService DELETE /api/datachecks/sql-test-deployment-rules/v1/batch | |
BatchDeploySqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/batch/deployed | |
DeleteSqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService DELETE /api/datachecks/sql-test-deployment-rules/v1/{id} | |
DeploySqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/deployed | Deploy (create or update) a SqlTestDeploymentRule and immediately sync tests onto its current match set. |
BatchDeleteSqlTestssynq.datachecks.sqltests.v1.SqlTestsService DELETE /api/datachecks/sqltests/v1 | Delete SqlTests by their IDs. |
BatchUpsertSqlTestssynq.datachecks.sqltests.v1.SqlTestsService POST /api/datachecks/sqltests/v1 | Upsert SqlTests based on a unique ID. |
TriggerSqlTestRunAgainsynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger/sql-test-run-again | Run a SQL test again with the time placeholder values of an earlier execution. |
Read SQL Tests
SCOPE_DATACHECKS_SQLTESTS_READ
View SQL tests and their configuration.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/by-id | |
GetSqlTestDeployDeleteOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/{id}/deleted | Preview the effect of deleting a rule, without deleting it. |
GetSqlTestDeployOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/overview | Preview the effect of deploying a rule (which have not yet been saved), without deploying it. |
ListSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1 | |
BatchGetSqlTestssynq.datachecks.sqltests.v1.SqlTestsService POST /api/datachecks/sqltests/v1/by-id | Get SqlTests by their IDs. |
ListSqlTestssynq.datachecks.sqltests.v1.SqlTestsService GET /api/datachecks/sqltests/v1 | List SqlTests for given annotations. |
Read SQL Tests Audit
SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ
View the audit history of changes to SQL tests.
| Method | Description |
|---|---|
GetSqlTestAuditsynq.datachecks.sqltests.v1.SqlTestsService | Get SqlTest audit from a given execution ID in jwt token. |
Edit Test Suggestions
SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT
Accept, dismiss, and manage suggested tests.
| Method | Description |
|---|---|
MarkAsCancelledsynq.agent.sre.v1.TestsSuggestionStateService | |
MarkAsCompletedsynq.agent.sre.v1.TestsSuggestionStateService | |
MarkAsFailedsynq.agent.sre.v1.TestsSuggestionStateService | |
MarkAsRunningsynq.agent.sre.v1.TestsSuggestionStateService | |
SuggestForsynq.agent.sre.v1.TestsSuggestionStateService | |
BatchAcceptTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService PATCH /api/datachecks/testsuggestions/v1/accepted | |
BatchCreateTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService POST /api/datachecks/testsuggestions/v1 | |
BatchRejectTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService PATCH /api/datachecks/testsuggestions/v1/rejected |
Read Test Suggestions
SCOPE_DATACHECKS_TESTSUGGESTIONS_READ
View suggested tests.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | |
GetActiveSuggestionStatesForsynq.agent.sre.v1.TestsSuggestionStateService | |
ListSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | |
BatchGetTestSuggestionsForEntitiessynq.datachecks.testsuggestions.v1.TestSuggestionsService GET /api/datachecks/testsuggestions/v1 |
Trigger Data Checks
SCOPE_DATACHECKS_TRIGGER
Trigger data checks to run on demand.
| Method | Description |
|---|---|
TriggerDatacheckssynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger | Run the datachecks of the specified entities. |
TriggerSqlTestRunAgainsynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger/sql-test-run-again | Run a SQL test again with the time placeholder values of an earlier execution. |
Edit Executions
SCOPE_EXECUTION_EDIT
Report execution runs and their results.
| Method | Description |
|---|---|
UpsertExecutionsynq.entities.custom.v1.EntityExecutionsService POST /api/entities/custom/executions/v1 | Record a run of a custom entity, with its status. |
UpsertLogEntrysynq.entities.custom.v1.EntityExecutionsService POST /api/entities/custom/executions/v1/log-entry | Record a log message for a custom entity. |
UpsertExecutionsynq.entities.executions.v1.EntityExecutionsService POST /api/executions/v1 | Record a run of a custom entity, with its status. |
UpsertLogEntrysynq.entities.executions.v1.EntityExecutionsService POST /api/executions/v1/log-entry | Record a log message for a custom entity. |
Edit Execution Logs
SCOPE_EXECUTION_LOG_EDIT
Write logs for execution runs.
| Method | Description |
|---|---|
UpsertLogEntrysynq.entities.custom.v1.EntityExecutionsService POST /api/entities/custom/executions/v1/log-entry | Record a log message for a custom entity. |
UpsertLogEntrysynq.entities.executions.v1.EntityExecutionsService POST /api/executions/v1/log-entry | Record a log message for a custom entity. |
Read Executions
SCOPE_EXECUTION_READ
View execution run history and results.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
BatchGetExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/by-id | Get multiple executions by their IDs. |
GetExecutionsSummarysynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/summary | Get aggregated statistics about the executions of the specified entities. |
GetLatestExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/latest | Get the most recent execution of each specified entity. |
ListExecutionssynq.entities.executions.v2.EntityExecutionsService GET /api/executions/v2/list | List the executions of one or more entities, paginated. |
Edit Integration Settings
SCOPE_INTEGRATION_EDIT
Create, update, and delete integrations and their connection settings.
| Method | Description |
|---|---|
AcceptPromptSuggestionsynq.agent.sre.v1.SreAgentService | Apply a pending suggestion to the matching SRE agent prompt field. |
DismissPromptSuggestionsynq.agent.sre.v1.SreAgentService | Mark a pending suggestion as dismissed, with an optional free-text reason. |
RecordPromptSuggestionsynq.agent.sre.v1.SreAgentService | Record a new prompt suggestion for a workspace. |
BatchGetIntegrationHealthsynq.integrations.v1.IntegrationsService | Return the current health of several integrations at once, without their run history: what GetIntegrationHealth returns as health, for each id. |
BatchGetIntegrationssynq.integrations.v1.IntegrationsService POST /api/integrations/v1/by-id | Fetch multiple integrations by id in one call. |
CreateIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1 | Create a new integration. |
DeleteIntegrationsynq.integrations.v1.IntegrationsService DELETE /api/integrations/v1/{integration_id} | Delete an integration. |
DisableIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/disable | Disable an integration without deleting it. |
EnableIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/enable | Enable a previously disabled integration. |
GetIntegrationsynq.integrations.v1.IntegrationsService | Fetch a single integration by id. |
GetIntegrationHealthsynq.integrations.v1.IntegrationsService | Return current health plus a paginated history of recent runs for an integration. |
ListIntegrationssynq.integrations.v1.IntegrationsService GET /api/integrations/v1 | List all integrations in the workspace (optionally filtered by enabled state). |
RefreshIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/refresh | Trigger an immediate, ad-hoc refresh of an integration. |
UpdateIntegrationsynq.integrations.v1.IntegrationsService PUT /api/integrations/v1/{integration_id} | Update an integration. |
SetPlatformAuthenticationsynq.platforms.v1.PlatformsService POST /api/platforms/v1 |
Read Integration Settings
SCOPE_INTEGRATION_READ
View integrations and their connection settings.
| Method | Description |
|---|---|
GetConfigsynq.agent.sre.v1.SreAgentService | Return the Scout configuration (system prompts and a summary of the DWH connections) for the caller’s workspace. |
ListPromptSuggestionssynq.agent.sre.v1.SreAgentService | List the prompt-improvement suggestions recorded for the caller’s workspace. |
Getsynq.extensions.atlan.integrations.v1.AtlanIntegrationService GET /api/extensions/atlan/integrations/v1 | |
BatchGetIntegrationHealthsynq.integrations.v1.IntegrationsService | Return the current health of several integrations at once, without their run history: what GetIntegrationHealth returns as health, for each id. |
BatchGetIntegrationssynq.integrations.v1.IntegrationsService POST /api/integrations/v1/by-id | Fetch multiple integrations by id in one call. |
GetIntegrationsynq.integrations.v1.IntegrationsService | Fetch a single integration by id. |
GetIntegrationHealthsynq.integrations.v1.IntegrationsService | Return current health plus a paginated history of recent runs for an integration. |
ListIntegrationssynq.integrations.v1.IntegrationsService GET /api/integrations/v1 | List all integrations in the workspace (optionally filtered by enabled state). |
Edit Users
SCOPE_USER_EDIT
Manage workspace members, including inviting users and updating their roles.
| Method | Description |
|---|---|
AddUserRolesynq.users.v1.UsersService POST /api/users/v1/roles | Grants a role to a user in the workspace. |
DeleteUserAliasessynq.users.v1.UsersService POST /api/users/v1/aliases/delete | Removes aliases from users. |
RemoveUserRolesynq.users.v1.UsersService POST /api/users/v1/roles/remove | Withdraws a role from a user in the workspace. |
UpsertUserAliasessynq.users.v1.UsersService PUT /api/users/v1/aliases | Links aliases to users. |
Read Users
SCOPE_USER_READ
View workspace members and their roles.
| Method | Description |
|---|---|
ListDomainMemberssynq.domains.members.v1.DomainMembersService GET /api/domains/members/v1/{domain_id}/members | List domain members. |
ListUserDomainssynq.domains.members.v1.DomainMembersService GET /api/domains/members/v1/users/{user_id}/domains | List domains for the given user. |
SetDefaultUserDomainsynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/default-for-user | Set default domain for user. |
BatchGetUserssynq.users.v1.UsersService POST /api/users/v1/batch-get | |
GetByAliassynq.users.v1.UsersService POST /api/users/v1/by-alias | |
GetByEmailsynq.users.v1.UsersService GET /api/users/v1/by-email | |
GetUserAliasessynq.users.v1.UsersService GET /api/users/v1/aliases | |
GetUserIdentitiessynq.users.v1.UsersService GET /api/users/v1/identities | Returns all canonical identity strings for a user. |
ListUserssynq.users.v1.UsersService GET /api/users/v1 |
Assign Users
SCOPE_USER_ASSIGN
Assign users as owners of entities, issues, and other resources.
| Method | Description |
|---|---|
AddDomainMemberssynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/members | Add domain members. |
RemoveDomainMemberssynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/members/remove | Remove domain members. |
Read Monitors
SCOPE_MONITORS_READ
View monitors and their configuration.
| Method | Description |
|---|---|
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
ListConfigsMonitorssynq.monitors.custom_monitors.v1.CustomMonitorsService GET /api/monitors/custom-monitors/v1/by-config | |
ListMonitorssynq.monitors.custom_monitors.v1.CustomMonitorsService GET /api/monitors/custom-monitors/v1 | |
Historysynq.monitors.history.v1.HistoryService GET /api/monitors/history/v1 | |
MonitorInfosynq.monitors.info.v1.MonitorInfoService GET /api/monitors/info/v1 | |
BatchGetLatestEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService POST /api/monitors/predictions/v1/entity-metrics:batchLatest | Returns the most recent observed table-stats sample (row count, freshness) for each requested entity. |
GetEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1/entity-metrics | Returns raw metric timeseries for an entity. |
GetMonitorPredictionssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1 | Returns prediction timeseries for a monitor. |
ListMonitorSegmentssynq.monitors.segments.v1.MonitorSegmentsService GET /api/monitors/segments/v1 | Lists the segments a monitor has ingested so far, with their raw value and current label. |
Edit Automatic Monitors
SCOPE_MONITORS_AUTOMATIC_EDIT
Enable, disable, and configure automatic monitors.
| Method | Description |
|---|---|
BatchDeleteDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService DELETE /api/monitors/automated/v1/deployment-rules/batch | |
BatchDeployDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/batch/deployed | |
BatchGetDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules/batch | |
BatchUpdateDeploymentRuleTitlesynq.monitors.automated_monitors.v1.DeploymentRulesService PATCH /api/monitors/automated/v1/deployment-rules | |
BatchUpsertDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/batch | |
DeleteDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService DELETE /api/monitors/automated/v1/deployment-rule/{id} | |
DeployDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/deployed | |
GetDeployDeleteOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule/{id}/deleted | |
GetDeployOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule | |
ListDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules | |
ListDeploymentRulesForAssetsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules/{asset_path} | |
UpsertDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules |
Edit Custom Monitors
SCOPE_MONITORS_CUSTOM_EDIT
Create, update, and delete custom monitors.
| Method | Description |
|---|---|
BatchCreateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1 | |
BatchDeleteMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/delete | |
BatchUpdateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService PUT /api/monitors/custom-monitors/v1 | |
BatchUpdateMonitorModesynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/mode | |
BatchUpdateMonitorSeveritysynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/severity | |
ConfigChangesOverviewsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/config-changes | |
BatchUpdateMonitorSegmentLabelssynq.monitors.segments.v1.MonitorSegmentsService POST /api/monitors/segments/v1/labels | Sets or clears the label of one or more segments. |
Edit Custom SQL Monitors
SCOPE_MONITORS_CUSTOM_SQL_EDIT
Create and update custom monitors backed by a custom SQL query.
| Method | Description |
|---|---|
BatchCreateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1 | |
BatchUpdateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService PUT /api/monitors/custom-monitors/v1 |
Edit Alerts
SCOPE_ALERTS_EDIT
Create, update, and delete alert rules and notification channels.
| Method | Description |
|---|---|
Createsynq.alerts.services.v1.AlertsService POST /api/alerts/v1 | Create a new alert configuration. |
Deletesynq.alerts.services.v1.AlertsService DELETE /api/alerts/v1 | Delete an existing alert configuration. |
ToggleEnabledsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/toggle | Enables or disables an existing alert configuration. |
Updatesynq.alerts.services.v1.AlertsService PUT /api/alerts/v1 | Update an existing alert configuration. |
Createsynq.alerts.services.v2.AlertsService POST /api/alerts/v2 | Create a new alert configuration. |
Deletesynq.alerts.services.v2.AlertsService DELETE /api/alerts/v2 | Delete an existing alert configuration. |
Renamesynq.alerts.services.v2.AlertsService POST /api/alerts/v2/rename | Rename an existing alert configuration. |
SendTestAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/test | Delivers a static test message to the given targets so you can confirm that delivery reaches each channel before relying on a real alert. |
ToggleEnabledsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/toggle | Enables or disables an existing alert configuration. |
ToggleIncidentOwnerAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/incident-owner | Turns the workspace’s incident-owner alert on or off. |
UpdateSettingssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/settings | Update the trigger and/or the kind-specific settings of an alert. |
UpdateTargetssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/targets | Replace the delivery targets of an existing alert configuration. |
UpdateTemplatesynq.alerts.services.v2.AlertsService POST /api/alerts/v2/template | Set or clear the message template of an existing alert configuration. |
Upsertsynq.alerts.services.v2.AlertsService PUT /api/alerts/v2 | Creates the alert when no alert holds fqn, otherwise replaces the stored alert with the state given here in a single write. |
Read Alerts
SCOPE_ALERTS_READ
View alert rules and notification channels.
| Method | Description |
|---|---|
BatchGetsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/get | Get multiple alert configurations by their identifiers. |
Listsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/list | Retrieves a list of alert configurations based on filters. |
BatchGetsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/get | Get multiple alert configurations by their identifiers. |
GetIncidentOwnerAlertsynq.alerts.services.v2.AlertsService GET /api/alerts/v2/incident-owner | Reports whether the workspace’s incident-owner alert is on. |
Listsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/list | Retrieves a list of alert configurations based on filters. |
Edit Owners
SCOPE_OWNERS_EDIT
Create, update, and delete owners and their notification channels (Slack, email, Microsoft Teams, users).
| Method | Description |
|---|---|
DeleteOwnersynq.owners.v1.OwnersService POST /api/owners/v1/delete | Delete an owner and all of its ownerships. |
UpsertOwnersynq.owners.v1.OwnersService POST /api/owners/v1 | Create or update an owner. |
Read Owners
SCOPE_OWNERS_READ
View owners and their notification channels.
| Method | Description |
|---|---|
BatchGetEntityOverlayssynq.overlays.v1.OverlaysService POST /api/overlays/v1/by-id | For each entity, list every overlay that claims it. |
BatchGetOverlayMemberCountssynq.overlays.v1.OverlaysService POST /api/overlays/v1/member-counts | Count the members of each named overlay. |
GetCoverageSummarysynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage-summary | Count coverage over one or more named candidate sets, without listing the assets themselves. |
ListEntityCoveragesynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage | List the candidate assets together with the overlays claiming each, and narrow them to what is or is not covered. |
BatchGetOwnerssynq.owners.v1.OwnersService POST /api/owners/v1/batch-get | Fetch multiple owners by id. |
ListOwnerssynq.owners.v1.OwnersService GET /api/owners/v1 | List the owners in the workspace, paginated. |
Edit Ownership
SCOPE_OWNERSHIP_EDIT
Create, update, and delete ownership assignments and the alerts they route to owners.
| Method | Description |
|---|---|
DeleteOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/delete | Delete an ownership by id. |
UpsertOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/{owner_id}/ownerships | Create or update an ownership under an owner. |
Read Ownership
SCOPE_OWNERSHIP_READ
View ownership assignments and their alert routing.
| Method | Description |
|---|---|
BatchGetOwnershipssynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/batch-get | Fetch multiple ownerships by id (across owners). |
ListOwnershipssynq.owners.v1.OwnersService GET /api/owners/v1/{owner_id}/ownerships | List the ownerships of an owner, paginated. |
Edit Data Products
SCOPE_DATAPRODUCT_EDIT
Create, update, and delete data products.
| Method | Description |
|---|---|
Deletesynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/delete | Delete a dataproduct by its identifier. |
RemoveDefinitionPartsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition/part/delete | Remove definition part from the definition of an existing dataproduct. |
SetDefinitionsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition | Set the definition for an existing dataproduct. |
Upsertsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1 | Create or update a dataproduct. |
UpsertDefinitionPartsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition/part | Upsert definition part to the definition of an existing dataproduct. |
Deletesynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/delete | Delete a data product. |
RemoveDefinitionPartsynq.dataproducts.v2.DataproductsService DELETE /api/dataproducts/v2/{id}/definition/parts/{part_id} | Remove a single definition part by its part id. |
SetDefinitionsynq.dataproducts.v2.DataproductsService PUT /api/dataproducts/v2/{id}/definition | Replace the entire membership definition of a data product. |
Upsertsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2 | Create or update a data product. |
UpsertDefinitionPartsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/{id}/definition/parts | Add or replace a single definition part (matched by its part id). |
Read Data Products
SCOPE_DATAPRODUCT_READ
View data products and their contents.
| Method | Description |
|---|---|
Getsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/get | Get multiple dataproducts by their identifiers. |
Listsynq.dataproducts.v1.DataproductsService GET /api/dataproducts/v1 | List all the dataproducts in the current scope. |
BatchGetsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/batch-get | Fetch multiple data products by id. |
Listsynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2 | List the data products in the workspace, paginated. |
ListMemberssynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2/{id}/members | List the assets that currently belong to a data product, resolved from its definition and returned as opaque entity ids. |
BatchGetEntityOverlayssynq.overlays.v1.OverlaysService POST /api/overlays/v1/by-id | For each entity, list every overlay that claims it. |
BatchGetOverlayMemberCountssynq.overlays.v1.OverlaysService POST /api/overlays/v1/member-counts | Count the members of each named overlay. |
GetCoverageSummarysynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage-summary | Count coverage over one or more named candidate sets, without listing the assets themselves. |
ListEntityCoveragesynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage | List the candidate assets together with the overlays claiming each, and narrow them to what is or is not covered. |
Edit Domains
SCOPE_DOMAIN_EDIT
Create, update, and delete domains.
| Method | Description |
|---|---|
Deletesynq.domains.v1.DomainsService POST /api/domains/v1/delete | Delete a domain by its identifier. |
RemoveDefinitionPartsynq.domains.v1.DomainsService DELETE /api/domains/v1/{domain_id}/definition/parts/{part_id} | Remove definition part from the definition of an existing domain. |
SetDefinitionsynq.domains.v1.DomainsService PUT /api/domains/v1/{domain_id}/definition | Set the definition for an existing domain. |
Upsertsynq.domains.v1.DomainsService POST /api/domains/v1 | Create or update a domain. |
UpsertDefinitionPartsynq.domains.v1.DomainsService POST /api/domains/v1/{domain_id}/definition/parts | Upsert definition part to the definition of an existing domain. |
Deletesynq.domains.v2.DomainsService POST /api/domains/v2/delete | Delete a domain. |
RemoveDefinitionPartsynq.domains.v2.DomainsService DELETE /api/domains/v2/{id}/definition/parts/{part_id} | Remove a single definition part by its part id. |
SetDefinitionsynq.domains.v2.DomainsService PUT /api/domains/v2/{id}/definition | Replace the entire membership definition of a domain. |
Upsertsynq.domains.v2.DomainsService POST /api/domains/v2 | Create or update a domain. |
UpsertDefinitionPartsynq.domains.v2.DomainsService POST /api/domains/v2/{id}/definition/parts | Add or replace a single definition part (matched by its part id). |
Read Domains
SCOPE_DOMAIN_READ
View domains and their contents.
| Method | Description |
|---|---|
BatchGetsynq.domains.v1.DomainsService POST /api/domains/v1/batch-get | Get multiple domains by their identifiers. |
FetchDomainWithSubDomainssynq.domains.v1.DomainsService GET /api/domains/v1/{domain_id}/sub-domains | Get a domain with its sub-domains |
Listsynq.domains.v1.DomainsService GET /api/domains/v1 | List all the domains in the current workspace. |
BatchGetsynq.domains.v2.DomainsService POST /api/domains/v2/batch-get | Fetch multiple domains by id. |
FetchDomainWithSubDomainssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/sub-domains | Fetch a domain together with its direct sub-domains, keyed by id. |
Listsynq.domains.v2.DomainsService GET /api/domains/v2 | List the domains in the workspace, paginated. |
ListMemberssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/members | List the assets that currently belong to a domain, resolved from its definition — including everything contributed by the data products and domains it references, and by its own sub-domains — and returned as opaque entity ids. |
Manage Extensions
SCOPE_EXTENSIONS_MANAGE
Manage platform extensions, including data warehouse agent and catalog connections.
| Method | Description |
|---|---|
GenerateConnectionsYamlsynq.agent.dwh.v1.ConnectionsService | Convert data warehouse connections to a YAML configuration. |
ListConnectionssynq.agent.dwh.v1.ConnectionsService | List the data warehouse connections of a workspace. |
Activatesynq.extensions.atlan.integrations.v1.AtlanIntegrationService PATCH /api/extensions/atlan/integrations/v1 | Activate or deactivate the integration. |
Pingsynq.extensions.atlan.integrations.v1.AtlanIntegrationService POST /api/extensions/atlan/integrations/v1/ping | Pings Atlan with the given connection credentials. |
Removesynq.extensions.atlan.integrations.v1.AtlanIntegrationService DELETE /api/extensions/atlan/integrations/v1 | |
Upsertsynq.extensions.atlan.integrations.v1.AtlanIntegrationService POST /api/extensions/atlan/integrations/v1 | Upserts an integration and validates it by checking if the provided API URL and token are valid. |
GetAtlanConnectionssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/connections | |
GetAtlanDataProductssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/data-products | |
GetAtlanDomainssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/domains | |
FetchRunssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/runs | |
GetConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/connection-mappings | |
GetDomainMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/domain-mappings | |
GetMappingTogglessynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/mappings/toggle | |
GetProductMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/product-mappings | |
RemoveConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService DELETE /api/extensions/atlan/workflows/v1/connection-mappings | |
SetConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/connection-mappings | |
SetMappingTogglessynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/mappings/toggle | |
Synchronizesynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/synchronize | Run a synchronization job for the integration. |
Read Usage
SCOPE_USAGE_GET
View workspace usage and quota metrics.
| Method | Description |
|---|---|
GetUsagesynq.domains.v1.DomainsService GET /api/domains/v1/usage | Report how many domains the workspace uses, split into top-level and sub-domains. |
GetUsagesynq.domains.v2.DomainsService GET /api/domains/v2/usage | Report how many domains the workspace uses, split into top-level and sub-domains. |
MCP Read Access
SCOPE_MCP_READ
Use any read-only MCP (Model Context Protocol) tool, including tools added in the future.
| Method | Description |
|---|---|
GenerateConnectionsYamlsynq.agent.dwh.v1.ConnectionsService | Convert data warehouse connections to a YAML configuration. |
ListConnectionssynq.agent.dwh.v1.ConnectionsService | List the data warehouse connections of a workspace. |
GetAuditLogsynq.agent.recon.v1.AuditLogService | Get one audit log by its invocation ID. |
ListAuditLogssynq.agent.recon.v1.AuditLogService | List audit logs from newest to oldest, optionally filtered by suite and time range. |
BatchReconciliationRunStatesynq.agent.recon.v1.RunStateService | Return the latest concluded run and any ongoing (SCHEDULED or IN_PROGRESS) run for each suite_id. |
ListReconciliationRunStatesynq.agent.recon.v1.RunStateService | List reconciliation runs, filtered by status and/or suite_id. |
GetSuiteConfigsynq.agent.recon.v1.SuiteConfigService | Get the latest version of a suite config by suite_id. |
GetSuiteConfigVersionsynq.agent.recon.v1.SuiteConfigService | Get a specific historical version of a suite config. |
ListSuiteConfigVersionssynq.agent.recon.v1.SuiteConfigService | Get version history for a suite config. |
ListSuiteConfigssynq.agent.recon.v1.SuiteConfigService | List latest suite configs with filtering and pagination. |
GetSuiteDeploymentsynq.agent.recon.v1.SuiteDeploymentService | Fetch a deployment by suite_id or deployment_id. |
ListSuiteDeploymentHistorysynq.agent.recon.v1.SuiteDeploymentService | List the append-only history of a deployment (every promote, re-promote, schedule/mapping change, pause/resume, unpromote). |
ListSuiteDeploymentssynq.agent.recon.v1.SuiteDeploymentService | List deployments for the caller’s workspace. |
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | Submit a feature request to the Coalesce Quality product team. |
GetConfigsynq.agent.sre.v1.SreAgentService | Return the Scout configuration (system prompts and a summary of the DWH connections) for the caller’s workspace. |
ListPromptSuggestionssynq.agent.sre.v1.SreAgentService | List the prompt-improvement suggestions recorded for the caller’s workspace. |
BatchSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | |
GetActiveSuggestionStatesForsynq.agent.sre.v1.TestsSuggestionStateService | |
ListSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | |
BatchLatestConclusionssynq.agent.sre.v1.TriageService GET /api/triage/v1/conclusions | Retrieves the latest triage conclusion, with its evidence, for one or more issues. |
BatchTriageStatesynq.agent.sre.v1.TriageService GET /api/triage/v1/states | Retrieves the triage state for one or more issues. |
ListTriageStatesynq.agent.sre.v1.TriageService GET /api/triage/v1/statuses | Lists the triage states of the workspace’s issues that have one of the given statuses, newest first. |
BatchGetsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/get | Get multiple alert configurations by their identifiers. |
GetIncidentOwnerAlertsynq.alerts.services.v2.AlertsService GET /api/alerts/v2/incident-owner | Reports whether the workspace’s incident-owner alert is on. |
Listsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/list | Retrieves a list of alert configurations based on filters. |
BatchGetSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/by-id | |
GetSqlTestDeployDeleteOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/{id}/deleted | Preview the effect of deleting a rule, without deleting it. |
GetSqlTestDeployOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/overview | Preview the effect of deploying a rule (which have not yet been saved), without deploying it. |
ListSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1 | |
BatchGetSqlTestssynq.datachecks.sqltests.v1.SqlTestsService POST /api/datachecks/sqltests/v1/by-id | Get SqlTests by their IDs. |
ListSqlTestssynq.datachecks.sqltests.v1.SqlTestsService GET /api/datachecks/sqltests/v1 | List SqlTests for given annotations. |
BatchGetTestSuggestionsForEntitiessynq.datachecks.testsuggestions.v1.TestSuggestionsService GET /api/datachecks/testsuggestions/v1 | |
Getsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/get | Get multiple dataproducts by their identifiers. |
Listsynq.dataproducts.v1.DataproductsService GET /api/dataproducts/v1 | List all the dataproducts in the current scope. |
BatchGetsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/batch-get | Fetch multiple data products by id. |
Listsynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2 | List the data products in the workspace, paginated. |
ListMemberssynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2/{id}/members | List the assets that currently belong to a data product, resolved from its definition and returned as opaque entity ids. |
BatchGetsynq.domains.v2.DomainsService POST /api/domains/v2/batch-get | Fetch multiple domains by id. |
FetchDomainWithSubDomainssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/sub-domains | Fetch a domain together with its direct sub-domains, keyed by id. |
Listsynq.domains.v2.DomainsService GET /api/domains/v2 | List the domains in the workspace, paginated. |
ListMemberssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/members | List the assets that currently belong to a domain, resolved from its definition — including everything contributed by the data products and domains it references, and by its own sub-domains — and returned as opaque entity ids. |
BatchGetEntityUsagesynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/usage | Read how each asked entity is used over the window, in one line: what loads it, what runs and builds it, what else writes it, and who reads it, such as “loaded by Fivetran, orchestrated by Airflow, transformed by dbt, read by Looker Studio, 3 people and 12 logins”. |
BatchGetPopularitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/popularity | Read how popular each asked entity is over the window: its counted reads and writes per measure, and its rank in each pool it has reads in. |
GetActivityOverviewsynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/overview | Read a workspace’s queries and their cost per group of logins, per platform, and its most read entities. |
GetActorSummarysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-summary | Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. |
GetEntityActivitySeriessynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/series | Read how access to one entity moves over the window: per direction, a point per UTC hour, a point per day in the asked time zone, and a weekday and hour grid. |
ListAccessSignalssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/signals | List the entities of the workspace, or of a selection, that one signal names, such as the tables a pipeline builds and nobody reads, or the tables nobody touched. |
ListActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-list | List the workspace’s actors, the service accounts, tools, people, logins nothing classifies and Coalesce Quality, each with the totals GetActorSummary has for it: its queries and their weights, its reads, inputs and writes, and the entities it read and wrote. |
ListEntityActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actors | Read who read and wrote each asked entity over the window: the jobs, the service accounts, the tools and the logins. |
ListPersonActivitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/person | Read what one person’s logins read and wrote over the window, per entity, direction and measure. |
BatchGetEntityAnnotationssynq.entities.annotations.v1.AnnotationsService POST /api/entities/annotations/v1/batchGet | Read the annotations carried by specific entities. |
ListAnnotationssynq.entities.annotations.v1.AnnotationsService GET /api/entities/annotations/v1 | List all available annotations with their usage counts across entities. |
BatchChangesynq.entities.changes.v1.ChangesService POST /api/changes/v1/by-id | Get multiple entity changes by their IDs in a single request. |
Listsynq.entities.changes.v1.ChangesService GET /api/changes/v1 | Retrieves the complete change history for specified entities. |
GetCoveragesynq.entities.checks.v1.ChecksCoverageService | Get the coverage of checks for a specific entity. |
BatchGetCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/batch-get | Read the categories of specific checks. |
ListCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/vocabulary | List the workspace’s category vocabulary: the category names in use on each dimension, whether a workspace or platform rule produces each one, and how many checks carry it. |
ListCategorisationFilterssynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/filters | List the attribute values the workspace’s checks actually have — the platforms, entity types, packages and kinds available to build a categorisation rule or a listing filter from. |
ListCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/list | List the workspace’s checks with their resolved categories. |
BatchGetRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/batch-get | Read specific rules by id — typically to resolve the rule_id a ResolvedCategory carries into the rule that produced it. |
GetRecategorisationStatussynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/recategorisation-status | Progress of the re-categorisation sweep a rule change schedules. |
ListRuleMatchessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/matches | Report how many checks each rule currently categorises, with a sample of them — the state already applied, not a projection. |
ListRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/list | List the rules that apply to the caller’s workspace — its own rules plus the platform-provided ones — in the order they are tried. |
PreviewRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/preview | Report what a candidate rule would change, without saving it. |
ListCodesynq.entities.code.v1.CodeService GET /api/code/v1 | List all code artifacts associated with a specific entity. |
GetTableConstraintssynq.entities.constraints.v1.TableConstraintsService GET /api/constraints/v1/table-constraints | Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity. |
BatchDatabaseCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-id | Get multiple DatabaseCoordinates for identifiers. |
BatchIdsByCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-fqn | Given database FQN return possible entity ids. |
ListCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService POST /api/entities/custom/v1/check-relationships/list | List every relationship that attaches a check to the entities it validates, across the whole workspace. |
ListEntitiessynq.entities.custom.v1.EntitiesService GET /api/entities/custom/v1/entities | List the custom entities of the workspace. |
ListEntityFeaturessynq.entities.custom.v1.FeaturesService POST /api/entities/custom/v1/features/list | List the features of one entity, or of every custom entity in the workspace when entity_id is left unset. |
ListEntityGroupssynq.entities.custom.v1.GroupsService POST /api/entities/custom/v1/groups/list | List the entity groups of the workspace, each with the ids of its entities. |
ListRelationshipssynq.entities.custom.v1.RelationshipsService POST /api/entities/custom/v1/relationships/list | List relationships touching the given entities, or every relationship in the workspace when ids is left empty. |
BatchGetEntitiessynq.entities.entities.v1.EntitiesService POST /api/entities/v1/by-id | Get multiple entities by their identifiers. |
GetEntitysynq.entities.entities.v1.EntitiesService | Get specific entity by its identifier. |
ListEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1 | List entities matching the given filter |
SearchEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1/search | Search for entities. |
BatchGetExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/by-id | Get multiple executions by their IDs. |
GetExecutionsSummarysynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/summary | Get aggregated statistics about the executions of the specified entities. |
GetLatestExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/latest | Get the most recent execution of each specified entity. |
ListExecutionssynq.entities.executions.v2.EntityExecutionsService GET /api/executions/v2/list | List the executions of one or more entities, paginated. |
Browsesynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/browseGET /api/entities/folders/v1/browse | Browse the hierarchy one level at a time. |
GetFolderOfsynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/folder-ofGET /api/entities/folders/v1/folder-of | Given entity ids, return the folder breadcrumb(s) each entity lives in — ordered root first, leaf (immediate parent) last. |
ListMemberssynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/membersGET /api/entities/folders/v1/members | List the entity ids contained in a folder, paginated. |
GetImpactsynq.entities.impact.v1.ImpactService POST /api/impact/v1 | |
BatchGetFoldNodessynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/nodes/batch-get | Read fold nodes by entity id: which fold a node in a lineage response stands for, and which entities it showed. |
BatchGetFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/batch-get | Read folds by id. |
ListFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService GET /api/lineage/folds/v1alpha | List the ids of every fold in the workspace, switched off ones included, oldest first. |
PreviewFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/preview | Show what a matcher would fold, before it is saved: how many entities and lineage edges it matches, a sample of them, and the entities that stop being shown on the same node as a folded one. |
GetLineagesynq.entities.lineage.v1.LineageService POST /api/lineage/v1 | |
BatchOrchestrationsynq.entities.orchestration.v1.OrchestrationService GET /api/orchestration/v1 | Return, for each requested entity, the jobs, job steps and tasks that ran it in the last 31 days (upstream), and the entities it ran (downstream). |
BatchGetPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/batch-get | Read logins by platform user id. |
ListLinkSuggestionssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/link-suggestions | Suggest which workspace member each unclassified login may belong to, by matching the login against the members the caller passes. |
ListPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/list | List the workspace’s logins by their share of the workspace’s queries, highest first, then by their share of its activity. |
BatchGetServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/batch-get | Read service accounts by id, built-in ids included. |
ListServiceAccountSuggestionssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/suggestions | Suggest service accounts for the logins the evidence says are not a person, each as a change set with its evidence. |
ListServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/list | List every workspace service account, then every built-in one, in the order they apply, and the person links in a second list. |
BatchResolveIdentifierssynq.entities.resolve.v1.IdentifierResolveService POST /api/resolve/v1/by-id | Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups. |
BatchSchemaMismatchessynq.entities.schemas.v1.SchemaMismatchesService POST /api/schema-mismatches/v1 | Get schema mismatches for a batch of entities by their identifiers. |
GetSchemasynq.entities.schemas.v1.SchemasService GET /api/schema/v1 | Get the schema of an entity by its identifier. |
BatchSqlDetailssynq.entities.sql_insights.v1.SqlInsightsService POST /api/sql-insights/v1/details:batch | Return the SQL details for each of the requested entities, keyed by their Coalesce Quality path: the set of detected SQL constructs and, when the request asks for them, the joins that building the entity makes. |
ListJoinPatternssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/join-patterns | List how other SQL joins a table, or one of its columns: every join key that the SQL of a table, view or model in the workspace uses to join the requested entity, read from the requested entity’s side, and which SQL makes it. |
ListSqlConstructssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/constructs | Return the distribution of SQL constructs across all entities in the workspace. |
BatchGetIncidentssynq.entities.status.v1.EntityIncidentsService POST /api/status/v1/incidents/by-id | Get the open incidents of multiple entities, and optionally of their upstream entities. |
GetIncidentssynq.entities.status.v1.EntityIncidentsService | Get the open incidents of one entity, and optionally of its upstream entities. |
BatchGetIssuesStatussynq.entities.status.v1.EntityIssuesService POST /api/status/v1/issues/by-id | Get the issues status of multiple entities, and optionally of their upstream entities. |
BatchGetTableInfosynq.entities.tableinfo.v1alpha.TableInfoService POST /api/entities/table-info/v1alpha/batch-get | Warehouse facts about tables and views: owner, creation time, row count, size, last modification and a link to the object in the warehouse console. |
GetDiffByChangeIdsynq.git.commits.v1.CommitsService GET /api/git/v1/change/{change_id} | |
GetDiffByCommitsynq.git.commits.v1.CommitsService GET /api/git/v1/commit/{commit_sha} | |
BatchGetIncidentssynq.incidents.v1.IncidentsService POST /api/incidents/v1/by-id | |
ListIncidentssynq.incidents.v1.IncidentsService GET /api/incidents/v1 | |
BatchGetIntegrationHealthsynq.integrations.v1.IntegrationsService | Return the current health of several integrations at once, without their run history: what GetIntegrationHealth returns as health, for each id. |
BatchGetIntegrationssynq.integrations.v1.IntegrationsService POST /api/integrations/v1/by-id | Fetch multiple integrations by id in one call. |
ListIntegrationssynq.integrations.v1.IntegrationsService GET /api/integrations/v1 | List all integrations in the workspace (optionally filtered by enabled state). |
BatchGetIssuessynq.issues.issues.v1.IssuesService POST /api/issues/v1/by-id | |
ListIssuessynq.issues.issues.v1.IssuesService GET /api/issues/v1 | |
BatchGetIssuessynq.issues.v2.IssuesService POST /api/issues/v2/by-id | |
ListIssuessynq.issues.v2.IssuesService GET /api/issues/v2 | |
BatchGetEntityKnowledgesynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/entities/by-id | Read the knowledge held about entities: the description people wrote for each one, and the knowledge pages pinned to it. |
BatchGetKnowledgePagessynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/pages/by-id | Read knowledge pages by id: their content, where they sit in the tree, who owns them and how they are tagged. |
ListKnowledgePageLinkssynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages/{page_id}/links | List what is pinned to a knowledge page, in either direction: the ids of the entities and of the other knowledge pages. |
ListKnowledgePagessynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages | List the ids of knowledge pages, ordered by name, optionally narrowed by a part of their name and by certification. |
GetDeployDeleteOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule/{id}/deleted | |
GetDeployOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule | |
ListDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules | |
ListDeploymentRulesForAssetsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules/{asset_path} | |
Historysynq.monitors.history.v1.HistoryService GET /api/monitors/history/v1 | |
MonitorInfosynq.monitors.info.v1.MonitorInfoService GET /api/monitors/info/v1 | |
BatchGetLatestEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService POST /api/monitors/predictions/v1/entity-metrics:batchLatest | Returns the most recent observed table-stats sample (row count, freshness) for each requested entity. |
GetEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1/entity-metrics | Returns raw metric timeseries for an entity. |
GetMonitorPredictionssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1 | Returns prediction timeseries for a monitor. |
ListMonitorSegmentssynq.monitors.segments.v1.MonitorSegmentsService GET /api/monitors/segments/v1 | Lists the segments a monitor has ingested so far, with their raw value and current label. |
BatchGetEntityOverlayssynq.overlays.v1.OverlaysService POST /api/overlays/v1/by-id | For each entity, list every overlay that claims it. |
BatchGetOverlayMemberCountssynq.overlays.v1.OverlaysService POST /api/overlays/v1/member-counts | Count the members of each named overlay. |
GetCoverageSummarysynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage-summary | Count coverage over one or more named candidate sets, without listing the assets themselves. |
ListEntityCoveragesynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage | List the candidate assets together with the overlays claiming each, and narrow them to what is or is not covered. |
BatchGetOwnerssynq.owners.v1.OwnersService POST /api/owners/v1/batch-get | Fetch multiple owners by id. |
BatchGetOwnershipssynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/batch-get | Fetch multiple ownerships by id (across owners). |
ListOwnerssynq.owners.v1.OwnersService GET /api/owners/v1 | List the owners in the workspace, paginated. |
ListOwnershipssynq.owners.v1.OwnersService GET /api/owners/v1/{owner_id}/ownerships | List the ownerships of an owner, paginated. |
ResolveQuerysynq.queries.v1.QueriesService POST /api/queries/v1/resolve | Evaluate a selection and return the matched entity ids, paginated. |
TranslateResolverQlsynq.queries.v1.QueriesService POST /api/queries/v1/translate-resolver-ql | Compile a ResolverQL expression into a structured public Query. |
BatchGetRecommendationssynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/by-id | Fetch recommendations by id. |
ListRecommendationssynq.recommendations.v1.RecommendationsService GET /api/recommendations/v1 | List the ids of the workspace’s recommendations, optionally limited by target and state. |
BatchGetsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/batch-get | Fetch multiple saved views by id. |
Listsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/list | List the saved views the calling user can see. |
SetPinsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/set-pin | Pin or unpin a saved view to the calling user’s main screen. |
GetByEmailsynq.users.v1.UsersService GET /api/users/v1/by-email | |
GetUserIdentitiessynq.users.v1.UsersService GET /api/users/v1/identities | Returns all canonical identity strings for a user. |
ListUserssynq.users.v1.UsersService GET /api/users/v1 |
MCP Write Access
SCOPE_MCP_WRITE
Use any write MCP (Model Context Protocol) tool, including tools added in the future.
| Method | Description |
|---|---|
Createsynq.alerts.services.v2.AlertsService POST /api/alerts/v2 | Create a new alert configuration. |
Deletesynq.alerts.services.v2.AlertsService DELETE /api/alerts/v2 | Delete an existing alert configuration. |
Renamesynq.alerts.services.v2.AlertsService POST /api/alerts/v2/rename | Rename an existing alert configuration. |
SendTestAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/test | Delivers a static test message to the given targets so you can confirm that delivery reaches each channel before relying on a real alert. |
ToggleEnabledsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/toggle | Enables or disables an existing alert configuration. |
ToggleIncidentOwnerAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/incident-owner | Turns the workspace’s incident-owner alert on or off. |
UpdateSettingssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/settings | Update the trigger and/or the kind-specific settings of an alert. |
UpdateTargetssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/targets | Replace the delivery targets of an existing alert configuration. |
Upsertsynq.alerts.services.v2.AlertsService PUT /api/alerts/v2 | Creates the alert when no alert holds fqn, otherwise replaces the stored alert with the state given here in a single write. |
DeleteSqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService DELETE /api/datachecks/sql-test-deployment-rules/v1/{id} | |
DeploySqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/deployed | Deploy (create or update) a SqlTestDeploymentRule and immediately sync tests onto its current match set. |
BatchCreateTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService POST /api/datachecks/testsuggestions/v1 | |
TriggerSqlTestRunAgainsynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger/sql-test-run-again | Run a SQL test again with the time placeholder values of an earlier execution. |
Deletesynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/delete | Delete a data product. |
Upsertsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2 | Create or update a data product. |
Deletesynq.domains.v2.DomainsService POST /api/domains/v2/delete | Delete a domain. |
Upsertsynq.domains.v2.DomainsService POST /api/domains/v2 | Create or update a domain. |
DeleteCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/delete | Clear the explicit categories of one or more checks, on both dimensions. |
UpsertCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories | Set the category of one or more checks explicitly. |
DeleteRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/delete | Delete a categorisation rule. |
UpsertRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules | Create or update a categorisation rule. |
ApplyServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/apply | Write a planned change set, all of it or nothing. |
PlanServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/plan | Report what a change set would change, without writing it: every login slice whose classification moves, how many counted reads each adds or removes, and the entities whose rank moves most. |
CreateIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1 | |
DeleteCommentsynq.incidents.v1.IncidentsService DELETE /api/incidents/v1/{incident_id}/comment/{comment_id} | Delete a comment on an incident. |
PostCommentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/comment | Post a comment on an incident. |
DeleteCommentsynq.issues.v2.IssuesService DELETE /api/issues/v2/{issue_id}/comment/{comment_id} | Delete a comment on an issue. |
PostCommentsynq.issues.v2.IssuesService POST /api/issues/v2/{issue_id}/comment | Post a comment on an issue. |
DeleteDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService DELETE /api/monitors/automated/v1/deployment-rule/{id} | |
DeployDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/deployed | |
BatchUpdateMonitorSegmentLabelssynq.monitors.segments.v1.MonitorSegmentsService POST /api/monitors/segments/v1/labels | Sets or clears the label of one or more segments. |
DeleteOwnersynq.owners.v1.OwnersService POST /api/owners/v1/delete | Delete an owner and all of its ownerships. |
DeleteOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/delete | Delete an ownership by id. |
UpsertOwnersynq.owners.v1.OwnersService POST /api/owners/v1 | Create or update an owner. |
UpsertOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/{owner_id}/ownerships | Create or update an ownership under an owner. |
DismissRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/dismiss | Dismiss a recommendation until something new is found about it. |
IgnoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/ignore | Ignore a recommendation for good, whatever is found about it later. |
RestoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/restore | Remove the dismissal or ignore standing against a recommendation, so it is open again. |
Deletesynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/delete | Delete a saved view. |
Upsertsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1 | Create or update a saved view. |
Read Reconciliation Audits and Settings
SCOPE_RECON_READ
View reconciliation suites, settings, and audit results.
| Method | Description |
|---|---|
GetAuditLogsynq.agent.recon.v1.AuditLogService | Get one audit log by its invocation ID. |
ListAuditLogssynq.agent.recon.v1.AuditLogService | List audit logs from newest to oldest, optionally filtered by suite and time range. |
BatchReconciliationRunStatesynq.agent.recon.v1.RunStateService | Return the latest concluded run and any ongoing (SCHEDULED or IN_PROGRESS) run for each suite_id. |
ListReconciliationRunStatesynq.agent.recon.v1.RunStateService | List reconciliation runs, filtered by status and/or suite_id. |
GetSuiteConfigsynq.agent.recon.v1.SuiteConfigService | Get the latest version of a suite config by suite_id. |
GetSuiteConfigVersionsynq.agent.recon.v1.SuiteConfigService | Get a specific historical version of a suite config. |
ListSuiteConfigVersionssynq.agent.recon.v1.SuiteConfigService | Get version history for a suite config. |
ListSuiteConfigssynq.agent.recon.v1.SuiteConfigService | List latest suite configs with filtering and pagination. |
GetSuiteDeploymentsynq.agent.recon.v1.SuiteDeploymentService | Fetch a deployment by suite_id or deployment_id. |
ListSuiteDeploymentHistorysynq.agent.recon.v1.SuiteDeploymentService | List the append-only history of a deployment (every promote, re-promote, schedule/mapping change, pause/resume, unpromote). |
ListSuiteDeploymentssynq.agent.recon.v1.SuiteDeploymentService | List deployments for the caller’s workspace. |
Edit Reconciliation Settings
SCOPE_RECON_EDIT
Create and update reconciliation suites and their settings.
| Method | Description |
|---|---|
IngestAuditLogsynq.agent.recon.v1.AuditLogService | Store the audit log of a reconciliation run. |
CancelReconciliationRunsynq.agent.recon.v1.RunStateService | Mark a SCHEDULED or IN_PROGRESS run as CANCELLED, so that a stuck run no longer occupies the suite. |
CheckSuiteInWarehousesynq.agent.recon.v1.SuiteConfigService | Check a suite against the warehouses of its connections and give all the problems that it finds. |
DeleteSuiteConfigsynq.agent.recon.v1.SuiteConfigService | Delete a managed suite config (soft delete — inserts a deleted version). |
SubmitAdhocSuitesynq.agent.recon.v1.SuiteConfigService | Submit an ad-hoc suite for one-off execution. |
UpsertSuiteConfigsynq.agent.recon.v1.SuiteConfigService | Upsert a managed suite config. |
Promote Reconciliation Suites to run on Schedule or API
SCOPE_RECON_PROMOTE
Promote reconciliation suites so they run on a schedule or via the API.
| Method | Description |
|---|---|
PauseDeploymentsynq.agent.recon.v1.SuiteDeploymentService | Pause a deployment. |
PromoteSuitesynq.agent.recon.v1.SuiteDeploymentService | Promote a suite config into production. |
ResumeDeploymentsynq.agent.recon.v1.SuiteDeploymentService | Resume a paused deployment. |
TriggerDeploymentsynq.agent.recon.v1.SuiteDeploymentService POST /api/recon/v1/deployments/trigger | Trigger an on-demand execution of a promoted deployment. |
UnpromoteSuitesynq.agent.recon.v1.SuiteDeploymentService | Unpromote a deployment. |
UpdateDeploymentAnnotationssynq.agent.recon.v1.SuiteDeploymentService | Replace the deployment-level annotation overlay on an existing deployment. |
UpdateDeploymentCaseImpactssynq.agent.recon.v1.SuiteDeploymentService | Patch the per-case ReconciliationFailureImpact map on an existing deployment without re-promoting the suite snapshot. |
UpdateDeploymentCategoriessynq.agent.recon.v1.SuiteDeploymentService | Change the categories declared for a deployment’s reconciliation checks without re-promoting the suite snapshot. |
UpdateDeploymentMappingssynq.agent.recon.v1.SuiteDeploymentService | Rewire connection → integration mappings on an existing deployment without re-promoting the config snapshot. |
UpdateDeploymentSchedulesynq.agent.recon.v1.SuiteDeploymentService | Change schedule and/or triggerable_by_api on an existing deployment without re-promoting the config snapshot or touching mappings. |
Edit Check Categorisation Rules
SCOPE_POLICIES_EDIT
Create and update rules that categorise data quality checks.
| Method | Description |
|---|---|
DeleteCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService POST /api/entities/checks/v1/categories:delete | Clear the explicit category (both dimensions) for the given checks. |
ListCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService GET /api/entities/checks/v1/categories | List every explicit check category in the caller’s workspace. |
UpsertCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService POST /api/entities/checks/v1/categories:upsert | Set (or replace) the explicit category for one or more checks. |
BatchGetCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/batch-get | Read the categories of specific checks. |
DeleteCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/delete | Clear the explicit categories of one or more checks, on both dimensions. |
ListCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/vocabulary | List the workspace’s category vocabulary: the category names in use on each dimension, whether a workspace or platform rule produces each one, and how many checks carry it. |
ListCategorisationFilterssynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/filters | List the attribute values the workspace’s checks actually have — the platforms, entity types, packages and kinds available to build a categorisation rule or a listing filter from. |
ListCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/list | List the workspace’s checks with their resolved categories. |
UpsertCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories | Set the category of one or more checks explicitly. |
BatchGetRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/batch-get | Read specific rules by id — typically to resolve the rule_id a ResolvedCategory carries into the rule that produced it. |
DeleteRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/delete | Delete a categorisation rule. |
GetRecategorisationStatussynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/recategorisation-status | Progress of the re-categorisation sweep a rule change schedules. |
ListRuleMatchessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/matches | Report how many checks each rule currently categorises, with a sample of them — the state already applied, not a projection. |
ListRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/list | List the rules that apply to the caller’s workspace — its own rules plus the platform-provided ones — in the order they are tried. |
PreviewRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/preview | Report what a candidate rule would change, without saving it. |
UpsertRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules | Create or update a categorisation rule. |
Read Check Categorisation Rules and Status
SCOPE_POLICIES_READ
View check categorisation rules and their status.
| Method | Description |
|---|---|
ListCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService GET /api/entities/checks/v1/categories | List every explicit check category in the caller’s workspace. |
BatchGetCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/batch-get | Read the categories of specific checks. |
ListCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/vocabulary | List the workspace’s category vocabulary: the category names in use on each dimension, whether a workspace or platform rule produces each one, and how many checks carry it. |
ListCategorisationFilterssynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/filters | List the attribute values the workspace’s checks actually have — the platforms, entity types, packages and kinds available to build a categorisation rule or a listing filter from. |
ListCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/list | List the workspace’s checks with their resolved categories. |
BatchGetRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/batch-get | Read specific rules by id — typically to resolve the rule_id a ResolvedCategory carries into the rule that produced it. |
GetRecategorisationStatussynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/recategorisation-status | Progress of the re-categorisation sweep a rule change schedules. |
ListRuleMatchessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/matches | Report how many checks each rule currently categorises, with a sample of them — the state already applied, not a projection. |
ListRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/list | List the rules that apply to the caller’s workspace — its own rules plus the platform-provided ones — in the order they are tried. |
PreviewRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/preview | Report what a candidate rule would change, without saving it. |
Read Saved Views
SCOPE_SAVED_VIEW_READ
View saved views the caller has access to.
| Method | Description |
|---|---|
BatchGetsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/batch-get | Fetch multiple saved views by id. |
Listsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/list | List the saved views the calling user can see. |
SetPinsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/set-pin | Pin or unpin a saved view to the calling user’s main screen. |
Create and Edit Saved Views
SCOPE_SAVED_VIEW_EDIT
Create, update, and delete the caller’s own saved views.
| Method | Description |
|---|---|
Deletesynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/delete | Delete a saved view. |
Upsertsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1 | Create or update a saved view. |
Manage All Saved Views in the Workspace
SCOPE_SAVED_VIEW_ADMIN
Manage all saved views in the workspace, including those owned by other users.
| Method | Description |
|---|---|
Deletesynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/delete | Delete a saved view. |
Upsertsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1 | Create or update a saved view. |
Read Folders
SCOPE_FOLDERS_READ
Browse the folder hierarchy and list the entities it contains.
| Method | Description |
|---|---|
Browsesynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/browseGET /api/entities/folders/v1/browse | Browse the hierarchy one level at a time. |
GetFolderOfsynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/folder-ofGET /api/entities/folders/v1/folder-of | Given entity ids, return the folder breadcrumb(s) each entity lives in — ordered root first, leaf (immediate parent) last. |
ListMemberssynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/membersGET /api/entities/folders/v1/members | List the entity ids contained in a folder, paginated. |
Edit Folders
SCOPE_FOLDERS_EDIT
Create, update, and delete folders and their placements.
No public gRPC or REST method requires this scope directly. MCP tools, for example, can use it.
Read Deliveries
SCOPE_DELIVERY_READ
Inspect notifications sent to your integrations, including the requests made and the responses received.
| Method | Description |
|---|---|
BatchGetDeliveriessynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/by-id | Fetch deliveries by id. |
GetDeliverysynq.deliveries.v1.DeliveriesService | Fetch a single delivery by id. |
ListAttemptssynq.deliveries.v1.DeliveriesService GET /api/deliveries/v1/{delivery_id}/attempts | List every attempt made for one delivery, oldest first. |
ListDeliveriessynq.deliveries.v1.DeliveriesService GET /api/deliveries/v1 | List deliveries, newest event first. |
SummariseDeliveriessynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/summarise | Count deliveries over a window, bucketed by outcome, by skip reason and by HTTP status class. |
Send and Replay Deliveries
SCOPE_DELIVERY_EDIT
Send a test notification to an integration and replay an earlier delivery.
| Method | Description |
|---|---|
Redeliversynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/{delivery_id}/redeliver | Send an earlier delivery again, to the same integration, with the same event. |
SendTestDeliverysynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/test | Send a test delivery to an integration, to confirm the endpoint is reachable and that it accepts what is sent. |
Read Recommendations
SCOPE_RECOMMENDATIONS_READ
View the changes Coalesce Quality recommends making in your workspace and the systems it connects to, and what was decided about them.
| Method | Description |
|---|---|
BatchGetRecommendationssynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/by-id | Fetch recommendations by id. |
ListRecommendationssynq.recommendations.v1.RecommendationsService GET /api/recommendations/v1 | List the ids of the workspace’s recommendations, optionally limited by target and state. |
Manage Recommendations
SCOPE_RECOMMENDATIONS_EDIT
Dismiss, ignore and restore recommendations.
| Method | Description |
|---|---|
BatchGetRecommendationssynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/by-id | Fetch recommendations by id. |
DismissRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/dismiss | Dismiss a recommendation until something new is found about it. |
IgnoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/ignore | Ignore a recommendation for good, whatever is found about it later. |
ListRecommendationssynq.recommendations.v1.RecommendationsService GET /api/recommendations/v1 | List the ids of the workspace’s recommendations, optionally limited by target and state. |
RestoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/restore | Remove the dismissal or ignore standing against a recommendation, so it is open again. |
Read Platform Users
SCOPE_PLATFORM_USERS_READ
View the logins on your connected platforms, such as warehouse users and service accounts, and what each platform states about them.
| Method | Description |
|---|---|
GetActorSummarysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-summary | Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. |
ListEntityActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actors | Read who read and wrote each asked entity over the window: the jobs, the service accounts, the tools and the logins. |
ListPersonActivitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/person | Read what one person’s logins read and wrote over the window, per entity, direction and measure. |
BatchGetPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/batch-get | Read logins by platform user id. |
ListLinkSuggestionssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/link-suggestions | Suggest which workspace member each unclassified login may belong to, by matching the login against the members the caller passes. |
ListPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/list | List the workspace’s logins by their share of the workspace’s queries, highest first, then by their share of its activity. |
Link Platform Users
SCOPE_PLATFORM_USER_LINK
Link logins on your connected platforms to workspace members, so their reads count as that member’s.
| Method | Description |
|---|---|
DeleteUserAliasessynq.users.v1.UsersService POST /api/users/v1/aliases/delete | Removes aliases from users. |
UpsertUserAliasessynq.users.v1.UsersService PUT /api/users/v1/aliases | Links aliases to users. |
Read Service Accounts
SCOPE_SERVICE_ACCOUNTS_READ
View service accounts, person links, popularity policies and suggested service accounts.
| Method | Description |
|---|---|
BatchGetServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/batch-get | Read service accounts by id, built-in ids included. |
ListServiceAccountSuggestionssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/suggestions | Suggest service accounts for the logins the evidence says are not a person, each as a change set with its evidence. |
ListServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/list | List every workspace service account, then every built-in one, in the order they apply, and the person links in a second list. |
Manage Service Accounts
SCOPE_SERVICE_ACCOUNTS_EDIT
Create and change service accounts, person links and popularity policies.
| Method | Description |
|---|---|
ApplyServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/apply | Write a planned change set, all of it or nothing. |
BatchGetServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/batch-get | Read service accounts by id, built-in ids included. |
ListServiceAccountSuggestionssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/suggestions | Suggest service accounts for the logins the evidence says are not a person, each as a change set with its evidence. |
ListServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/list | List every workspace service account, then every built-in one, in the order they apply, and the person links in a second list. |
PlanServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/plan | Report what a change set would change, without writing it: every login slice whose classification moves, how many counted reads each adds or removes, and the entities whose rank moves most. |
Endpoint reference
Every public API method that a client or token can call, and the scopes that allow it. A call needs one of the listed scopes.| Method | Scopes |
|---|---|
GenerateConnectionsYamlsynq.agent.dwh.v1.ConnectionsService | SCOPE_MCP_READSCOPE_EXTENSIONS_MANAGESCOPE_ENTITY_READ |
ListConnectionssynq.agent.dwh.v1.ConnectionsService | SCOPE_MCP_READSCOPE_EXTENSIONS_MANAGESCOPE_ENTITY_READ |
GetAuditLogsynq.agent.recon.v1.AuditLogService | SCOPE_RECON_READSCOPE_MCP_READ |
IngestAuditLogsynq.agent.recon.v1.AuditLogService | SCOPE_RECON_EDIT |
ListAuditLogssynq.agent.recon.v1.AuditLogService | SCOPE_RECON_READSCOPE_MCP_READ |
BatchReconciliationRunStatesynq.agent.recon.v1.RunStateService | SCOPE_RECON_READSCOPE_MCP_READ |
CancelReconciliationRunsynq.agent.recon.v1.RunStateService | SCOPE_RECON_EDIT |
ListReconciliationRunStatesynq.agent.recon.v1.RunStateService | SCOPE_RECON_READSCOPE_MCP_READ |
CheckSuiteInWarehousesynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_EDIT |
DeleteSuiteConfigsynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_EDIT |
GetSuiteConfigsynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_READSCOPE_MCP_READ |
GetSuiteConfigVersionsynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_READSCOPE_MCP_READ |
ListSuiteConfigVersionssynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_READSCOPE_MCP_READ |
ListSuiteConfigssynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_READSCOPE_MCP_READ |
SubmitAdhocSuitesynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_EDIT |
UpsertSuiteConfigsynq.agent.recon.v1.SuiteConfigService | SCOPE_RECON_EDIT |
GetSuiteDeploymentsynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_READSCOPE_MCP_READ |
ListSuiteDeploymentHistorysynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_READSCOPE_MCP_READ |
ListSuiteDeploymentssynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_READSCOPE_MCP_READ |
PauseDeploymentsynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
PromoteSuitesynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
ResumeDeploymentsynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
TriggerDeploymentsynq.agent.recon.v1.SuiteDeploymentService POST /api/recon/v1/deployments/trigger | SCOPE_RECON_PROMOTE |
UnpromoteSuitesynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
UpdateDeploymentAnnotationssynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
UpdateDeploymentCaseImpactssynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
UpdateDeploymentCategoriessynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
UpdateDeploymentMappingssynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
UpdateDeploymentSchedulesynq.agent.recon.v1.SuiteDeploymentService | SCOPE_RECON_PROMOTE |
ParseYamlsynq.agent.recon.v1.YamlService POST /api/agent/recon/v1/yaml/parse | — |
RenderYamlsynq.agent.recon.v1.YamlService POST /api/agent/recon/v1/yaml/render | — |
ValidateSuitesynq.agent.recon.v1.YamlService POST /api/agent/recon/v1/yaml/validate | — |
SubmitFeatureRequestsynq.agent.sre.v1.FeatureRequestService POST /api/feature-request/v1/submit | SCOPE_MCP_READSCOPE_ENTITY_READSCOPE_ISSUES_READSCOPE_INCIDENTS_READSCOPE_LINEAGE_READSCOPE_MONITORS_READSCOPE_EXECUTION_READSCOPE_CODE_READSCOPE_DATACHECKS_SQLTESTS_READSCOPE_DATACHECKS_TESTSUGGESTIONS_READ |
AcceptPromptSuggestionsynq.agent.sre.v1.SreAgentService | SCOPE_INTEGRATION_EDIT |
DismissPromptSuggestionsynq.agent.sre.v1.SreAgentService | SCOPE_INTEGRATION_EDIT |
GetConfigsynq.agent.sre.v1.SreAgentService | SCOPE_INTEGRATION_READSCOPE_MCP_READ |
ListPromptSuggestionssynq.agent.sre.v1.SreAgentService | SCOPE_INTEGRATION_READSCOPE_MCP_READ |
RecordPromptSuggestionsynq.agent.sre.v1.SreAgentService | SCOPE_INTEGRATION_EDIT |
BatchSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_READSCOPE_MCP_READ |
GetActiveSuggestionStatesForsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_READSCOPE_MCP_READ |
ListSuggestionStatessynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_READSCOPE_MCP_READ |
MarkAsCancelledsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
MarkAsCompletedsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
MarkAsFailedsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
MarkAsRunningsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
SuggestForsynq.agent.sre.v1.TestsSuggestionStateService | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
BatchLatestConclusionssynq.agent.sre.v1.TriageService GET /api/triage/v1/conclusions | SCOPE_MCP_READ |
BatchTriageStatesynq.agent.sre.v1.TriageService GET /api/triage/v1/states | SCOPE_MCP_READ |
ListTriageStatesynq.agent.sre.v1.TriageService GET /api/triage/v1/statuses | SCOPE_MCP_READ |
BatchGetsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/get | SCOPE_ALERTS_READ |
Createsynq.alerts.services.v1.AlertsService POST /api/alerts/v1 | SCOPE_ALERTS_EDIT |
Deletesynq.alerts.services.v1.AlertsService DELETE /api/alerts/v1 | SCOPE_ALERTS_EDIT |
Listsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/list | SCOPE_ALERTS_READ |
ToggleEnabledsynq.alerts.services.v1.AlertsService POST /api/alerts/v1/toggle | SCOPE_ALERTS_EDIT |
Updatesynq.alerts.services.v1.AlertsService PUT /api/alerts/v1 | SCOPE_ALERTS_EDIT |
BatchGetsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/get | SCOPE_ALERTS_READSCOPE_MCP_READ |
Createsynq.alerts.services.v2.AlertsService POST /api/alerts/v2 | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
Deletesynq.alerts.services.v2.AlertsService DELETE /api/alerts/v2 | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
GetIncidentOwnerAlertsynq.alerts.services.v2.AlertsService GET /api/alerts/v2/incident-owner | SCOPE_ALERTS_READSCOPE_MCP_READ |
Listsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/list | SCOPE_ALERTS_READSCOPE_MCP_READ |
Renamesynq.alerts.services.v2.AlertsService POST /api/alerts/v2/rename | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
SendTestAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/test | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
ToggleEnabledsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/toggle | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
ToggleIncidentOwnerAlertsynq.alerts.services.v2.AlertsService POST /api/alerts/v2/incident-owner | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
UpdateSettingssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/settings | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
UpdateTargetssynq.alerts.services.v2.AlertsService POST /api/alerts/v2/targets | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
UpdateTemplatesynq.alerts.services.v2.AlertsService POST /api/alerts/v2/template | SCOPE_ALERTS_EDIT |
Upsertsynq.alerts.services.v2.AlertsService PUT /api/alerts/v2 | SCOPE_ALERTS_EDITSCOPE_MCP_WRITE |
Iamsynq.auth.iam.v1.IamService GET /api/iam/v1 | — |
BatchDeleteSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService DELETE /api/datachecks/sql-test-deployment-rules/v1/batch | SCOPE_DATACHECKS_SQLTESTS_EDIT |
BatchDeploySqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/batch/deployed | SCOPE_DATACHECKS_SQLTESTS_EDIT |
BatchGetSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/by-id | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
DeleteSqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService DELETE /api/datachecks/sql-test-deployment-rules/v1/{id} | SCOPE_DATACHECKS_SQLTESTS_EDITSCOPE_MCP_WRITE |
DeploySqlTestDeploymentRulesynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService POST /api/datachecks/sql-test-deployment-rules/v1/deployed | SCOPE_DATACHECKS_SQLTESTS_EDITSCOPE_MCP_WRITE |
GetSqlTestDeployDeleteOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/{id}/deleted | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
GetSqlTestDeployOverviewsynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1/overview | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
ListSqlTestDeploymentRulessynq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService GET /api/datachecks/sql-test-deployment-rules/v1 | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
BatchDeleteSqlTestssynq.datachecks.sqltests.v1.SqlTestsService DELETE /api/datachecks/sqltests/v1 | SCOPE_DATACHECKS_SQLTESTS_EDIT |
BatchGetSqlTestssynq.datachecks.sqltests.v1.SqlTestsService POST /api/datachecks/sqltests/v1/by-id | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
BatchUpsertSqlTestssynq.datachecks.sqltests.v1.SqlTestsService POST /api/datachecks/sqltests/v1 | SCOPE_DATACHECKS_SQLTESTS_EDIT |
GetSqlTestAuditsynq.datachecks.sqltests.v1.SqlTestsService | SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ |
ListSqlTestssynq.datachecks.sqltests.v1.SqlTestsService GET /api/datachecks/sqltests/v1 | SCOPE_DATACHECKS_SQLTESTS_READSCOPE_MCP_READ |
BatchAcceptTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService PATCH /api/datachecks/testsuggestions/v1/accepted | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
BatchCreateTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService POST /api/datachecks/testsuggestions/v1 | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDITSCOPE_MCP_WRITE |
BatchGetTestSuggestionsForEntitiessynq.datachecks.testsuggestions.v1.TestSuggestionsService GET /api/datachecks/testsuggestions/v1 | SCOPE_DATACHECKS_TESTSUGGESTIONS_READSCOPE_MCP_READ |
BatchRejectTestSuggestionssynq.datachecks.testsuggestions.v1.TestSuggestionsService PATCH /api/datachecks/testsuggestions/v1/rejected | SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT |
TriggerDatacheckssynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger | SCOPE_DATACHECKS_TRIGGER |
TriggerSqlTestRunAgainsynq.datachecks.v1.TriggerService POST /api/datachecks/scheduler/v1/trigger/sql-test-run-again | SCOPE_DATACHECKS_TRIGGERSCOPE_DATACHECKS_SQLTESTS_EDITSCOPE_MCP_WRITE |
Deletesynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/delete | SCOPE_DATAPRODUCT_EDIT |
Getsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/get | SCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
Listsynq.dataproducts.v1.DataproductsService GET /api/dataproducts/v1 | SCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
RemoveDefinitionPartsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition/part/delete | SCOPE_DATAPRODUCT_EDIT |
SetDefinitionsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition | SCOPE_DATAPRODUCT_EDIT |
Upsertsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1 | SCOPE_DATAPRODUCT_EDIT |
UpsertDefinitionPartsynq.dataproducts.v1.DataproductsService POST /api/dataproducts/v1/definition/part | SCOPE_DATAPRODUCT_EDIT |
BatchGetsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/batch-get | SCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
Deletesynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/delete | SCOPE_DATAPRODUCT_EDITSCOPE_MCP_WRITE |
Listsynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2 | SCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
ListMemberssynq.dataproducts.v2.DataproductsService GET /api/dataproducts/v2/{id}/members | SCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
RemoveDefinitionPartsynq.dataproducts.v2.DataproductsService DELETE /api/dataproducts/v2/{id}/definition/parts/{part_id} | SCOPE_DATAPRODUCT_EDIT |
SetDefinitionsynq.dataproducts.v2.DataproductsService PUT /api/dataproducts/v2/{id}/definition | SCOPE_DATAPRODUCT_EDIT |
Upsertsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2 | SCOPE_DATAPRODUCT_EDITSCOPE_MCP_WRITE |
UpsertDefinitionPartsynq.dataproducts.v2.DataproductsService POST /api/dataproducts/v2/{id}/definition/parts | SCOPE_DATAPRODUCT_EDIT |
BatchGetDeliveriessynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/by-id | SCOPE_DELIVERY_READ |
GetDeliverysynq.deliveries.v1.DeliveriesService | SCOPE_DELIVERY_READ |
ListAttemptssynq.deliveries.v1.DeliveriesService GET /api/deliveries/v1/{delivery_id}/attempts | SCOPE_DELIVERY_READ |
ListDeliveriessynq.deliveries.v1.DeliveriesService GET /api/deliveries/v1 | SCOPE_DELIVERY_READ |
Redeliversynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/{delivery_id}/redeliver | SCOPE_DELIVERY_EDIT |
SendTestDeliverysynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/test | SCOPE_DELIVERY_EDIT |
SummariseDeliveriessynq.deliveries.v1.DeliveriesService POST /api/deliveries/v1/summarise | SCOPE_DELIVERY_READ |
AddDomainMemberssynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/members | SCOPE_USER_ASSIGN |
ListDomainMemberssynq.domains.members.v1.DomainMembersService GET /api/domains/members/v1/{domain_id}/members | SCOPE_USER_READ |
ListUserDomainssynq.domains.members.v1.DomainMembersService GET /api/domains/members/v1/users/{user_id}/domains | SCOPE_USER_READ |
RemoveDomainMemberssynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/members/remove | SCOPE_USER_ASSIGN |
SetDefaultUserDomainsynq.domains.members.v1.DomainMembersService POST /api/domains/members/v1/{domain_id}/default-for-user | SCOPE_USER_READ |
BatchGetsynq.domains.v1.DomainsService POST /api/domains/v1/batch-get | SCOPE_DOMAIN_READ |
Deletesynq.domains.v1.DomainsService POST /api/domains/v1/delete | SCOPE_DOMAIN_EDIT |
FetchDomainWithSubDomainssynq.domains.v1.DomainsService GET /api/domains/v1/{domain_id}/sub-domains | SCOPE_DOMAIN_READ |
GetUsagesynq.domains.v1.DomainsService GET /api/domains/v1/usage | SCOPE_USAGE_GET |
Listsynq.domains.v1.DomainsService GET /api/domains/v1 | SCOPE_DOMAIN_READ |
RemoveDefinitionPartsynq.domains.v1.DomainsService DELETE /api/domains/v1/{domain_id}/definition/parts/{part_id} | SCOPE_DOMAIN_EDIT |
SetDefinitionsynq.domains.v1.DomainsService PUT /api/domains/v1/{domain_id}/definition | SCOPE_DOMAIN_EDIT |
Upsertsynq.domains.v1.DomainsService POST /api/domains/v1 | SCOPE_DOMAIN_EDIT |
UpsertDefinitionPartsynq.domains.v1.DomainsService POST /api/domains/v1/{domain_id}/definition/parts | SCOPE_DOMAIN_EDIT |
BatchGetsynq.domains.v2.DomainsService POST /api/domains/v2/batch-get | SCOPE_DOMAIN_READSCOPE_MCP_READ |
Deletesynq.domains.v2.DomainsService POST /api/domains/v2/delete | SCOPE_DOMAIN_EDITSCOPE_MCP_WRITE |
FetchDomainWithSubDomainssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/sub-domains | SCOPE_DOMAIN_READSCOPE_MCP_READ |
GetUsagesynq.domains.v2.DomainsService GET /api/domains/v2/usage | SCOPE_USAGE_GET |
Listsynq.domains.v2.DomainsService GET /api/domains/v2 | SCOPE_DOMAIN_READSCOPE_MCP_READ |
ListMemberssynq.domains.v2.DomainsService GET /api/domains/v2/{id}/members | SCOPE_DOMAIN_READSCOPE_MCP_READ |
RemoveDefinitionPartsynq.domains.v2.DomainsService DELETE /api/domains/v2/{id}/definition/parts/{part_id} | SCOPE_DOMAIN_EDIT |
SetDefinitionsynq.domains.v2.DomainsService PUT /api/domains/v2/{id}/definition | SCOPE_DOMAIN_EDIT |
Upsertsynq.domains.v2.DomainsService POST /api/domains/v2 | SCOPE_DOMAIN_EDITSCOPE_MCP_WRITE |
UpsertDefinitionPartsynq.domains.v2.DomainsService POST /api/domains/v2/{id}/definition/parts | SCOPE_DOMAIN_EDIT |
BatchGetEntityUsagesynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/usage | SCOPE_ENTITY_READSCOPE_LINEAGE_READSCOPE_MCP_READ |
BatchGetPopularitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/popularity | SCOPE_ENTITY_READSCOPE_MCP_READ |
GetActivityOverviewsynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/overview | SCOPE_ENTITY_READSCOPE_MCP_READ |
GetActorSummarysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-summary | SCOPE_PLATFORM_USERS_READSCOPE_LINEAGE_READSCOPE_MCP_READ |
GetEntityActivitySeriessynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/series | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListAccessSignalssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/signals | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actor-list | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListEntityActorssynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/actors | SCOPE_PLATFORM_USERS_READSCOPE_LINEAGE_READSCOPE_MCP_READ |
ListPersonActivitysynq.entities.activity.v1alpha.ActivityService POST /api/entities/activity/v1alpha/person | SCOPE_PLATFORM_USERS_READSCOPE_MCP_READ |
BatchGetEntityAnnotationssynq.entities.annotations.v1.AnnotationsService POST /api/entities/annotations/v1/batchGet | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListAnnotationssynq.entities.annotations.v1.AnnotationsService GET /api/entities/annotations/v1 | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchChangesynq.entities.changes.v1.ChangesService POST /api/changes/v1/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
Listsynq.entities.changes.v1.ChangesService GET /api/changes/v1 | SCOPE_ENTITY_READSCOPE_MCP_READ |
DeleteCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService POST /api/entities/checks/v1/categories:delete | SCOPE_POLICIES_EDIT |
ListCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService GET /api/entities/checks/v1/categories | SCOPE_POLICIES_READSCOPE_POLICIES_EDIT |
UpsertCheckCategoriessynq.entities.checks.v1.ChecksCategoriesService POST /api/entities/checks/v1/categories:upsert | SCOPE_POLICIES_EDIT |
GetCoveragesynq.entities.checks.v1.ChecksCoverageService | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchGetCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/batch-get | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
DeleteCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/delete | SCOPE_POLICIES_EDITSCOPE_MCP_WRITE |
ListCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/vocabulary | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
ListCategorisationFilterssynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/filters | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
ListCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories/list | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
UpsertCheckCategoriessynq.entities.checks.v2.ChecksCategoriesService POST /api/entities/v2/checks/categories | SCOPE_POLICIES_EDITSCOPE_MCP_WRITE |
BatchGetRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/batch-get | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
DeleteRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/delete | SCOPE_POLICIES_EDITSCOPE_MCP_WRITE |
GetRecategorisationStatussynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/recategorisation-status | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
ListRuleMatchessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/matches | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
ListRulessynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/list | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
PreviewRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules/preview | SCOPE_POLICIES_READSCOPE_POLICIES_EDITSCOPE_MCP_READ |
UpsertRulesynq.entities.checks.v2.ChecksCategorisationRulesService POST /api/entities/v2/checks/categorisation-rules | SCOPE_POLICIES_EDITSCOPE_MCP_WRITE |
ListCodesynq.entities.code.v1.CodeService GET /api/code/v1 | SCOPE_CODE_READSCOPE_MCP_READ |
GetTableConstraintssynq.entities.constraints.v1.TableConstraintsService GET /api/constraints/v1/table-constraints | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchDatabaseCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchIdsByCoordinatessynq.entities.coordinates.v1.DatabaseCoordinatesService POST /api/coordinates/v1/database/by-fqn | SCOPE_ENTITY_READSCOPE_MCP_READ |
DeleteCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService DELETE /api/entities/custom/v1/check-relationships | SCOPE_ENTITY_EDIT |
ListCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService POST /api/entities/custom/v1/check-relationships/list | SCOPE_ENTITY_READSCOPE_MCP_READ |
UpsertCheckRelationshipssynq.entities.custom.v1.ChecksRelationshipsService POST /api/entities/custom/v1/check-relationships | SCOPE_ENTITY_EDIT |
DeleteEntitysynq.entities.custom.v1.EntitiesService DELETE /api/entities/custom/v1/entities | SCOPE_ENTITY_EDIT |
ListEntitiessynq.entities.custom.v1.EntitiesService GET /api/entities/custom/v1/entities | SCOPE_ENTITY_READSCOPE_MCP_READ |
UpsertEntitysynq.entities.custom.v1.EntitiesService POST /api/entities/custom/v1/entities | SCOPE_ENTITY_EDIT |
UpsertExecutionsynq.entities.custom.v1.EntityExecutionsService POST /api/entities/custom/executions/v1 | SCOPE_EXECUTION_EDIT |
UpsertLogEntrysynq.entities.custom.v1.EntityExecutionsService POST /api/entities/custom/executions/v1/log-entry | SCOPE_EXECUTION_EDITSCOPE_EXECUTION_LOG_EDIT |
DeleteEntityFeaturesynq.entities.custom.v1.FeaturesService DELETE /api/entities/custom/v1/features | SCOPE_ENTITY_EDIT |
ListEntityFeaturessynq.entities.custom.v1.FeaturesService POST /api/entities/custom/v1/features/list | SCOPE_ENTITY_READSCOPE_MCP_READ |
UpsertEntityFeaturesynq.entities.custom.v1.FeaturesService POST /api/entities/custom/v1/features | SCOPE_ENTITY_EDIT |
DeleteEntitiesGroupsynq.entities.custom.v1.GroupsService DELETE /api/entities/custom/v1/groups | SCOPE_ENTITY_EDIT |
ListEntityGroupssynq.entities.custom.v1.GroupsService POST /api/entities/custom/v1/groups/list | SCOPE_ENTITY_READSCOPE_MCP_READ |
UpsertEntitiesGroupsynq.entities.custom.v1.GroupsService POST /api/entities/custom/v1/groups | SCOPE_ENTITY_EDIT |
DeleteRelationshipssynq.entities.custom.v1.RelationshipsService DELETE /api/entities/custom/v1/relationships | SCOPE_LINEAGE_EDIT |
ListRelationshipssynq.entities.custom.v1.RelationshipsService POST /api/entities/custom/v1/relationships/list | SCOPE_LINEAGE_READSCOPE_MCP_READ |
UpsertRelationshipssynq.entities.custom.v1.RelationshipsService POST /api/entities/custom/v1/relationships | SCOPE_LINEAGE_EDIT |
DeleteTypesynq.entities.custom.v1.TypesService DELETE /api/entities/custom/v1/types | SCOPE_ENTITY_TYPE_EDIT |
ListTypessynq.entities.custom.v1.TypesService POST /api/entities/custom/v1/types/list | SCOPE_ENTITY_READSCOPE_ENTITY_TYPE_READ |
UpsertTypesynq.entities.custom.v1.TypesService POST /api/entities/custom/v1/types | SCOPE_ENTITY_TYPE_EDIT |
BatchGetEntitiessynq.entities.entities.v1.EntitiesService POST /api/entities/v1/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
GetEntitysynq.entities.entities.v1.EntitiesService | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1 | SCOPE_ENTITY_READSCOPE_MCP_READ |
SearchEntitiessynq.entities.entities.v1.EntitiesService GET /api/entities/v1/search | SCOPE_ENTITY_READSCOPE_MCP_READ |
UpsertExecutionsynq.entities.executions.v1.EntityExecutionsService POST /api/executions/v1 | SCOPE_EXECUTION_EDIT |
UpsertLogEntrysynq.entities.executions.v1.EntityExecutionsService POST /api/executions/v1/log-entry | SCOPE_EXECUTION_EDITSCOPE_EXECUTION_LOG_EDIT |
BatchGetExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/by-id | SCOPE_EXECUTION_READSCOPE_MCP_READ |
GetExecutionsSummarysynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/summary | SCOPE_EXECUTION_READSCOPE_MCP_READ |
GetLatestExecutionssynq.entities.executions.v2.EntityExecutionsService POST /api/executions/v2/latest | SCOPE_EXECUTION_READSCOPE_MCP_READ |
ListExecutionssynq.entities.executions.v2.EntityExecutionsService GET /api/executions/v2/list | SCOPE_EXECUTION_READSCOPE_MCP_READ |
Browsesynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/browseGET /api/entities/folders/v1/browse | SCOPE_FOLDERS_READSCOPE_ENTITY_READSCOPE_MCP_READ |
GetFolderOfsynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/folder-ofGET /api/entities/folders/v1/folder-of | SCOPE_FOLDERS_READSCOPE_ENTITY_READSCOPE_MCP_READ |
ListMemberssynq.entities.folders.v1.FoldersService POST /api/entities/folders/v1/membersGET /api/entities/folders/v1/members | SCOPE_FOLDERS_READSCOPE_ENTITY_READSCOPE_MCP_READ |
GetImpactsynq.entities.impact.v1.ImpactService POST /api/impact/v1 | SCOPE_ENTITY_READSCOPE_LINEAGE_READSCOPE_MCP_READ |
BatchGetFoldNodessynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/nodes/batch-get | SCOPE_LINEAGE_READSCOPE_MCP_READ |
BatchGetFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/batch-get | SCOPE_LINEAGE_READSCOPE_MCP_READ |
CreateFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha | SCOPE_LINEAGE_EDIT |
DeleteFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/delete | SCOPE_LINEAGE_EDIT |
ListFoldssynq.entities.lineage.folds.v1alpha.LineageFoldsService GET /api/lineage/folds/v1alpha | SCOPE_LINEAGE_READSCOPE_MCP_READ |
PreviewFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/preview | SCOPE_LINEAGE_READSCOPE_MCP_READ |
RenameFoldsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/rename | SCOPE_LINEAGE_EDIT |
SetFoldEnabledsynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/enabled | SCOPE_LINEAGE_EDIT |
UpdateFoldMatchersynq.entities.lineage.folds.v1alpha.LineageFoldsService POST /api/lineage/folds/v1alpha/{id}/matcher | SCOPE_LINEAGE_EDIT |
GetLineagesynq.entities.lineage.v1.LineageService POST /api/lineage/v1 | SCOPE_LINEAGE_READSCOPE_MCP_READ |
BatchOrchestrationsynq.entities.orchestration.v1.OrchestrationService GET /api/orchestration/v1 | SCOPE_LINEAGE_READSCOPE_MCP_READ |
BatchGetPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/batch-get | SCOPE_PLATFORM_USERS_READSCOPE_MCP_READ |
ListLinkSuggestionssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/link-suggestions | SCOPE_PLATFORM_USERS_READSCOPE_MCP_READ |
ListPlatformUserssynq.entities.platformusers.v1alpha.PlatformUsersService POST /api/entities/platform-users/v1alpha/list | SCOPE_PLATFORM_USERS_READSCOPE_MCP_READ |
ApplyServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/apply | SCOPE_SERVICE_ACCOUNTS_EDITSCOPE_MCP_WRITE |
BatchGetServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/batch-get | SCOPE_SERVICE_ACCOUNTS_READSCOPE_SERVICE_ACCOUNTS_EDITSCOPE_MCP_READ |
ListServiceAccountSuggestionssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/suggestions | SCOPE_SERVICE_ACCOUNTS_READSCOPE_SERVICE_ACCOUNTS_EDITSCOPE_MCP_READ |
ListServiceAccountssynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/list | SCOPE_SERVICE_ACCOUNTS_READSCOPE_SERVICE_ACCOUNTS_EDITSCOPE_MCP_READ |
PlanServiceAccountChangessynq.entities.platformusers.v1alpha.ServiceAccountsService POST /api/entities/service-accounts/v1alpha/plan | SCOPE_SERVICE_ACCOUNTS_EDITSCOPE_MCP_WRITE |
BatchResolveIdentifierssynq.entities.resolve.v1.IdentifierResolveService POST /api/resolve/v1/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchSchemaMismatchessynq.entities.schemas.v1.SchemaMismatchesService POST /api/schema-mismatches/v1 | SCOPE_ENTITY_READSCOPE_MCP_READ |
GetSchemasynq.entities.schemas.v1.SchemasService GET /api/schema/v1 | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchSqlDetailssynq.entities.sql_insights.v1.SqlInsightsService POST /api/sql-insights/v1/details:batch | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListJoinPatternssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/join-patterns | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListSqlConstructssynq.entities.sql_insights.v1.SqlInsightsService GET /api/sql-insights/v1/constructs | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchGetIncidentssynq.entities.status.v1.EntityIncidentsService POST /api/status/v1/incidents/by-id | SCOPE_STATUS_READSCOPE_MCP_READ |
GetIncidentssynq.entities.status.v1.EntityIncidentsService | SCOPE_STATUS_READSCOPE_MCP_READ |
BatchGetIssuesStatussynq.entities.status.v1.EntityIssuesService POST /api/status/v1/issues/by-id | SCOPE_STATUS_READSCOPE_MCP_READ |
GetIssuesStatussynq.entities.status.v1.EntityIssuesService | SCOPE_STATUS_READ |
BatchGetTableInfosynq.entities.tableinfo.v1alpha.TableInfoService POST /api/entities/table-info/v1alpha/batch-get | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListEntityTraitDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-traits/list | SCOPE_ENTITY_READSCOPE_ENTITY_TYPE_READ |
ListEntityTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/entity-types/list | SCOPE_ENTITY_READSCOPE_ENTITY_TYPE_READ |
ListExecutionTypeDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/execution-types/list | SCOPE_ENTITY_READSCOPE_ENTITY_TYPE_READ |
ListPlatformDefssynq.entities.typedefs.v1.TypeDefsService POST /api/entities/typedefs/v1/platforms/list | SCOPE_ENTITY_READSCOPE_ENTITY_TYPE_READ |
Activatesynq.extensions.atlan.integrations.v1.AtlanIntegrationService PATCH /api/extensions/atlan/integrations/v1 | SCOPE_EXTENSIONS_MANAGE |
Getsynq.extensions.atlan.integrations.v1.AtlanIntegrationService GET /api/extensions/atlan/integrations/v1 | SCOPE_INTEGRATION_READ |
Pingsynq.extensions.atlan.integrations.v1.AtlanIntegrationService POST /api/extensions/atlan/integrations/v1/ping | SCOPE_EXTENSIONS_MANAGE |
Removesynq.extensions.atlan.integrations.v1.AtlanIntegrationService DELETE /api/extensions/atlan/integrations/v1 | SCOPE_EXTENSIONS_MANAGE |
Upsertsynq.extensions.atlan.integrations.v1.AtlanIntegrationService POST /api/extensions/atlan/integrations/v1 | SCOPE_EXTENSIONS_MANAGE |
GetAtlanConnectionssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/connections | SCOPE_EXTENSIONS_MANAGE |
GetAtlanDataProductssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/data-products | SCOPE_EXTENSIONS_MANAGE |
GetAtlanDomainssynq.extensions.atlan.provider.v1.AtlanProviderService GET /api/extensions/atlan/provider/v1/domains | SCOPE_EXTENSIONS_MANAGE |
FetchRunssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/runs | SCOPE_EXTENSIONS_MANAGE |
GetConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/connection-mappings | SCOPE_EXTENSIONS_MANAGE |
GetDomainMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/domain-mappings | SCOPE_EXTENSIONS_MANAGE |
GetMappingTogglessynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/mappings/toggle | SCOPE_EXTENSIONS_MANAGE |
GetProductMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService GET /api/extensions/atlan/workflows/v1/product-mappings | SCOPE_EXTENSIONS_MANAGE |
RemoveConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService DELETE /api/extensions/atlan/workflows/v1/connection-mappings | SCOPE_EXTENSIONS_MANAGE |
SetConnectionMappingssynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/connection-mappings | SCOPE_EXTENSIONS_MANAGE |
SetMappingTogglessynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/mappings/toggle | SCOPE_EXTENSIONS_MANAGE |
Synchronizesynq.extensions.atlan.workflows.v1.AtlanWorkflowService POST /api/extensions/atlan/workflows/v1/synchronize | SCOPE_EXTENSIONS_MANAGE |
GetDiffByChangeIdsynq.git.commits.v1.CommitsService GET /api/git/v1/change/{change_id} | SCOPE_CODE_READSCOPE_MCP_READ |
GetDiffByCommitsynq.git.commits.v1.CommitsService GET /api/git/v1/commit/{commit_sha} | SCOPE_ENTITY_READSCOPE_MCP_READ |
AddIssuesToIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/issues | SCOPE_INCIDENTS_EDIT |
AssignIncidentOwnersynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/assign-owner | SCOPE_INCIDENTS_EDIT |
BatchGetIncidentssynq.incidents.v1.IncidentsService POST /api/incidents/v1/by-id | SCOPE_INCIDENTS_READSCOPE_MCP_READ |
CancelIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/cancel | SCOPE_INCIDENTS_EDIT |
CloseIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/close | SCOPE_INCIDENTS_EDIT |
CreateIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1 | SCOPE_INCIDENTS_EDITSCOPE_MCP_WRITE |
DeleteCommentsynq.incidents.v1.IncidentsService DELETE /api/incidents/v1/{incident_id}/comment/{comment_id} | SCOPE_INCIDENTS_EDITSCOPE_MCP_WRITE |
ListIncidentssynq.incidents.v1.IncidentsService GET /api/incidents/v1 | SCOPE_INCIDENTS_READSCOPE_MCP_READ |
MergeIncidentssynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/merge | SCOPE_INCIDENTS_EDIT |
PostCommentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/comment | SCOPE_INCIDENTS_EDITSCOPE_MCP_WRITE |
RemoveIssuesFromIncidentsynq.incidents.v1.IncidentsService DELETE /api/incidents/v1/{incident_id}/issues | SCOPE_INCIDENTS_EDIT |
RenameIncidentsynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/rename | SCOPE_INCIDENTS_EDIT |
SplitIncidentsynq.incidents.v1.IncidentsService POST /api/incidents/v1/{incident_id}/split | SCOPE_INCIDENTS_EDIT |
UpdateIncidentStatesynq.incidents.v1.IncidentsService PATCH /api/incidents/v1/{incident_id}/state | SCOPE_INCIDENTS_EDIT |
BatchGetIntegrationHealthsynq.integrations.v1.IntegrationsService | SCOPE_INTEGRATION_READSCOPE_INTEGRATION_EDITSCOPE_MCP_READ |
BatchGetIntegrationssynq.integrations.v1.IntegrationsService POST /api/integrations/v1/by-id | SCOPE_INTEGRATION_READSCOPE_INTEGRATION_EDITSCOPE_MCP_READ |
CreateIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1 | SCOPE_INTEGRATION_EDIT |
DeleteIntegrationsynq.integrations.v1.IntegrationsService DELETE /api/integrations/v1/{integration_id} | SCOPE_INTEGRATION_EDIT |
DisableIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/disable | SCOPE_INTEGRATION_EDIT |
EnableIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/enable | SCOPE_INTEGRATION_EDIT |
GetIntegrationsynq.integrations.v1.IntegrationsService | SCOPE_INTEGRATION_READSCOPE_INTEGRATION_EDIT |
GetIntegrationHealthsynq.integrations.v1.IntegrationsService | SCOPE_INTEGRATION_READSCOPE_INTEGRATION_EDIT |
ListIntegrationssynq.integrations.v1.IntegrationsService GET /api/integrations/v1 | SCOPE_INTEGRATION_READSCOPE_INTEGRATION_EDITSCOPE_MCP_READ |
RefreshIntegrationsynq.integrations.v1.IntegrationsService POST /api/integrations/v1/{integration_id}/refresh | SCOPE_INTEGRATION_EDIT |
UpdateIntegrationsynq.integrations.v1.IntegrationsService PUT /api/integrations/v1/{integration_id} | SCOPE_INTEGRATION_EDIT |
BatchGetIssuessynq.issues.issues.v1.IssuesService POST /api/issues/v1/by-id | SCOPE_ISSUES_READSCOPE_MCP_READ |
ListIssuessynq.issues.issues.v1.IssuesService GET /api/issues/v1 | SCOPE_ISSUES_READSCOPE_MCP_READ |
MarkExpectedsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-expected | SCOPE_ISSUES_EDIT |
MarkFixedsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-fixed | SCOPE_ISSUES_EDIT |
MarkInvestigatingsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-investigating | SCOPE_ISSUES_EDIT |
MarkNoActionNeededsynq.issues.issues.v1.IssuesService PATCH /api/issues/v1/{issue_id}/mark-no-action-needed | SCOPE_ISSUES_EDIT |
PostCommentsynq.issues.issues.v1.IssuesService POST /api/issues/v1/{issue_id}/comment | SCOPE_ISSUES_EDIT |
BatchGetIssuessynq.issues.v2.IssuesService POST /api/issues/v2/by-id | SCOPE_ISSUES_READSCOPE_MCP_READ |
ClearStatussynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/clear-status | SCOPE_ISSUES_EDIT |
DeleteCommentsynq.issues.v2.IssuesService DELETE /api/issues/v2/{issue_id}/comment/{comment_id} | SCOPE_ISSUES_EDITSCOPE_MCP_WRITE |
ListIssuessynq.issues.v2.IssuesService GET /api/issues/v2 | SCOPE_ISSUES_READSCOPE_MCP_READ |
MarkExpectedsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-expected | SCOPE_ISSUES_EDIT |
MarkFixedsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-fixed | SCOPE_ISSUES_EDIT |
MarkInvestigatingsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-investigating | SCOPE_ISSUES_EDIT |
MarkNoActionNeededsynq.issues.v2.IssuesService PATCH /api/issues/v2/{issue_id}/mark-no-action-needed | SCOPE_ISSUES_EDIT |
PostCommentsynq.issues.v2.IssuesService POST /api/issues/v2/{issue_id}/comment | SCOPE_ISSUES_EDITSCOPE_MCP_WRITE |
BatchGetEntityKnowledgesynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/entities/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchGetKnowledgePagessynq.knowledge.v1alpha.KnowledgeService POST /api/knowledge/v1alpha/pages/by-id | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListKnowledgePageLinkssynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages/{page_id}/links | SCOPE_ENTITY_READSCOPE_MCP_READ |
ListKnowledgePagessynq.knowledge.v1alpha.KnowledgeService GET /api/knowledge/v1alpha/pages | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchDeleteDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService DELETE /api/monitors/automated/v1/deployment-rules/batch | SCOPE_MONITORS_AUTOMATIC_EDIT |
BatchDeployDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/batch/deployed | SCOPE_MONITORS_AUTOMATIC_EDIT |
BatchGetDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules/batch | SCOPE_MONITORS_AUTOMATIC_EDIT |
BatchUpdateDeploymentRuleTitlesynq.monitors.automated_monitors.v1.DeploymentRulesService PATCH /api/monitors/automated/v1/deployment-rules | SCOPE_MONITORS_AUTOMATIC_EDIT |
BatchUpsertDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/batch | SCOPE_MONITORS_AUTOMATIC_EDIT |
DeleteDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService DELETE /api/monitors/automated/v1/deployment-rule/{id} | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_WRITE |
DeployDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules/deployed | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_WRITE |
GetDeployDeleteOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule/{id}/deleted | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_READ |
GetDeployOverviewsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rule | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_READ |
ListDeploymentRulessynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_READ |
ListDeploymentRulesForAssetsynq.monitors.automated_monitors.v1.DeploymentRulesService GET /api/monitors/automated/v1/deployment-rules/{asset_path} | SCOPE_MONITORS_AUTOMATIC_EDITSCOPE_MCP_READ |
UpsertDeploymentRulesynq.monitors.automated_monitors.v1.DeploymentRulesService POST /api/monitors/automated/v1/deployment-rules | SCOPE_MONITORS_AUTOMATIC_EDIT |
BatchCreateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1 | SCOPE_MONITORS_CUSTOM_EDITSCOPE_MONITORS_CUSTOM_SQL_EDIT |
BatchDeleteMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/delete | SCOPE_MONITORS_CUSTOM_EDIT |
BatchUpdateMonitorsynq.monitors.custom_monitors.v1.CustomMonitorsService PUT /api/monitors/custom-monitors/v1 | SCOPE_MONITORS_CUSTOM_EDITSCOPE_MONITORS_CUSTOM_SQL_EDIT |
BatchUpdateMonitorModesynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/mode | SCOPE_MONITORS_CUSTOM_EDIT |
BatchUpdateMonitorSeveritysynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/severity | SCOPE_MONITORS_CUSTOM_EDIT |
ConfigChangesOverviewsynq.monitors.custom_monitors.v1.CustomMonitorsService POST /api/monitors/custom-monitors/v1/config-changes | SCOPE_MONITORS_CUSTOM_EDIT |
ListConfigsMonitorssynq.monitors.custom_monitors.v1.CustomMonitorsService GET /api/monitors/custom-monitors/v1/by-config | SCOPE_MONITORS_READ |
ListMonitorssynq.monitors.custom_monitors.v1.CustomMonitorsService GET /api/monitors/custom-monitors/v1 | SCOPE_MONITORS_READ |
Historysynq.monitors.history.v1.HistoryService GET /api/monitors/history/v1 | SCOPE_MONITORS_READSCOPE_MCP_READ |
MonitorInfosynq.monitors.info.v1.MonitorInfoService GET /api/monitors/info/v1 | SCOPE_MONITORS_READSCOPE_MCP_READ |
BatchGetLatestEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService POST /api/monitors/predictions/v1/entity-metrics:batchLatest | SCOPE_MONITORS_READSCOPE_ENTITY_READSCOPE_MCP_READ |
GetEntityMetricssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1/entity-metrics | SCOPE_MONITORS_READSCOPE_ENTITY_READSCOPE_MCP_READ |
GetMonitorPredictionssynq.monitors.predictions.v1.MonitorPredictionsService GET /api/monitors/predictions/v1 | SCOPE_MONITORS_READSCOPE_MCP_READ |
BatchUpdateMonitorSegmentLabelssynq.monitors.segments.v1.MonitorSegmentsService POST /api/monitors/segments/v1/labels | SCOPE_MONITORS_CUSTOM_EDITSCOPE_MCP_WRITE |
ListMonitorSegmentssynq.monitors.segments.v1.MonitorSegmentsService GET /api/monitors/segments/v1 | SCOPE_MONITORS_READSCOPE_MCP_READ |
BatchGetEntityOverlayssynq.overlays.v1.OverlaysService POST /api/overlays/v1/by-id | SCOPE_OWNERS_READSCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
BatchGetOverlayMemberCountssynq.overlays.v1.OverlaysService POST /api/overlays/v1/member-counts | SCOPE_OWNERS_READSCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
GetCoverageSummarysynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage-summary | SCOPE_OWNERS_READSCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
ListEntityCoveragesynq.overlays.v1.OverlaysService POST /api/overlays/v1/coverage | SCOPE_OWNERS_READSCOPE_DATAPRODUCT_READSCOPE_MCP_READ |
BatchGetOwnerssynq.owners.v1.OwnersService POST /api/owners/v1/batch-get | SCOPE_OWNERS_READSCOPE_MCP_READ |
BatchGetOwnershipssynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/batch-get | SCOPE_OWNERSHIP_READSCOPE_MCP_READ |
DeleteOwnersynq.owners.v1.OwnersService POST /api/owners/v1/delete | SCOPE_OWNERS_EDITSCOPE_MCP_WRITE |
DeleteOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/ownerships/delete | SCOPE_OWNERSHIP_EDITSCOPE_MCP_WRITE |
ListOwnerssynq.owners.v1.OwnersService GET /api/owners/v1 | SCOPE_OWNERS_READSCOPE_MCP_READ |
ListOwnershipssynq.owners.v1.OwnersService GET /api/owners/v1/{owner_id}/ownerships | SCOPE_OWNERSHIP_READSCOPE_MCP_READ |
UpsertOwnersynq.owners.v1.OwnersService POST /api/owners/v1 | SCOPE_OWNERS_EDITSCOPE_MCP_WRITE |
UpsertOwnershipsynq.owners.v1.OwnersService POST /api/owners/v1/{owner_id}/ownerships | SCOPE_OWNERSHIP_EDITSCOPE_MCP_WRITE |
SetPlatformAuthenticationsynq.platforms.v1.PlatformsService POST /api/platforms/v1 | SCOPE_INTEGRATION_EDIT |
GenerateQuerysynq.queries.v1.NLQueryService POST /api/queries/v1/generate | SCOPE_ENTITY_READ |
DescribeResolverQlsynq.queries.v1.QueriesService POST /api/queries/v1/describe-resolver-ql | — |
ResolveQuerysynq.queries.v1.QueriesService POST /api/queries/v1/resolve | SCOPE_ENTITY_READSCOPE_MCP_READ |
TranslateResolverQlsynq.queries.v1.QueriesService POST /api/queries/v1/translate-resolver-ql | SCOPE_ENTITY_READSCOPE_MCP_READ |
BatchGetRecommendationssynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/by-id | SCOPE_RECOMMENDATIONS_READSCOPE_RECOMMENDATIONS_EDITSCOPE_MCP_READ |
DismissRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/dismiss | SCOPE_RECOMMENDATIONS_EDITSCOPE_MCP_WRITE |
IgnoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/ignore | SCOPE_RECOMMENDATIONS_EDITSCOPE_MCP_WRITE |
ListRecommendationssynq.recommendations.v1.RecommendationsService GET /api/recommendations/v1 | SCOPE_RECOMMENDATIONS_READSCOPE_RECOMMENDATIONS_EDITSCOPE_MCP_READ |
RestoreRecommendationsynq.recommendations.v1.RecommendationsService POST /api/recommendations/v1/{recommendation_id}/restore | SCOPE_RECOMMENDATIONS_EDITSCOPE_MCP_WRITE |
BatchGetsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/batch-get | SCOPE_SAVED_VIEW_READSCOPE_MCP_READ |
Deletesynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/delete | SCOPE_SAVED_VIEW_EDITSCOPE_SAVED_VIEW_ADMINSCOPE_MCP_WRITE |
Listsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/list | SCOPE_SAVED_VIEW_READSCOPE_MCP_READ |
SetPinsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1/set-pin | SCOPE_SAVED_VIEW_READSCOPE_MCP_READ |
Upsertsynq.savedviews.v1.SavedViewsService POST /api/saved-views/v1 | SCOPE_SAVED_VIEW_EDITSCOPE_SAVED_VIEW_ADMINSCOPE_MCP_WRITE |
PreviewSchedulessynq.schedule.v1.ScheduleService POST /api/schedule/v1/preview | — |
AddUserRolesynq.users.v1.UsersService POST /api/users/v1/roles | SCOPE_USER_EDIT |
BatchGetUserssynq.users.v1.UsersService POST /api/users/v1/batch-get | SCOPE_USER_READ |
DeleteUserAliasessynq.users.v1.UsersService POST /api/users/v1/aliases/delete | SCOPE_USER_EDITSCOPE_PLATFORM_USER_LINK |
GetByAliassynq.users.v1.UsersService POST /api/users/v1/by-alias | SCOPE_USER_READ |
GetByEmailsynq.users.v1.UsersService GET /api/users/v1/by-email | SCOPE_USER_READSCOPE_MCP_READ |
GetUserAliasessynq.users.v1.UsersService GET /api/users/v1/aliases | SCOPE_USER_READ |
GetUserIdentitiessynq.users.v1.UsersService GET /api/users/v1/identities | SCOPE_USER_READSCOPE_MCP_READ |
ListUserssynq.users.v1.UsersService GET /api/users/v1 | SCOPE_USER_READSCOPE_MCP_READ |
RemoveUserRolesynq.users.v1.UsersService POST /api/users/v1/roles/remove | SCOPE_USER_EDIT |
UpsertUserAliasessynq.users.v1.UsersService PUT /api/users/v1/aliases | SCOPE_USER_EDITSCOPE_PLATFORM_USER_LINK |