This collection is intended to aid dbt Cloud users who wish to use the Cloud API to automate certain processes, e.g. for replicating resources across accounts, projects, environments etc. OR for standardizing project creation for business teams.
\nThis documentation DOES NOT guarantee that the underlying dbt Cloud endpoints will never change. We make best efforts to test and validate the collection on an ongoing basis.
\nThis collection contains a set of endpoints that can be used for managing resources in dbt Cloud. The endpoints documented here can be used to address use cases such as:
\nThe dbt Cloud API uses tokens to authenticate requests, and supports two different types of tokens:
\nTokens obtained using either of the methods above are used in the Authentication header of requests sent to the dbt Cloud API.
\nIf your dbt Cloud account is deployed on our multi-tenant infrastructure, the base URL for the API will look like https://cloud.getdbt.com
Single Tenant base URLs look a bit different, for example: https://[environment].[customer].getdbt.com
If you have questions about the base URL to use for your deployment, reach out to support@getdbt.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14183654","collectionId":"7ad22661-8807-406b-aec0-34a46b671aac","publishedId":"UVsSNiXC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-03-23T14:11:32.000Z"},"item":[{"name":"Create URIs","item":[{"name":"Create Project","event":[{"listen":"test","script":{"id":"f1bf11f3-396d-491c-bac1-4c458d702faa","exec":["let response = pm.response.json();","pm.environment.set(\"project_id\", response['data']['id']);"],"type":"text/javascript"}}],"id":"b55d3fdd-1c12-41f9-9ef4-faf47e11a263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": null,\n \"name\": \"{{project_name}}\",\n \"dbt_project_subdirectory\": null,\n \"account_id\": 1,\n \"connection_id\": null,\n \"repository_id\": null\n}","options":{"raw":{"language":"json"}}},"url":"Note: the dbt_project_subdirectory is an optional field which allows you to point dbt Cloud to a subdirectory that lives within the root folder of your target repository. This means dbt Cloud will look for a dbt_project.yml file at that location.
Note: To set up a snowflake connection with Oauth, follow the instructions here and then set:
\nallow_sso to trueoauth_client_id and oauth_client_secret variables from snowflake to your request.Note: this request is a pre-requisite for the Create Connection - Databricks request. dbt Cloud must first identify the adapter ID to use in the Databricks connection.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: this request should be used in coordination with the Create Connection - Adapter for Databricks request. This request depends on an adapter to be mapped to the target dbt Cloud project in order to run.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: After creating / updating a dbt Cloud repository's SSH key, you will need to add the generated key text as a deploy key to the target repository. This gives dbt Cloud permissions to read / write in the repository.
\nYou can read more in the docs
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"NOTE: this request must be authenticated using a dbt Cloud API user token, which maps to the user who created the gitlab integration.
\ndbt Cloud API service tokens do not function with this request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"NOTE: this request must be authenticated using a dbt Cloud API user token, which maps to the user who created the gitlab integration.
\ndbt Cloud API service tokens do not function with this request.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: Environment variables must be prefixed with DBT_ or DBT_ENV_SECRET_ . You can read more in the docs
Note: Environment variables must be prefixed with DBT_ or DBT_ENV_SECRET_ . You can read more in the docs
Note: Environment variables must be prefixed with DBT_ or DBT_ENV_SECRET_ . You can read more in the docs
Note: The group_name is the name of the dbt Cloud group. The list of sso_mapping_groups are string values that dbt Cloud will attempt to match with incoming information from your identity provider at login time, in order to assign the group with group_name to the user.
Note: Setting the desired_group_ids in this request will overwrite a user's existing group assignments.
This request creates a service token, but does not assign permissions to it. Permissions are assigned via the \"Assign Service Token Permissions\" request in the Update URIs section.
\nSee the user tokens and service tokens documentation for more information.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: created_at is a required field in this request.
See \"Retrieve Environment Variables for a given Project\" for more information on what these {{ environment_variable_value_id }} are.
See \"Retrieve Environment Variables for a given Project\" for more information on what these {{ environment_variable_value_id }} are.
The POST update requires that all valid JSON body key:value pairs be provided in the body payload.
\nThis may require retrieving them from the API first, via a GET, to re-pass them to back.
\nIf you only want to update a subset of the key:value pairs, then we recommend using the \"PATCH\" version of this API call instead.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Using PATCH instead of POST allows an update to made without providing ALL json body key:value pairs.
\nThe minimum is the \"id\" key, plus whatever other key:value pair you want to update:
\n{
\"id\" : 1234,
\"password\" : \"password\"
}
The POST update requires that all valid JSON body key:value pairs be provided in the body payload.
\nThis may require retrieving them from the API first, via a GET, to re-pass them to back.
\nIf you only want to update a subset of the key:value pairs, then we recommend using the \"PATCH\" version of this API call instead.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Using PATCH instead of POST allows an update to made without providing ALL json body key:value pairs.
\nThe minimum is the \"id\" key, plus whatever other key:value pair you want to update:
\n{
\"id\" : 1234,
\"password\" : \"password\"
}
The POST update requires that all valid JSON body key:value pairs be provided in the body payload.
\nThis may require retrieving them from the API first, via a GET, to re-pass them to back.
\nIf you only want to update a subset of the key:value pairs, then we recommend using the \"PATCH\" version of this API call instead.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Using PATCH instead of POST allows an update to made without providing ALL json body key:value pairs.
\nThe minimum is the \"id\" key, plus whatever other key:value pair you want to update:
\n{
\"id\" : 1234,
\"password\" : \"password\"
}
The POST update requires that all valid JSON body key:value pairs be provided in the body payload.
\nThis may require retrieving them from the API first, via a GET, to re-pass them to back.
\nIf you only want to update a subset of the key:value pairs, then we recommend using the \"PATCH\" version of this API call instead.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Using PATCH instead of POST allows an update to made without providing ALL json body key:value pairs.
\nThe minimum is the \"id\" key, plus whatever other key:value pair you want to update:
\n{
\"id\" : 1234,
\"password\" : \"password\"
}
Note: After creating / updating a dbt Cloud repository's SSH key, you will need to add the generated key text as a deploy key to the target repository. This gives dbt Cloud permissions to read / write in the repository.
\nYou can read more in the docs
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: After creating / updating a dbt Cloud repository's SSH key, you will need to add the generated key text as a deploy key to the target repository. This gives dbt Cloud permissions to read / write in the repository.
\nYou can read more in the docs
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This request returns:
\n{\n \"status\": {\n \"code\": 200,\n \"is_success\": true,\n \"user_message\": \"Success!\",\n \"developer_message\": \"\"\n },\n \"data\": {\n \"environments\": [\n \"Deployment\",\n \"Development\",\n \"Deployment 1.3\"\n ],\n \"variables\": {\n \"DBT_SOME_VAR\": {\n \"project\": {\n \"id\": 12345,\n \"value\": \"foo\"\n },\n \"Deployment\": {\n \"id\": 12346,\n \"value\": \"bar\"\n },\n \"Development\": {\n \"id\": 12347,\n \"value\": \"baz\"\n }\n }\n }\n }\n}\n\nWhere environments is a list of all environments in the project and variables is a dictionary of environment variables and what they are set to for each environment. Each environment variable key-value pair will have an associated id ({{ environment_variable_value_id }}) which can be used with the \"Update Environment Variables\" endpoint.
In the example above, there is 1 environment variable DBT_SOME_VAR in the project.
That environment variable's value is set to foo on the project level and has an id of 12345.
That environment variable's value is set to bar for the environment named \"Deployment\" and has an id of 12346.
That environment variable's value is set to baz for the environment named \"Development\" and has an id of 12347.
That environment variable's value is unset for the environment named \"Deployment 1.3\".
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This request returns:
\n{\n \"status\": {\n \"code\": 200,\n \"is_success\": true,\n \"user_message\": \"Success!\",\n \"developer_message\": \"\"\n },\n \"data\": {\n \"environments\": [\n \"Deployment\",\n \"Development\",\n \"Deployment 1.3\"\n ],\n \"variables\": {\n \"DBT_SOME_VAR\": {\n \"project\": {\n \"id\": 12345,\n \"value\": \"foo\"\n },\n \"Deployment\": {\n \"id\": 12346,\n \"value\": \"bar\"\n },\n \"Development\": {\n \"id\": 12347,\n \"value\": \"baz\"\n }\n }\n }\n }\n}\n\nWhere environments is a list of all environments in the project and variables is a dictionary of environment variables and what they are set to for each environment. Each environment variable key-value pair will have an associated id ({{ environment_variable_value_id }}) which can be used with the \"Update Environment Variables\" endpoint.
In the example above, there is 1 environment variable DBT_SOME_VAR in the project.
That environment variable's value is set to foo on the project level and has an id of 12345.
That environment variable's value is set to bar for the environment named \"Deployment\" and has an id of 12346.
That environment variable's value is set to baz for the environment named \"Development\" and has an id of 12347.
That environment variable's value is unset for the environment named \"Deployment 1.3\".
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Note: This endpoint must be accessed with a user token and not a service token.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"