Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .api-codegen-source.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"api_codegen_commit": "a4f447591940caf7c208ba57d38ae146c25517a7",
"api_codegen_run_id": 38429688498,
"generated_at": "2026-10-13T16:21:05Z",
"monolith_commit": "ff18165841dd209e70c97f1615aa1a8d43d92953",
"monolith_run_id": 38426880481,
"exported_at": "2026-10-13T16:03:40Z"
"api_codegen_commit": "beeea5e66fa535ccbc24bb0773851071ea66a01c",
"api_codegen_run_id": 39799856591,
"generated_at": "2026-10-22T14:55:13Z",
"monolith_commit": "b04630df6d4755d1a29fd60078defe6be7c7a7f9",
"monolith_run_id": 39797442584,
"exported_at": "2026-10-22T14:41:23Z"
}
4 changes: 2 additions & 2 deletions skills/onboarding/reference/api/connection-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ them. Each section is one tool; its name is the tool to call.

## `list_connection_types`: List connection types

List the connection types this account can connect with these tools, and what each one takes. Call it before asking about deployments or credentials, to decide whether an integration can be connected here at all. A type that is not listed cannot be: hand the user off to the Monte Carlo app for it. Match what the user names against `name` and `connection_type`. Each entry gives the parent to reuse or create before create_connection: a warehouse of `warehouse_type` (create_warehouse), a BI container of `bi_container_type` (create_bi_container) or an ETL container of `etl_container_type` (create_etl_container). It says where the credentials can live. `self_hosted_credentials_storages` lists the stores the customer runs that can hold them, each referenced with create_<storage>_credentials, such as create_aws_secrets_manager_credentials. `mc_managed_credentials_operation` names the operation that stores them with Monte Carlo. When `mc_managed_credentials_secret` is true, that operation takes a secret and is not a tool here: the user runs it with the CLI or Terraform. A type with `credentials_required` false takes none. `requires_deployment` false means the parent takes no deployment, so there is no deployment to choose. `requires_one_of_connection_types` lists the connection the warehouse needs first. A custom type (`is_custom`) runs through the deployment of the agent that registered it: list_custom_connector_types gives that agent and deployment. Nothing here checks a particular deployment. create_connection still refuses one below the version a type needs.
List the connection types this account can connect with these tools, and what each one takes. Call it before asking about deployments or credentials, to decide whether an integration can be connected here at all. A type that is not listed cannot be: hand the user off to the Monte Carlo app for it. Match what the user names against `name` and `connection_type`. Each entry gives the parent to reuse or create before create_connection: a warehouse of `warehouse_type` (create_warehouse), a BI container of `bi_container_type` (create_bi_container) or an ETL container of `etl_container_type` (create_etl_container). It says where the credentials can live. `self_hosted_credentials_storages` lists the stores the customer runs that can hold them, each referenced with create_<storage>_credentials, such as create_aws_secrets_manager_credentials. `mc_managed_credentials_operation` names the operation that stores them with Monte Carlo. When `mc_managed_credentials_secret` is true, that operation takes a secret and is not a tool here: the user runs it with the CLI or Terraform. A type with `credentials_required` false takes none. `requires_deployment` false means the parent takes no deployment, so there is no deployment to choose. `requires_one_of_connection_types` lists the connection the warehouse needs first. A custom type (`is_custom`) runs through the deployment of the agent that registered it: list_custom_connector_types gives that agent and deployment. Nothing here checks a particular deployment. create_connection refuses a deployment below the version a type needs, and a collection agent below the build it needs. Self-hosted Fivetran credentials and custom types need a recent agent.

- **Effect:** read-only.

Expand All @@ -24,7 +24,7 @@ Returns `items`. Response fields per item: connection_type, name, parent, wareho
| `connection_type` | The connection type. Credentials for it name this type, and the connection takes its type from them. |
| `name` | Display name of the connection type. |
| `parent` | What a connection of this type is added to. Create or reuse one first. |
| `warehouse_type` | The type of warehouse the connection goes on. Null unless `parent` is `warehouse`. |
| `warehouse_type` | The type of warehouse the connection goes on. Null unless `parent` is `warehouse`. Null too for a type any existing warehouse takes, such as `dbt-cloud-webhook`. |
| `bi_container_type` | The type of BI container the connection goes on. Null unless `parent` is `bi_container`. |
| `etl_container_type` | The type of ETL container the connection goes on. Null unless `parent` is `etl_container`. |
| `credentials_required` | Whether the connection needs credentials. False for a push-only type: its data is sent to Monte Carlo, and Monte Carlo reaches no system for it. |
Expand Down
16 changes: 10 additions & 6 deletions skills/onboarding/reference/api/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs through it, such as a Snowflake Tasks or Power BI dataflows connection.

### Response

Returns `items` (response fields per item: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time), `next_cursor` (pass it as `cursor` for the next page; null on the last page), `has_more`, and `count` (the total across pages, only when `with_count` is true).
Returns `items` (response fields per item: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time, dbt_cloud), `next_cursor` (pass it as `cursor` for the next page; null on the last page), `has_more`, and `count` (the total across pages, only when `with_count` is true).

| Field | Description |
|---|---|
Expand All @@ -54,6 +54,7 @@ Returns `items` (response fields per item: id, connection_type, name, warehouse_
| `credentials_storage_type` | Where that secret lives. Null when there are no credentials to describe. |
| `job_types` | The jobs Monte Carlo runs on this connection, such as `metadata`. |
| `created_time` | When the connection was created. |
| `dbt_cloud` | Which dbt Cloud runs a dbt Cloud webhook connection processes. A dbt Cloud webhook reports runs from every environment in the dbt account. These settings decide which of them Monte Carlo processes for the connection's warehouse. Null for every other connection type. |

### What can fail

Expand All @@ -64,7 +65,7 @@ Returns `items` (response fields per item: id, connection_type, name, warehouse_

## `create_connection`: Create a connection

Add a connection to a warehouse, a BI container or an ETL container from credentials that already exist. Takes the name, the credentials id, and exactly one parent: the warehouse id, the BI container id from create_bi_container for Tableau, Looker or Power BI credentials, or the ETL container id from create_etl_container for ETL tool credentials such as Fivetran or Airflow. An ETL container takes one connection, of its own type. A custom ETL or BI connector's credentials, of type custom-etl-connector-<id> or custom-bi-connector-<id>, go on a custom-etl-connector or custom-bi-connector container on the deployment of the agent that registered the connector. Such a container with no deployment is push-only: send no credentials id, and the connection takes the container's type. A custom warehouse connector's credentials, of type custom-connector-<id>, go on a warehouse on that agent's deployment, usually a custom-integration one. Every other parent needs the credentials id. The connection type comes from the credentials. The connection runs through its parent's deployment, so call list_deployments and list_warehouses, list_bi_containers or list_etl_containers first and reuse a parent on the right deployment: the cloud deployment hosted by Monte Carlo, or one with a collection agent or data store registered. Create a deployment only for an agent or a data store, never one with nothing behind it. Some types need another connection on the warehouse first. A databricks-sql-warehouse connection goes on a data-lake warehouse that already has a databricks-metastore-sql-warehouse connection, so add the metastore first. Credentials that reference a store you run are created from here with create_aws_secrets_manager_credentials, create_gcp_secret_manager_credentials, create_azure_key_vault_credentials, create_env_var_credentials or create_file_credentials. Credentials whose secret has to be sent in the request, such as a Snowflake key pair, a BigQuery service account key, a database password, a Databricks token or a BI tool's password or client secret, are created with the CLI or Terraform, not from here.
Add a connection to a warehouse, a BI container or an ETL container from credentials that already exist. Takes the name, the credentials id, and exactly one parent: the warehouse id, the BI container id from create_bi_container for Tableau, Looker or Power BI credentials, or the ETL container id from create_etl_container for ETL tool credentials such as Fivetran or Airflow. An ETL container takes one connection, of its own type. A custom ETL or BI connector's credentials, of type custom-etl-connector-<id> or custom-bi-connector-<id>, go on a custom-etl-connector or custom-bi-connector container on the deployment of the agent that registered the connector. Such a container with no deployment is push-only: send no credentials id, and the connection takes the container's type. A custom warehouse connector's credentials, of type custom-connector-<id>, go on a warehouse on that agent's deployment, usually a custom-integration one. dbt Cloud webhook credentials go on the existing warehouse the dbt project builds into. A webhook takes one connection. Every other parent needs the credentials id. The connection type comes from the credentials. The connection runs through its parent's deployment, so call list_deployments and list_warehouses, list_bi_containers or list_etl_containers first and reuse a parent on the right deployment: the cloud deployment hosted by Monte Carlo, or one with a collection agent or data store registered. Create a deployment only for an agent or a data store, never one with nothing behind it. Some types need another connection on the warehouse first. A databricks-sql-warehouse connection goes on a data-lake warehouse that already has a databricks-metastore-sql-warehouse connection, so add the metastore first. A glue connection is a data-lake warehouse's one main connection, so it goes on a data-lake warehouse with no main connection yet. An athena connection can go on the same warehouse. Glue and Athena credentials hold no secret and are created from here with create_glue_credentials and create_athena_credentials. Credentials that reference a store you run are created from here with create_aws_secrets_manager_credentials, create_gcp_secret_manager_credentials, create_azure_key_vault_credentials, create_env_var_credentials or create_file_credentials. Credentials whose secret has to be sent in the request, such as a Snowflake key pair, a BigQuery service account key, a database password, a Databricks token, a BI tool's password or client secret, or a dbt Cloud service token, are created with the CLI or Terraform, not from here.

- **Effect:** creates; repeating it creates again.
- **Pairs with:** `list_connections`, `get_connection`, `update_connection`, `delete_connection`, `list_warehouses`, `list_bi_containers`, `list_etl_containers`, `list_credentials`.
Expand All @@ -82,7 +83,7 @@ Add a connection to a warehouse, a BI container or an ETL container from credent

### Response

Returns the new connection. Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time.
Returns the new connection. Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time, dbt_cloud.

| Field | Description |
|---|---|
Expand All @@ -101,6 +102,7 @@ Returns the new connection. Response fields: id, connection_type, name, warehous
| `credentials_storage_type` | Where that secret lives. Null when there are no credentials to describe. |
| `job_types` | The jobs Monte Carlo runs on this connection, such as `metadata`. |
| `created_time` | When the connection was created. |
| `dbt_cloud` | Which dbt Cloud runs a dbt Cloud webhook connection processes. A dbt Cloud webhook reports runs from every environment in the dbt account. These settings decide which of them Monte Carlo processes for the connection's warehouse. Null for every other connection type. |

### What can fail

Expand Down Expand Up @@ -130,7 +132,7 @@ restrictions hide from you returns 404.

### Response

Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time.
Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time, dbt_cloud.

| Field | Description |
|---|---|
Expand All @@ -149,6 +151,7 @@ Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_con
| `credentials_storage_type` | Where that secret lives. Null when there are no credentials to describe. |
| `job_types` | The jobs Monte Carlo runs on this connection, such as `metadata`. |
| `created_time` | When the connection was created. |
| `dbt_cloud` | Which dbt Cloud runs a dbt Cloud webhook connection processes. A dbt Cloud webhook reports runs from every environment in the dbt account. These settings decide which of them Monte Carlo processes for the connection's warehouse. Null for every other connection type. |

### What can fail

Expand All @@ -174,7 +177,7 @@ Rename a connection, or turn ETL on or off for a Snowflake, Power BI or Salesfor

### Response

Returns the connection after the change. Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time.
Returns the connection after the change. Response fields: id, connection_type, name, warehouse_id, warehouse_name, bi_container_id, bi_container_name, etl_container_id, etl_container_name, deployment_id, deployment_name, credentials_id, credentials_storage_type, job_types, created_time, dbt_cloud.

| Field | Description |
|---|---|
Expand All @@ -193,6 +196,7 @@ Returns the connection after the change. Response fields: id, connection_type, n
| `credentials_storage_type` | Where that secret lives. Null when there are no credentials to describe. |
| `job_types` | The jobs Monte Carlo runs on this connection, such as `metadata`. |
| `created_time` | When the connection was created. |
| `dbt_cloud` | Which dbt Cloud runs a dbt Cloud webhook connection processes. A dbt Cloud webhook reports runs from every environment in the dbt account. These settings decide which of them Monte Carlo processes for the connection's warehouse. Null for every other connection type. |

### What can fail

Expand Down Expand Up @@ -254,7 +258,7 @@ Returns the accepted request as-is. Response fields: id, status, revision, targe
| `status` | Whether the run is still going. Every validation is final once it is not. |
| `revision` | Moves forward every time a validation changes. Pass it as `since` on the next poll to get only the validations that changed after this response. |
| `target_type` | What the run validates. |
| `target_id` | Identifier of what is being validated. Null for candidate values, which are not stored anywhere. |
| `target_id` | Identifier of what is being validated: the connection, or the credentials a change applies to. Null for candidate values, which are not stored anywhere. |
| `validations_passed` | How many validations reached a passing verdict. One that was skipped or never reached a verdict is not counted here, but is still in `validations_total`. |
| `validations_total` | How many validations the run covers. |
| `started_at` | When the run started. |
Expand Down
Loading
Loading