diff --git a/openapi-v2.yaml b/openapi-v2.yaml index 732d08d..dd72251 100644 --- a/openapi-v2.yaml +++ b/openapi-v2.yaml @@ -2,7 +2,8 @@ openapi: 3.0.3 info: title: dbt Cloud API v2 version: 2.0.0 - description: "# How to use this API\n\nThe dbt Cloud API v2 contains endpoints for\ + description: + "# How to use this API\n\nThe dbt Cloud API v2 contains endpoints for\ \ enqueuing runs from a job, polling for run progress,\nand downloading artifacts\ \ after jobs have completed running. For operational endpoints to\ncreate, modify,\ \ and delete _objects_ in dbt Cloud, consider using [API v3](https://docs.getdbt.com/dbt-cloud/api-v3#/)\n\ @@ -10,15 +11,17 @@ info: repository. If you find issues in these docs or have questions about using the\ \ dbt Cloud\nAPI, please open an issue in the dbt-cloud-openapi-spec repo or contact\ \ support@getdbt.com.\n\n## Authentication\n\nTo authenticate an application with\ - \ the dbt Cloud API, navigate to the\nAPI Settings page in your [dbt Cloud profile](https://cloud.getdbt.com/#/profile/api/).\n\ - If you cannot access this page, confirm that your dbt Cloud account has access\ + \ the dbt Cloud API, navigate to the\nAccount Settings page and go to Personal\ + \ Tokens from the left sidebar. Create one if you don't have one already.\nIf\ + \ you cannot access this page, confirm that your dbt Cloud account has access\ \ to the API,\nand that you are using the hosted version of dbt Cloud. If dbt\ \ Cloud is running inside of a VPC\nin an Enterprise account, contact your account\ - \ manager for help finding your API key.\n\nOnce you've found your API key, use\ - \ it in the Authorization header of requests to the dbt Cloud API.\nBe sure to\ - \ include the `Token` prefix in the Authorization header, or the request will\ - \ fail with a\n\"401 Unauthorized\" error.\n\n*Note: `Bearer` can be used in place\ - \ of `Token` in the Authorization header. Both syntaxes are equivalent.*\n\n**Headers**\n\ + \ manager for help finding your account-scoped Personal Access Token.\n\nOnce\ + \ you've found your Personal Access Token (PAT) for your account, use it in the\ + \ Authorization header of requests to the dbt Cloud API.\nBe sure to include the\ + \ `Token` prefix in the Authorization header, or the request will fail with a\n\ + \"401 Unauthorized\" error.\n\n*Note: `Bearer` can be used in place of `Token`\ + \ in the Authorization header. Both syntaxes are equivalent.*\n\n**Headers**\n\ ```\nAccept: application/json\nAuthorization: Token \n``` \n\n##\ \ Pagination\n\nAll top-level API resources support bulk fetches using the \"\ list\" or `GET` API methods. These API methods accept `limit` and `offset` query\ @@ -43,1416 +46,1421 @@ paths: operationId: List Accounts description: Deprecated. Consider using the v3 API instead. tags: - - Accounts + - Accounts security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AccountEnveloped' - description: '' + $ref: "#/components/schemas/AccountEnveloped" + description: "" /api/v2/accounts/{account_id}/: get: operationId: Retrieve Account description: Retrieve an Account parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Accounts + - Accounts security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AccountEnveloped' - description: '' + $ref: "#/components/schemas/AccountEnveloped" + description: "" post: operationId: Update Account description: Update an account parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Accounts + - Accounts requestBody: content: application/json: schema: - $ref: '#/components/schemas/AccountRequest' + $ref: "#/components/schemas/AccountRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/AccountRequest' + $ref: "#/components/schemas/AccountRequest" multipart/form-data: schema: - $ref: '#/components/schemas/AccountRequest' + $ref: "#/components/schemas/AccountRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AccountEnveloped' - description: '' + $ref: "#/components/schemas/AccountEnveloped" + description: "" /api/v2/accounts/{account_id}/encryptions/: get: operationId: List SSH Tunnels description: List SSH tunnels parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: connection_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: connection_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: state + schema: + type: integer tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/ConnectionEncryptionEnveloped' - description: '' + $ref: "#/components/schemas/ConnectionEncryptionEnveloped" + description: "" post: operationId: Create SSH Tunnel description: Create a new SSH tunnel to encrypt traffic for a given connection parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Connections + - Connections requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConnectionEncryptionEnveloped' - description: '' + $ref: "#/components/schemas/ConnectionEncryptionEnveloped" + description: "" /api/v2/accounts/{account_id}/encryptions/{id}/: get: operationId: Retrieve SSH Tunnel description: Retrieve an SSH tunnel parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConnectionEncryptionEnveloped' - description: '' + $ref: "#/components/schemas/ConnectionEncryptionEnveloped" + description: "" post: operationId: Update SSH Tunnel description: Update an SSH tunnel parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Connections + - Connections requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ConnectionEncryptionRequest' + $ref: "#/components/schemas/ConnectionEncryptionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConnectionEncryptionEnveloped' - description: '' + $ref: "#/components/schemas/ConnectionEncryptionEnveloped" + description: "" delete: operationId: Destroy SSH Tunnel description: Delete an SSH tunnel parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/environments/: get: operationId: List Environments description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: dbt_version - schema: - type: string - - in: query - name: dbt_version__in - schema: - type: array - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: dbt_version + schema: + type: string + - in: query + name: dbt_version__in + schema: + type: array + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/EnvironmentV2Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV2Enveloped" + description: "" post: operationId: Create Environment description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Environments + - Environments requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" multipart/form-data: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV2Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV2Enveloped" + description: "" /api/v2/accounts/{account_id}/environments/{id}/: get: operationId: Retrieve Environment description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV2Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV2Enveloped" + description: "" post: operationId: Update Environment description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Environments + - Environments requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" multipart/form-data: schema: - $ref: '#/components/schemas/EnvironmentV2Request' + $ref: "#/components/schemas/EnvironmentV2Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV2Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV2Enveloped" + description: "" delete: operationId: Destroy Environment description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/invites/: get: operationId: List Invites parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Invites + - Invites security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/InviteEnveloped' - description: '' + $ref: "#/components/schemas/InviteEnveloped" + description: "" /api/v2/accounts/{account_id}/invites/{id}/: get: operationId: Retrieve Invite parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Invites + - Invites security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/InviteEnveloped' - description: '' + $ref: "#/components/schemas/InviteEnveloped" + description: "" /api/v2/accounts/{account_id}/jobs/: get: operationId: List Jobs description: Use this endpoint to list jobs for an account. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: dbt_version__in - schema: - type: array - - in: query - name: environment_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name__icontains - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: triggers_schedule - schema: - type: boolean + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: dbt_version__in + schema: + type: array + - in: query + name: environment_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name__icontains + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: triggers_schedule + schema: + type: boolean tags: - - Jobs + - Jobs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/HumanReadableJobDefinitionEnveloped' - description: '' + $ref: "#/components/schemas/HumanReadableJobDefinitionEnveloped" + description: "" post: operationId: Create Job description: Use this endpoint to create a new job. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Jobs + - Jobs requestBody: content: application/json: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionEnveloped' - description: '' + $ref: "#/components/schemas/HumanReadableJobDefinitionEnveloped" + description: "" /api/v2/accounts/{account_id}/jobs/{job_id}/artifacts/{remainder}: get: operationId: Retrieve Job Artifact - description: Given a job id and *a set of Run filters* return the latest matching + description: + Given a job id and *a set of Run filters* return the latest matching artifact for that job. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: job_id - schema: - type: integer - required: true - - in: path - name: remainder - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: job_id + schema: + type: integer + required: true + - in: path + name: remainder + schema: + type: string + required: true tags: - - Jobs + - Jobs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/jobs/{job_id}/rerun/: post: operationId: Retry Failed Job - description: Use this endpoint to retry a failed run for a job from the point + description: + Use this endpoint to retry a failed run for a job from the point of failure, if the run failed. Otherwise trigger a new run. When this endpoint returns a successful response, a new run will be enqueued for the account. Users can poll the Get run endpoint to poll the run until it completes. After the run has completed, users can use the Get run artifact endpoint to download artifacts generated by the run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: job_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: job_id + schema: + type: integer + required: true tags: - - Jobs + - Jobs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/jobs/{job_id}/run/: post: operationId: Trigger Job Run - description: Use this endpoint to kick off a run for a job. When this endpoint + description: + Use this endpoint to kick off a run for a job. When this endpoint returns a successful response, a new run will be enqueued for the account. Users can poll the Get run endpoint to poll the run until it completes. After the run has completed, users can use the Get run artifact endpoint to download artifacts generated by the run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: job_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: job_id + schema: + type: integer + required: true tags: - - Jobs + - Jobs requestBody: content: application/json: schema: - $ref: '#/components/schemas/TriggerRunRequestRequest' + $ref: "#/components/schemas/TriggerRunRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/TriggerRunRequestRequest' + $ref: "#/components/schemas/TriggerRunRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/TriggerRunRequestRequest' + $ref: "#/components/schemas/TriggerRunRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RunResponseEnveloped' - description: '' + $ref: "#/components/schemas/RunResponseEnveloped" + description: "" /api/v2/accounts/{account_id}/jobs/{id}/: get: operationId: Retrieve Job description: Use this endpoint to retrieve the details of a job. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Jobs + - Jobs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionEnveloped' - description: '' + $ref: "#/components/schemas/HumanReadableJobDefinitionEnveloped" + description: "" post: operationId: Update Job description: Use this endpoint to update a job. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Jobs + - Jobs requestBody: content: application/json: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionRequest' + $ref: "#/components/schemas/HumanReadableJobDefinitionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HumanReadableJobDefinitionEnveloped' - description: '' + $ref: "#/components/schemas/HumanReadableJobDefinitionEnveloped" + description: "" delete: operationId: Destroy Job description: Use this endpoint to delete a job. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Jobs + - Jobs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/licenses/: get: operationId: List Account Licenses parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Licenses + - Licenses security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/notifications/: get: operationId: List Notifications description: List notification configurations parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: external_email - schema: - type: string - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: slack_channel_id - schema: - type: string - - in: query - name: state - schema: - type: integer - - in: query - name: type - schema: - type: integer - - in: query - name: user_id - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: external_email + schema: + type: string + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: slack_channel_id + schema: + type: string + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: integer + - in: query + name: user_id + schema: + type: integer tags: - - Notifications + - Notifications security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/JobNotificationSettingsEnveloped' - description: '' + $ref: "#/components/schemas/JobNotificationSettingsEnveloped" + description: "" post: operationId: Create Notification - description: Create a new Job Notification configuration to trigger notifications + description: + Create a new Job Notification configuration to trigger notifications for job successes, failures, or cancelations. Notifications can be sent to a dbt Cloud user, an external email address, or a Slack channel. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Notifications + - Notifications requestBody: content: application/json: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" multipart/form-data: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JobNotificationSettingsEnveloped' - description: '' + $ref: "#/components/schemas/JobNotificationSettingsEnveloped" + description: "" /api/v2/accounts/{account_id}/notifications/{id}/: get: operationId: Retrieve Notification description: Fetch notification configurations parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Notifications + - Notifications security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JobNotificationSettingsEnveloped' - description: '' + $ref: "#/components/schemas/JobNotificationSettingsEnveloped" + description: "" post: operationId: Update Notification description: Update an existing Job Notification configuration. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Notifications + - Notifications requestBody: content: application/json: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" multipart/form-data: schema: - $ref: '#/components/schemas/JobNotificationSettingsRequest' + $ref: "#/components/schemas/JobNotificationSettingsRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JobNotificationSettingsEnveloped' - description: '' + $ref: "#/components/schemas/JobNotificationSettingsEnveloped" + description: "" delete: operationId: Destroy Notification parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Notifications + - Notifications security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/permissions/{id}/: post: operationId: Create Permission parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Permissions + - Permissions security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/projects/: get: operationId: List Projects description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name__icontains - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: pk__in - schema: - type: array - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name__icontains + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: pk__in + schema: + type: array + - in: query + name: state + schema: + type: integer tags: - - Projects + - Projects security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/ProjectEnveloped" + description: "" post: operationId: Create Project description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Projects + - Projects requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/ProjectEnveloped" + description: "" /api/v2/accounts/{account_id}/projects/{id}/: get: operationId: Retrieve Project description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - Projects security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/ProjectEnveloped" + description: "" post: operationId: Update Project description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - Projects requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/ProjectEnveloped" + description: "" delete: operationId: Destroy Project description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - Projects security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/repositories/: get: operationId: List Repositories description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: remote_url - schema: - type: string - - in: query - name: state - schema: - type: integer - tags: - - Repositories - security: - - BearerAuthentication: [] - deprecated: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: remote_url + schema: + type: string + - in: query + name: state + schema: + type: integer + tags: + - Repositories + security: + - BearerAuthentication: [] + deprecated: true responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/RepositoryV2Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV2Enveloped" + description: "" post: operationId: Create Repository description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Repositories + - Repositories requestBody: content: application/json: schema: - $ref: '#/components/schemas/RepositoryV2Request' + $ref: "#/components/schemas/RepositoryV2Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/RepositoryV2Request' + $ref: "#/components/schemas/RepositoryV2Request" multipart/form-data: schema: - $ref: '#/components/schemas/RepositoryV2Request' + $ref: "#/components/schemas/RepositoryV2Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV2Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV2Enveloped" + description: "" /api/v2/accounts/{account_id}/repositories/{id}/: get: operationId: Retrieve Repository description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Repositories + - Repositories security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV2Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV2Enveloped" + description: "" delete: operationId: Destroy Repository description: Deprecated. Consider using the v3 API instead. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Repositories + - Repositories security: - - BearerAuthentication: [] + - BearerAuthentication: [] deprecated: true responses: - '204': + "204": description: No response body /api/v2/accounts/{account_id}/runs/: get: operationId: List Runs description: Use this endpoint to list runs for an account. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: created_at__range - schema: - type: array - - in: query - name: dbt_version - schema: - type: string - - in: query - name: dbt_version__in - schema: - type: array - - in: query - name: deferring_run_id - schema: - type: integer - - in: query - name: environment_id - schema: - type: integer - - in: query - name: finished_at__range - schema: - type: array - - in: query - name: has_docs_generated - schema: - type: boolean - - in: query - name: has_sources_generated - schema: - type: boolean - - in: query - name: id__gt - schema: - type: integer - - in: query - name: job_definition_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: status - schema: - type: integer - - in: query - name: status__in - schema: - type: array + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: created_at__range + schema: + type: array + - in: query + name: dbt_version + schema: + type: string + - in: query + name: dbt_version__in + schema: + type: array + - in: query + name: deferring_run_id + schema: + type: integer + - in: query + name: environment_id + schema: + type: integer + - in: query + name: finished_at__range + schema: + type: array + - in: query + name: has_docs_generated + schema: + type: boolean + - in: query + name: has_sources_generated + schema: + type: boolean + - in: query + name: id__gt + schema: + type: integer + - in: query + name: job_definition_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: status + schema: + type: integer + - in: query + name: status__in + schema: + type: array tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/RunResponseEnveloped' - description: '' + $ref: "#/components/schemas/RunResponseEnveloped" + description: "" /api/v2/accounts/{account_id}/runs/{id}/: get: operationId: Retrieve Run description: Use this endpoint to retrieve details for a run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RunResponseEnveloped' - description: '' + $ref: "#/components/schemas/RunResponseEnveloped" + description: "" /api/v2/accounts/{account_id}/runs/{run_id}/artifacts/: get: operationId: List Run Artifacts description: Retrieve the list of artifacts generated for a run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: run_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: run_id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListOfStringsEnveloped' - description: '' + $ref: "#/components/schemas/ListOfStringsEnveloped" + description: "" /api/v2/accounts/{account_id}/runs/{run_id}/artifacts/{remainder}: get: operationId: Retrieve Run Artifact - description: Use this endpoint to fetch artifacts from a completed run. Once + description: + Use this endpoint to fetch artifacts from a completed run. Once a run has been completed, you can use this endpoint to download the `manifest.json`, `run_results.json`, or `catalog.json` files from dbt Cloud. These artifacts contain information about the models in your dbt project, timing information @@ -1461,243 +1469,249 @@ paths: in the run. To list artifacts from other steps in the run, use the step query parameter described below. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: remainder - schema: - type: string - required: true - - in: path - name: run_id - schema: - type: integer - required: true - - in: query - name: step - schema: - type: integer - description: The index of the Step in the Run to query for artifacts. The - first step in the run has the index `1`. If the `step` parameter is omitted, - then this endpoint will return the artifacts compiled for the last step - in the run. + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: remainder + schema: + type: string + required: true + - in: path + name: run_id + schema: + type: integer + required: true + - in: query + name: step + schema: + type: integer + description: + The index of the Step in the Run to query for artifacts. The + first step in the run has the index `1`. If the `step` parameter is omitted, + then this endpoint will return the artifacts compiled for the last step + in the run. tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/runs/{run_id}/cancel/: post: operationId: Cancel Run description: Use this endpoint to cancel a run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: run_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: run_id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RunResponseEnveloped' - description: '' + $ref: "#/components/schemas/RunResponseEnveloped" + description: "" /api/v2/accounts/{account_id}/runs/{run_id}/retry/: get: operationId: Retrieve Run Failure Details - description: Use this endpoint to get details about a retryable run that has + description: + Use this endpoint to get details about a retryable run that has failed. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: run_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: run_id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body post: operationId: Retry Run - description: Use this endpoint to retry a failed run. When this endpoint returns + description: + Use this endpoint to retry a failed run. When this endpoint returns a successful response, a new run will be enqueued. Users can poll the Get Run endpoint until it completes. After the run has completed, users can use the Get Run Artifact endpoint to download artifacts generated by the run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: run_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: run_id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/accounts/{account_id}/steps/{id}/: get: operationId: Retrieve Run Step - description: Use this endpoint to retrieve the details of a specific step of + description: + Use this endpoint to retrieve the details of a specific step of a run. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Runs + - Runs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RunStepEnveloped' - description: '' + $ref: "#/components/schemas/RunStepEnveloped" + description: "" /api/v2/accounts/{account_id}/users/: get: operationId: List Users parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserEnveloped' - description: '' + $ref: "#/components/schemas/UserEnveloped" + description: "" /api/v2/notifications/unsubscribe/: post: operationId: Unsubscribe from Notifications - description: Clear out all email notification configurations for the user making + description: + Clear out all email notification configurations for the user making the request. tags: - - Notifications + - Notifications security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v2/users/{id}/: get: operationId: Retrieve User parameters: - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserEnveloped' - description: '' + $ref: "#/components/schemas/UserEnveloped" + description: "" post: operationId: Update User parameters: - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Users + - Users requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserRequest' + $ref: "#/components/schemas/UserRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/UserRequest' + $ref: "#/components/schemas/UserRequest" multipart/form-data: schema: - $ref: '#/components/schemas/UserRequest' + $ref: "#/components/schemas/UserRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserEnveloped' - description: '' + $ref: "#/components/schemas/UserEnveloped" + description: "" components: schemas: Account: type: object required: - - id - - name - - state - - plan - - pending_cancel - - run_slots - - developer_seats - - docs_job_id - - freshness_job_id + - id + - name + - state + - plan + - pending_cancel + - run_slots + - developer_seats + - explorer_seats + - docs_job_id + - freshness_job_id properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 description: The name of the account state: type: integer @@ -1712,6 +1726,9 @@ components: developer_seats: type: integer description: The total number of developer seats the account may use + explorer_seats: + type: integer + description: The total number of explorer seats the account may use it_seats: type: integer description: The total number of IT seats the account may use @@ -1728,129 +1745,129 @@ components: type: integer stripe_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string metronome_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string salesforce_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string third_party_billing: oneOf: - - type: 'null' - - {} + - type: "null" + - {} billing_email_address: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string locked: type: boolean description: Whether the account is currently locked lock_reason: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string description: Why the account is locked lock_cause: oneOf: - - type: 'null' - - {} - - {} - - {} - - {} - - {} + - type: "null" + - {} + - {} + - {} + - {} + - {} description: Why the account is locked develop_file_system: type: boolean unlocked_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time unlock_if_subscription_renewed: type: boolean enterprise_authentication_method: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_login_slug: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_unique_identifier: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string business_critical: type: boolean groups: oneOf: - - type: 'null' - - {} + - type: "null" + - {} description: The user groups in the account created_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true updated_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true starter_repo_url: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string git_auth_level: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string identifier: oneOf: - - type: 'null' - - allOf: - - type: string - - minLength: 31 - maxLength: 31 + - type: "null" + - allOf: + - type: string + - minLength: 31 + maxLength: 31 trial_end_date: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time static_subdomain: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string run_locked_until: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time docs_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) freshness_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) migration_scheduled_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time account_migration_events: oneOf: - - type: 'null' - - {} + - type: "null" + - {} additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -1860,34 +1877,35 @@ components: data: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status AccountRequest: type: object required: - - id - - name - - state - - plan - - pending_cancel - - run_slots - - developer_seats - - docs_job_id - - freshness_job_id + - id + - name + - state + - plan + - pending_cancel + - run_slots + - developer_seats + - explorer_seats + - docs_job_id + - freshness_job_id properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 description: The name of the account state: type: integer @@ -1902,6 +1920,9 @@ components: developer_seats: type: integer description: The total number of developer seats the account may use + explorer_seats: + type: integer + description: The total number of explorer seats the account may use it_seats: type: integer description: The total number of IT seats the account may use @@ -1918,120 +1939,146 @@ components: type: integer stripe_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string metronome_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string salesforce_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string third_party_billing: oneOf: - - type: 'null' - - {} + - type: "null" + - {} billing_email_address: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string locked: type: boolean description: Whether the account is currently locked lock_reason: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string description: Why the account is locked lock_cause: oneOf: - - type: 'null' - - {} - - {} - - {} - - {} - - {} + - type: "null" + - {} + - {} + - {} + - {} + - {} description: Why the account is locked develop_file_system: type: boolean unlocked_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time unlock_if_subscription_renewed: type: boolean enterprise_authentication_method: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_login_slug: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_unique_identifier: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string business_critical: type: boolean groups: oneOf: - - type: 'null' - - {} + - type: "null" + - {} description: The user groups in the account starter_repo_url: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string git_auth_level: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string identifier: oneOf: - - type: 'null' - - allOf: - - type: string - - minLength: 31 - maxLength: 31 + - type: "null" + - allOf: + - type: string + - minLength: 31 + maxLength: 31 trial_end_date: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time static_subdomain: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string run_locked_until: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time docs_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) freshness_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) migration_scheduled_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time account_migration_events: oneOf: - - type: 'null' - - {} + - type: "null" + - {} additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# + AdapterVersionEnum: + enum: + - apache_spark_v0 + - databricks_spark_v0 + - databricks_v0 + - trino_v0 + - snowflake_v0 + - bigquery_v0 + - postgres_v0 + - redshift_v0 + - synapse_v0 + - fabric_v0 + - athena_v0 + type: string + description: |- + * `apache_spark_v0` - apache_spark_v0 + * `databricks_spark_v0` - databricks_spark_v0 + * `databricks_v0` - databricks_v0 + * `trino_v0` - trino_v0 + * `snowflake_v0` - snowflake_v0 + * `bigquery_v0` - bigquery_v0 + * `postgres_v0` - postgres_v0 + * `redshift_v0` - redshift_v0 + * `synapse_v0` - synapse_v0 + * `fabric_v0` - fabric_v0 + * `athena_v0` - athena_v0 BaseConnectionV3: type: object properties: @@ -2047,7 +2094,9 @@ components: type: string description: The name of the connection type: - $ref: '#/components/schemas/BaseConnectionV3TypeEnum' + $ref: "#/components/schemas/BaseConnectionV3TypeEnum" + adapter_version: + $ref: "#/components/schemas/AdapterVersionEnum" created_by_id: type: integer created_by_service_token_id: @@ -2055,22 +2104,28 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string + oauth_configuration_id: + type: integer + description: + The OAuth Configuration associated with this connection. When + set,developer credentials leveraging OAuth may be created. required: - - account_id - - name - - project_id - - type + - account_id + - name + - project_id + - type BaseConnectionV3TypeEnum: enum: - - postgres - - redshift - - snowflake - - bigquery - - adapter + - postgres + - redshift + - snowflake + - bigquery + - adapter type: string description: |- * `postgres` - postgres @@ -2106,17 +2161,17 @@ components: type: integer default: 1 required: - - id + - id ConnectionEncryptionEnveloped: type: object properties: data: - $ref: '#/components/schemas/ConnectionEncryption' + $ref: "#/components/schemas/ConnectionEncryption" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ConnectionEncryptionRequest: type: object properties: @@ -2149,20 +2204,21 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - connection_id - - hostname - - port - - username + - account_id + - connection_id + - hostname + - port + - username DateEnum: enum: - - every_day - - days_of_week - - custom_cron - - interval_cron + - every_day + - days_of_week + - custom_cron + - interval_cron type: string description: |- * `every_day` - every_day @@ -2171,8 +2227,8 @@ components: * `interval_cron` - interval_cron DeploymentTypeEnum: enum: - - production - - staging + - production + - staging type: string description: |- * `production` - production @@ -2180,108 +2236,108 @@ components: EnvironmentV2: type: object required: - - account_id - - connection_id - - created_by_id - - name - - dbt_project_subdirectory - - use_custom_branch - - custom_branch - - dbt_version - - supports_docs - - repository_id - - state + - account_id + - connection_id + - created_by_id + - name + - dbt_project_subdirectory + - use_custom_branch + - custom_branch + - dbt_version + - supports_docs + - repository_id + - state properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer account_id: type: integer connection_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer project_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer credentials_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer created_by_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 dbt_project_subdirectory: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string use_custom_branch: type: boolean custom_branch: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string dbt_version: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string raw_dbt_version: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string supports_docs: type: boolean repository_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer state: type: integer repository: oneOf: - - type: 'null' - - {} + - type: "null" + - {} jobs: {} connection: oneOf: - - type: 'null' - - {} + - type: "null" + - {} custom_environment_variables: oneOf: - - type: 'null' - - {} + - type: "null" + - {} created_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true updated_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true extended_attributes_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer deployment_type: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string type: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -2291,105 +2347,105 @@ components: data: type: array items: - $ref: '#/components/schemas/EnvironmentV2' + $ref: "#/components/schemas/EnvironmentV2" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status EnvironmentV2Request: type: object required: - - account_id - - connection_id - - created_by_id - - name - - dbt_project_subdirectory - - use_custom_branch - - custom_branch - - dbt_version - - supports_docs - - repository_id - - state + - account_id + - connection_id + - created_by_id + - name + - dbt_project_subdirectory + - use_custom_branch + - custom_branch + - dbt_version + - supports_docs + - repository_id + - state properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer account_id: type: integer connection_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer project_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer credentials_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer created_by_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 dbt_project_subdirectory: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string use_custom_branch: type: boolean custom_branch: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string dbt_version: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string raw_dbt_version: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string supports_docs: type: boolean repository_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer state: type: integer repository: oneOf: - - type: 'null' - - {} + - type: "null" + - {} jobs: {} connection: oneOf: - - type: 'null' - - {} + - type: "null" + - {} custom_environment_variables: oneOf: - - type: 'null' - - {} + - type: "null" + - {} extended_attributes_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer deployment_type: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string type: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -2406,8 +2462,12 @@ components: description: The project the environment is associated with credentials_id: type: integer - description: The id of the associated credentials. Null for development + description: + The id of the associated credentials. Null for development environments. + connection_id: + type: integer + description: The id of the associated connection. extended_attributes_id: type: integer name: @@ -2417,7 +2477,7 @@ components: type: string description: The default dbt Version to use for this environment type: - $ref: '#/components/schemas/EnvironmentV3TypeEnum' + $ref: "#/components/schemas/EnvironmentV3TypeEnum" use_custom_branch: type: boolean custom_branch: @@ -2427,33 +2487,37 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted deployment_type: - $ref: '#/components/schemas/DeploymentTypeEnum' + $ref: "#/components/schemas/DeploymentTypeEnum" + enable_model_query_history: + type: boolean + default: false required: - - account_id - - dbt_version - - name - - project_id - - supports_docs - - type - - use_custom_branch + - account_id + - dbt_version + - name + - project_id + - supports_docs + - type + - use_custom_branch EnvironmentV3TypeEnum: enum: - - development - - deployment + - development + - deployment type: string description: |- * `development` - DEVELOPMENT * `deployment` - DEPLOYMENT GitCloneStrategyEnum: enum: - - azure_active_directory_app - - deploy_key - - deploy_token - - github_app - - git_token + - azure_active_directory_app + - deploy_key + - deploy_token + - github_app + - git_token type: string description: |- * `azure_active_directory_app` - azure_active_directory_app @@ -2467,15 +2531,41 @@ components: account_id: type: integer provider_type: - $ref: '#/components/schemas/ProviderTypeEnum' + $ref: "#/components/schemas/ProviderTypeEnum" + state: + type: integer + default: 1 + description: + A value of 1 means this entity is active and a value of 2 means + this entity is deleted + required: + - account_id + - provider_type + Group: + type: object + properties: + account_id: + type: integer + name: + type: string + id: + type: integer state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted + assign_by_default: + type: boolean + sso_mapping_groups: + type: array + items: + type: string required: - - account_id - - provider_type + - account_id + - assign_by_default + - name GroupPermission: type: object properties: @@ -2488,7 +2578,7 @@ components: all_projects: type: boolean permission_set: - $ref: '#/components/schemas/PermissionSetEnum' + $ref: "#/components/schemas/PermissionSetEnum" permission_level: type: integer id: @@ -2496,85 +2586,90 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted writable_environment_categories: type: array items: type: string required: - - account_id - - all_projects - - group_id - - permission_set - - writable_environment_categories + - account_id + - all_projects + - group_id + - permission_set + - writable_environment_categories HumanReadableJobDefinition: type: object required: - - id - - environment_id - - account_id - - project_id - - name - - dbt_version - - triggers - - schedule - - settings - - execution - - state - - generate_docs - - run_generate_sources - - run_audit_helper - - run_compare_changes + - id + - environment_id + - account_id + - project_id + - name + - dbt_version + - triggers + - schedule + - settings + - execution + - state + - generate_docs + - run_generate_sources + - run_compare_changes properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer environment_id: type: integer deferring_job_definition_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer deferring_environment_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer lifecycle_webhooks: oneOf: - - type: boolean - - type: 'null' + - type: boolean + - type: "null" lifecycle_webhooks_url: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" account_id: type: integer project_id: type: integer + integration_id: + oneOf: + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 description: allOf: - - type: string - - minLength: 0 - maxLength: 255 + - type: string + - minLength: 0 + maxLength: 255 dbt_version: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" raw_dbt_version: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" triggers: - description: 'Only one of the following fields can be true: triggers.github_webhook, - triggers.schedule, & triggers.git_provider_webhook. The triggers.custom_branch_only - field is now deprecated.' + description: + "Only one of the following fields can be true: triggers.github_webhook, + triggers.schedule, triggers.on_merge & triggers.git_provider_webhook. + The triggers.custom_branch_only field is now deprecated." created_at: type: string format: date-time @@ -2585,47 +2680,43 @@ components: readOnly: true execute_steps: allOf: - - {} - - minLength: 1 - maxLength: 100 - - {} + - {} + - minLength: 1 + maxLength: 100 + - {} schedule: description: schedule is only required if triggers.schedule is true settings: {} execution: {} state: oneOf: - - {} - - {} + - {} + - {} generate_docs: type: boolean run_generate_sources: type: boolean - run_audit_helper: - oneOf: - - type: 'null' - - type: boolean run_compare_changes: oneOf: - - type: 'null' - - type: boolean + - type: "null" + - type: boolean environment: {} account: oneOf: - - {} - - type: 'null' + - {} + - type: "null" project: oneOf: - - {} - - type: 'null' + - {} + - type: "null" most_recent_completed_run: oneOf: - - {} - - type: 'null' + - {} + - type: "null" most_recent_run: oneOf: - - {} - - type: 'null' + - {} + - type: "null" is_deferrable: type: boolean deactivated: @@ -2634,18 +2725,21 @@ components: type: integer job_type: oneOf: - - {} - - {} - - {} - - {} - - type: 'null' + - {} + - {} + - {} + - {} + - {} + - type: "null" + description: Available job types are 'ci', 'merge', 'scheduled', and 'other' triggers_on_draft_pr: type: boolean job_completion_trigger_condition: oneOf: - - {} - - type: 'null' - description: "Use this to set up job completion triggers which would trigger\ + - {} + - type: "null" + description: + "Use this to set up job completion triggers which would trigger\ \ a run of a job when another\n run finishes. If you have a\ \ child job that you want triggered on the completion of a parent job,\n\ \ then configure the trigger on the child job to be on job\ @@ -2669,122 +2763,122 @@ components: data: type: array items: - $ref: '#/components/schemas/HumanReadableJobDefinition' + $ref: "#/components/schemas/HumanReadableJobDefinition" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status HumanReadableJobDefinitionRequest: type: object required: - - id - - environment_id - - account_id - - project_id - - name - - dbt_version - - triggers - - schedule - - settings - - execution - - state - - generate_docs - - run_generate_sources - - run_audit_helper - - run_compare_changes + - id + - environment_id + - account_id + - project_id + - name + - dbt_version + - triggers + - schedule + - settings + - execution + - state + - generate_docs + - run_generate_sources + - run_compare_changes properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer environment_id: type: integer deferring_job_definition_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer deferring_environment_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer lifecycle_webhooks: oneOf: - - type: boolean - - type: 'null' + - type: boolean + - type: "null" lifecycle_webhooks_url: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" account_id: type: integer project_id: type: integer + integration_id: + oneOf: + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 description: allOf: - - type: string - - minLength: 0 - maxLength: 255 + - type: string + - minLength: 0 + maxLength: 255 dbt_version: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" raw_dbt_version: oneOf: - - type: string - - type: 'null' + - type: string + - type: "null" triggers: - description: 'Only one of the following fields can be true: triggers.github_webhook, - triggers.schedule, & triggers.git_provider_webhook. The triggers.custom_branch_only - field is now deprecated.' + description: + "Only one of the following fields can be true: triggers.github_webhook, + triggers.schedule, triggers.on_merge & triggers.git_provider_webhook. + The triggers.custom_branch_only field is now deprecated." execute_steps: allOf: - - {} - - minLength: 1 - maxLength: 100 - - {} + - {} + - minLength: 1 + maxLength: 100 + - {} schedule: description: schedule is only required if triggers.schedule is true settings: {} execution: {} state: oneOf: - - {} - - {} + - {} + - {} generate_docs: type: boolean run_generate_sources: type: boolean - run_audit_helper: - oneOf: - - type: 'null' - - type: boolean run_compare_changes: oneOf: - - type: 'null' - - type: boolean + - type: "null" + - type: boolean environment: {} account: oneOf: - - {} - - type: 'null' + - {} + - type: "null" project: oneOf: - - {} - - type: 'null' + - {} + - type: "null" most_recent_completed_run: oneOf: - - {} - - type: 'null' + - {} + - type: "null" most_recent_run: oneOf: - - {} - - type: 'null' + - {} + - type: "null" is_deferrable: type: boolean deactivated: @@ -2793,18 +2887,21 @@ components: type: integer job_type: oneOf: - - {} - - {} - - {} - - {} - - type: 'null' + - {} + - {} + - {} + - {} + - {} + - type: "null" + description: Available job types are 'ci', 'merge', 'scheduled', and 'other' triggers_on_draft_pr: type: boolean job_completion_trigger_condition: oneOf: - - {} - - type: 'null' - description: "Use this to set up job completion triggers which would trigger\ + - {} + - type: "null" + description: + "Use this to set up job completion triggers which would trigger\ \ a run of a job when another\n run finishes. If you have a\ \ child job that you want triggered on the completion of a parent job,\n\ \ then configure the trigger on the child job to be on job\ @@ -2824,90 +2921,73 @@ components: $schema: http://json-schema.org/draft-07/schema# Invite: type: object - required: - - id - - account_id - - email_address - - license_type - - status properties: - id: - oneOf: - - type: 'null' - - type: integer account_id: type: integer email_address: - oneOf: - - type: 'null' - - type: string + type: string license_type: - oneOf: - - {} - - {} - - {} + $ref: "#/components/schemas/LicenseTypeEnum" status: - oneOf: - - {} - - {} - - {} - - {} - - {} - code: - type: string + $ref: "#/components/schemas/StatusEnum" + id: + type: integer + group_ids: + type: array + items: + type: integer + default: [] created_at: type: string format: date-time readOnly: true redeemed_at: - oneOf: - - type: 'null' - - type: string - format: date-time - group_ids: - allOf: - - {} - - {} - account: {} + type: string + format: date-time + readOnly: true + account: + readOnly: true groups: - allOf: - - {} - - {} - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + type: array + items: + $ref: "#/components/schemas/Group" + readOnly: true + default: [] + required: + - account + - created_at + - groups + - redeemed_at InviteEnveloped: type: object properties: data: - type: array - items: - $ref: '#/components/schemas/Invite' + $ref: "#/components/schemas/Invite" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status JobDefinitionExecution: type: object properties: timeout_seconds: type: integer required: - - timeout_seconds + - timeout_seconds JobDefinitionSchedule: type: object properties: cron: type: string date: - $ref: '#/components/schemas/DateEnum' + $ref: "#/components/schemas/DateEnum" time: - $ref: '#/components/schemas/TimeEnum' + $ref: "#/components/schemas/TimeEnum" required: - - cron - - date - - time + - cron + - date + - time JobDefinitionSettings: type: object properties: @@ -2916,8 +2996,8 @@ components: target_name: type: string required: - - target_name - - threads + - target_name + - threads JobDefinitionTriggers: type: object properties: @@ -2930,8 +3010,8 @@ components: on_merge: type: boolean required: - - github_webhook - - schedule + - github_webhook + - schedule JobDefinitionV2: type: object properties: @@ -2952,85 +3032,81 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted dbt_version: type: string triggers: - $ref: '#/components/schemas/JobDefinitionTriggers' + $ref: "#/components/schemas/JobDefinitionTriggers" settings: - $ref: '#/components/schemas/JobDefinitionSettings' + $ref: "#/components/schemas/JobDefinitionSettings" execution: - $ref: '#/components/schemas/JobDefinitionExecution' + $ref: "#/components/schemas/JobDefinitionExecution" schedule: - $ref: '#/components/schemas/JobDefinitionSchedule' + $ref: "#/components/schemas/JobDefinitionSchedule" execute_steps: type: array items: type: string + environment: + $ref: "#/components/schemas/EnvironmentV3" most_recent_run: - $ref: '#/components/schemas/Run' + $ref: "#/components/schemas/Run" most_recent_completed_run: - $ref: '#/components/schemas/Run' + $ref: "#/components/schemas/Run" job_type: - $ref: '#/components/schemas/JobTypeEnum' + $ref: "#/components/schemas/JobTypeEnum" triggers_on_draft_pr: type: boolean default: false - run_audit_helper: - type: boolean - default: false run_compare_changes: type: boolean default: false required: - - account_id - - environment_id - - generate_docs - - name - - project_id - - run_generate_sources + - account_id + - environment_id + - generate_docs + - name + - project_id + - run_generate_sources JobNotificationSettings: type: object - required: - - id - - account_id - - type - - state - - on_cancel - - on_failure - - on_success - - on_warning - - user_id properties: - id: - oneOf: - - type: 'null' - - type: integer account_id: type: integer + description: The account the job notification setting is associated with + user_id: + type: integer + description: + For internal email notifications, the ID of the user to send + notifications to. For all other notifications, the ID of the user who + created the configuration. type: - oneOf: - - {} - - {} - - {} - - {} - description: "\n The destination type.\n 1:\ + allOf: + - $ref: "#/components/schemas/JobNotificationSettingsTypeEnum" + description: + "\n The destination type.\n 1:\ \ Internal Email\n 2: Slack\n 3: Deprecated\ - \ - do not use\n 4: External Email\n " - state: - type: integer - on_cancel: - description: List of job IDs to send notifications for when the job is cancelled. - on_failure: - description: List of job IDs to send notifications for when the job fails. - on_success: - description: List of job IDs to send notifications for when the job succeeds. - on_warning: - oneOf: - - {} - - type: 'null' - description: List of job IDs to send notifications for when the job warns. + \ - do not use\n 4: External Email\n \n\n* `1`\ + \ - EMAIL\n* `2` - SLACK\n* `3` - WEBHOOK\n* `4` - EXTERNAL_EMAIL" + external_email: + type: string + description: + The external email to send notifications to. Required for External + Email types. + slack_channel_id: + type: string + description: + The ID of the Slack channel to send notifications to. Required + for Slack notification types. + slack_channel_name: + type: string + description: + The name of the Slack channel to send notifications to. Required + for Slack notification types. + id: + type: integer created_at: type: string format: date-time @@ -3039,135 +3115,166 @@ components: type: string format: date-time readOnly: true - user_id: + state: type: integer - description: For internal email notifications, the ID of the user to send - notifications to. For all other notifications, the ID of the user who - created the configuration. - external_email: - oneOf: - - type: string - - type: 'null' - description: The external email to send notifications to. Required for External - Email types. + default: 1 user: - oneOf: - - {} - - type: 'null' - description: For internal email notifications, the user to send notifications + allOf: + - $ref: "#/components/schemas/User" + readOnly: true + description: + For internal email notifications, the user to send notifications to. For all other notifications, the user who created the configuration. - slack_channel_id: - oneOf: - - type: string - - type: 'null' - description: The ID of the Slack channel to send notifications to. Required - for Slack notification types. - slack_channel_name: - oneOf: - - type: string - - type: 'null' - description: The name of the Slack channel to send notifications to. Required - for Slack notification types. - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + on_cancel: + type: array + items: + type: integer + default: [] + description: List of job IDs to send notifications for when the job is cancelled. + on_failure: + type: array + items: + type: integer + default: [] + description: List of job IDs to send notifications for when the job fails. + on_success: + type: array + items: + type: integer + default: [] + description: List of job IDs to send notifications for when the job succeeds. + on_warning: + type: array + items: + type: integer + default: [] + description: List of job IDs to send notifications for when the job warns. + required: + - created_at + - updated_at + - user JobNotificationSettingsEnveloped: type: object properties: data: - type: array - items: - $ref: '#/components/schemas/JobNotificationSettings' + $ref: "#/components/schemas/JobNotificationSettings" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status JobNotificationSettingsRequest: type: object - required: - - id - - account_id - - type - - state - - on_cancel - - on_failure - - on_success - - on_warning - - user_id properties: - id: - oneOf: - - type: 'null' - - type: integer account_id: type: integer + description: The account the job notification setting is associated with + user_id: + type: integer + description: + For internal email notifications, the ID of the user to send + notifications to. For all other notifications, the ID of the user who + created the configuration. type: - oneOf: - - {} - - {} - - {} - - {} - description: "\n The destination type.\n 1:\ + allOf: + - $ref: "#/components/schemas/JobNotificationSettingsTypeEnum" + description: + "\n The destination type.\n 1:\ \ Internal Email\n 2: Slack\n 3: Deprecated\ - \ - do not use\n 4: External Email\n " + \ - do not use\n 4: External Email\n \n\n* `1`\ + \ - EMAIL\n* `2` - SLACK\n* `3` - WEBHOOK\n* `4` - EXTERNAL_EMAIL" + external_email: + type: string + minLength: 1 + description: + The external email to send notifications to. Required for External + Email types. + slack_channel_id: + type: string + minLength: 1 + description: + The ID of the Slack channel to send notifications to. Required + for Slack notification types. + slack_channel_name: + type: string + minLength: 1 + description: + The name of the Slack channel to send notifications to. Required + for Slack notification types. + id: + type: integer state: type: integer + default: 1 + description: + A value of 1 means this entity is active and a value of 2 means + this entity is deleted on_cancel: + type: array + items: + type: integer description: List of job IDs to send notifications for when the job is cancelled. on_failure: + type: array + items: + type: integer description: List of job IDs to send notifications for when the job fails. on_success: + type: array + items: + type: integer description: List of job IDs to send notifications for when the job succeeds. on_warning: - oneOf: - - {} - - type: 'null' + type: array + items: + type: integer description: List of job IDs to send notifications for when the job warns. - user_id: - type: integer - description: For internal email notifications, the ID of the user to send - notifications to. For all other notifications, the ID of the user who - created the configuration. - external_email: - oneOf: - - type: string - - type: 'null' - description: The external email to send notifications to. Required for External - Email types. - user: - oneOf: - - {} - - type: 'null' - description: For internal email notifications, the user to send notifications - to. For all other notifications, the user who created the configuration. - slack_channel_id: - oneOf: - - type: string - - type: 'null' - description: The ID of the Slack channel to send notifications to. Required - for Slack notification types. - slack_channel_name: - oneOf: - - type: string - - type: 'null' - description: The name of the Slack channel to send notifications to. Required - for Slack notification types. - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + required: + - account_id + - on_cancel + - on_failure + - on_success + - on_warning + - type + - user_id + JobNotificationSettingsTypeEnum: + enum: + - 1 + - 2 + - 3 + - 4 + type: integer + description: |- + * `1` - EMAIL + * `2` - SLACK + * `3` - WEBHOOK + * `4` - EXTERNAL_EMAIL JobTypeEnum: enum: - - ci - - scheduled - - other - - merge + - ci + - scheduled + - other + - merge + - exposure_sync type: string description: |- * `ci` - ci * `scheduled` - scheduled * `other` - other * `merge` - merge + * `exposure_sync` - exposure_sync + LicenseTypeEnum: + enum: + - developer + - read_only + - it + - explorer + type: string + description: |- + * `developer` - DEVELOPER + * `read_only` - READ_ONLY + * `it` - IT + * `explorer` - EXPLORER ListOfStringsEnveloped: type: object properties: @@ -3176,56 +3283,58 @@ components: items: type: string status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status PermissionSetEnum: enum: - - owner - - member - - account_admin - - security_admin - - billing_admin - - admin - - database_admin - - git_admin - - team_admin - - job_admin - - job_runner - - job_viewer - - analyst - - developer - - stakeholder - - readonly - - project_creator - - account_viewer - - metadata_only - - semantic_layer_only - - webhooks_only + - owner + - member + - account_admin + - security_admin + - billing_admin + - admin + - database_admin + - git_admin + - team_admin + - job_admin + - job_runner + - job_viewer + - analyst + - developer + - stakeholder + - readonly + - project_creator + - account_viewer + - metadata_only + - semantic_layer_only + - webhooks_only + - manage_marketplace_apps type: string description: |- - * `owner` - owner - * `member` - member - * `account_admin` - account_admin - * `security_admin` - security_admin - * `billing_admin` - billing_admin - * `admin` - admin - * `database_admin` - database_admin - * `git_admin` - git_admin - * `team_admin` - team_admin - * `job_admin` - job_admin - * `job_runner` - job_runner - * `job_viewer` - job_viewer - * `analyst` - analyst - * `developer` - developer - * `stakeholder` - stakeholder - * `readonly` - readonly - * `project_creator` - project_creator - * `account_viewer` - account_viewer - * `metadata_only` - metadata_only - * `semantic_layer_only` - semantic_layer_only - * `webhooks_only` - webhooks_only + * `owner` - OWNER + * `member` - MEMBER + * `account_admin` - ACCOUNT_ADMIN + * `security_admin` - SECURITY_ADMIN + * `billing_admin` - BILLING_ADMIN + * `admin` - ADMIN + * `database_admin` - DATABASE_ADMIN + * `git_admin` - GIT_ADMIN + * `team_admin` - TEAM_ADMIN + * `job_admin` - JOB_ADMIN + * `job_runner` - JOB_RUNNER + * `job_viewer` - JOB_VIEWER + * `analyst` - ANALYST + * `developer` - DEVELOPER + * `stakeholder` - STAKEHOLDER + * `readonly` - READONLY + * `project_creator` - PROJECT_CREATOR + * `account_viewer` - ACCOUNT_VIEWER + * `metadata_only` - METADATA_ONLY + * `semantic_layer_only` - SEMANTIC_LAYER_ONLY + * `webhooks_only` - WEBHOOKS_ONLY + * `manage_marketplace_apps` - MANAGE_MARKETPLACE_APPS Project: type: object properties: @@ -3267,21 +3376,21 @@ components: type: string connection: allOf: - - $ref: '#/components/schemas/BaseConnectionV3' + - $ref: "#/components/schemas/BaseConnectionV3" readOnly: true environments: type: array items: - $ref: '#/components/schemas/EnvironmentV3' + $ref: "#/components/schemas/EnvironmentV3" readOnly: true repository: allOf: - - $ref: '#/components/schemas/RepositoryV3' + - $ref: "#/components/schemas/RepositoryV3" readOnly: true group_permissions: type: array items: - $ref: '#/components/schemas/GroupPermission' + $ref: "#/components/schemas/GroupPermission" readOnly: true docs_job_id: type: integer @@ -3291,31 +3400,31 @@ components: description: The job used for source freshness generation docs_job: allOf: - - $ref: '#/components/schemas/JobDefinitionV2' + - $ref: "#/components/schemas/JobDefinitionV2" readOnly: true freshness_job: allOf: - - $ref: '#/components/schemas/JobDefinitionV2' + - $ref: "#/components/schemas/JobDefinitionV2" readOnly: true required: - - connection - - created_at - - docs_job - - environments - - freshness_job - - group_permissions - - repository - - updated_at + - connection + - created_at + - docs_job + - environments + - freshness_job + - group_permissions + - repository + - updated_at ProjectEnveloped: type: object properties: data: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ProjectRequest: type: object properties: @@ -3347,7 +3456,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted dbt_project_subdirectory: type: string @@ -3359,16 +3469,16 @@ components: type: integer description: The job used for source freshness generation required: - - account_id - - name + - account_id + - name ProviderTypeEnum: enum: - - azure_active_directory - - github - - gitlab - - git_url - - managed_github - - manual_config + - azure_active_directory + - github + - gitlab + - git_url + - managed_github + - manual_config type: string description: |- * `azure_active_directory` - azure_active_directory @@ -3379,11 +3489,11 @@ components: * `manual_config` - manual_config RemoteBackendEnum: enum: - - azure_active_directory - - github - - managed - - gitlab - - manual_config + - azure_active_directory + - github + - managed + - gitlab + - manual_config type: string description: |- * `azure_active_directory` - azure_active_directory @@ -3405,7 +3515,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted project_access_token_id: type: integer @@ -3413,76 +3524,79 @@ components: type: string format: date-time required: - - account_id - - gitlab_project_id + - account_id + - gitlab_project_id RepositoryV2: type: object required: - - id - - account_id - - full_name - - remote_url - - remote_backend - - git_clone_strategy - - deploy_key_id - - github_installation_id - - pull_request_url_template - - state + - id + - account_id + - full_name + - remote_url + - remote_backend + - git_clone_strategy + - deploy_key_id + - github_installation_id + - pull_request_url_template + - state properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer account_id: type: integer project_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer full_name: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string remote_url: oneOf: - - type: 'null' - - allOf: - - type: string - - pattern: ^\S+[/:](?P[^\s/]+?)(?:\.git)?$ + - type: "null" + - allOf: + - type: string + - pattern: ^\S+[/:](?P[^\s/]+?)(?:\.git)?$ remote_backend: oneOf: - - {} - - {} - - {} - - {} - - type: 'null' + - {} + - {} + - {} + - {} + - type: "null" git_clone_strategy: oneOf: - - {} - - {} - - {} - - {} - deploy_key: {} + - {} + - {} + - {} + - {} + deploy_key: + oneOf: + - type: "null" + - {} deploy_key_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer repository_credentials_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer github_installation_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer github_webhook_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer pull_request_url_template: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string state: type: integer created_at: @@ -3495,12 +3609,12 @@ components: readOnly: true git_provider_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer private_link_endpoint_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -3510,90 +3624,93 @@ components: data: type: array items: - $ref: '#/components/schemas/RepositoryV2' + $ref: "#/components/schemas/RepositoryV2" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status RepositoryV2Request: type: object required: - - id - - account_id - - full_name - - remote_url - - remote_backend - - git_clone_strategy - - deploy_key_id - - github_installation_id - - pull_request_url_template - - state + - id + - account_id + - full_name + - remote_url + - remote_backend + - git_clone_strategy + - deploy_key_id + - github_installation_id + - pull_request_url_template + - state properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer account_id: type: integer project_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer full_name: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string remote_url: oneOf: - - type: 'null' - - allOf: - - type: string - - pattern: ^\S+[/:](?P[^\s/]+?)(?:\.git)?$ + - type: "null" + - allOf: + - type: string + - pattern: ^\S+[/:](?P[^\s/]+?)(?:\.git)?$ remote_backend: oneOf: - - {} - - {} - - {} - - {} - - type: 'null' + - {} + - {} + - {} + - {} + - type: "null" git_clone_strategy: oneOf: - - {} - - {} - - {} - - {} - deploy_key: {} + - {} + - {} + - {} + - {} + deploy_key: + oneOf: + - type: "null" + - {} deploy_key_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer repository_credentials_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer github_installation_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer github_webhook_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer pull_request_url_template: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string state: type: integer git_provider_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer private_link_endpoint_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -3613,7 +3730,7 @@ components: description: The name of the repo remote_backend: allOf: - - $ref: '#/components/schemas/RemoteBackendEnum' + - $ref: "#/components/schemas/RemoteBackendEnum" description: |- The associated git provider @@ -3624,7 +3741,7 @@ components: * `manual_config` - manual_config git_clone_strategy: allOf: - - $ref: '#/components/schemas/GitCloneStrategyEnum' + - $ref: "#/components/schemas/GitCloneStrategyEnum" description: |- The strategy to use when cloning the repo @@ -3644,30 +3761,19 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string git_provider_id: type: integer gitlab: - $ref: '#/components/schemas/RepositoryGitlab' + $ref: "#/components/schemas/RepositoryGitlab" git_provider: - $ref: '#/components/schemas/GitProvider' + $ref: "#/components/schemas/GitProvider" required: - - account_id - RetryNotSupportedReasonEnum: - enum: - - RETRY_UNSUPPORTED_CMD - - RETRY_UNSUPPORTED_VERSION - - RETRY_NOT_LATEST_RUN - - RETRY_NOT_FAILED_RUN - type: string - description: |- - * `RETRY_UNSUPPORTED_CMD` - RETRY_UNSUPPORTED_CMD - * `RETRY_UNSUPPORTED_VERSION` - RETRY_UNSUPPORTED_VERSION - * `RETRY_NOT_LATEST_RUN` - RETRY_NOT_LATEST_RUN - * `RETRY_NOT_FAILED_RUN` - RETRY_NOT_FAILED_RUN + - account_id Run: type: object properties: @@ -3716,219 +3822,31 @@ components: is_running: type: boolean required: - - account_id - - artifacts_saved - - blocked_by - - dbt_version - - environment_id - - has_docs_generated - - has_sources_generated - - job_definition_id - - notifications_sent - - project_id - - status - RunResponse: - type: object - properties: - id: - type: integer - trigger_id: - type: integer - account_id: - type: integer - environment_id: - type: integer - project_id: - type: integer - job_definition_id: - type: integer - status: - type: integer - dbt_version: - type: string - git_branch: - type: string - git_sha: - type: string - status_message: - type: string - owner_thread_id: - type: string - executed_by_thread_id: - type: string - deferring_run_id: - type: integer - artifacts_saved: - type: boolean - artifact_s3_path: - type: string - has_docs_generated: - type: boolean - has_sources_generated: - type: boolean - notifications_sent: - type: boolean - blocked_by: - type: array - items: - type: integer - created_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - dequeued_at: - type: string - format: date-time - started_at: - type: string - format: date-time - finished_at: - type: string - format: date-time - last_checked_at: - type: string - format: date-time - last_heartbeat_at: - type: string - format: date-time - should_start_at: - type: string - format: date-time - job: {} - environment: {} - status_humanized: - type: string - in_progress: - type: boolean - is_complete: - type: boolean - is_success: - type: boolean - is_error: - type: boolean - is_cancelled: - type: boolean - duration: - type: string - queued_duration: - type: string - run_duration: - type: string - duration_humanized: - type: string - queued_duration_humanized: - type: string - run_duration_humanized: - type: string - created_at_humanized: - type: string - finished_at_humanized: - type: string - retrying_run_id: - type: integer - can_retry: - type: boolean - retry_not_supported_reason: - $ref: '#/components/schemas/RetryNotSupportedReasonEnum' - job_id: - type: integer - is_running: - type: boolean - href: - type: string - used_repo_cache: - type: boolean - required: - - created_at - - updated_at + - account_id + - artifacts_saved + - blocked_by + - dbt_version + - environment_id + - has_docs_generated + - has_sources_generated + - job_definition_id + - notifications_sent + - project_id + - status RunResponseEnveloped: type: object properties: - data: - $ref: '#/components/schemas/RunResponse' - status: - $ref: '#/components/schemas/Status' - required: - - data - - status - RunStep: - type: object - properties: - id: - type: integer - run_id: - type: integer - account_id: - type: integer - index: - type: integer status: - type: integer - name: - type: string - logs: - type: string - debug_logs: - type: string - log_path: - type: string - debug_log_path: - type: string - truncated_debug_logs: - type: string - readOnly: true - created_at: - type: string - format: date-time - readOnly: true - updated_at: - type: string - format: date-time - readOnly: true - started_at: - type: string - format: date-time - readOnly: true - finished_at: - type: string - format: date-time - readOnly: true - status_color: - type: string - readOnly: true - status_humanized: - type: string - readOnly: true - duration: - type: string - readOnly: true - duration_humanized: - type: string - readOnly: true + $ref: "#/components/schemas/Status" required: - - created_at - - duration - - duration_humanized - - finished_at - - started_at - - status_color - - status_humanized - - truncated_debug_logs - - updated_at + - status RunStepEnveloped: type: object properties: - data: - $ref: '#/components/schemas/RunStep' status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - status Status: type: object properties: @@ -3942,13 +3860,27 @@ components: developer_message: type: string required: - - developer_message - - is_success - - user_message + - developer_message + - is_success + - user_message + StatusEnum: + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + type: integer + description: |- + * `1` - PENDING + * `2` - REDEEMED + * `3` - EXPIRED + * `4` - PENDING_EMAIL_VERIFICATION + * `5` - EMAIL_VERIFIED_SSO TimeEnum: enum: - - every_hour - - at_exact_hours + - every_hour + - at_exact_hours type: string description: |- * `every_hour` - every_hour @@ -3979,7 +3911,7 @@ components: dbt_version_override: type: string minLength: 1 - description: 'Allowed values are: ' + description: "Allowed values are: " threads_override: type: integer target_name_override: @@ -3995,311 +3927,193 @@ components: type: string minLength: 1 required: - - cause + - cause User: type: object - required: - - id - - first_name - - last_name - - email - - is_staff - - github_connected - - github_username - - gitlab_connected - - gitlab_username - - azure_active_directory_connected - - azure_active_directory_username - - email_connected - - email_verified - - enterprise_connected properties: - id: - oneOf: - - type: 'null' - - type: integer - auth0_user_id: - oneOf: - - type: 'null' - - type: string - auth0_database_user_id: - type: string first_name: type: string last_name: type: string email: type: string - is_staff: - type: boolean - is_active: - type: boolean - created_at: + apitoken_last_used: type: string format: date-time - readOnly: true - last_login: - oneOf: - - type: 'null' - - type: string - format: date-time - github_connected: - oneOf: - - type: 'null' - - type: boolean - github_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - github_access_token: - oneOf: - - type: 'null' - - type: string - github_username: - oneOf: - - type: 'null' - - type: string - gitlab_connected: - oneOf: - - type: 'null' - - type: boolean - gitlab_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - gitlab_access_token: - oneOf: - - type: 'null' - - type: string - gitlab_username: - oneOf: - - type: 'null' - - type: string azure_active_directory_connected: - oneOf: - - type: 'null' - - type: boolean - azure_active_directory_access_token: - oneOf: - - type: 'null' - - type: string - azure_active_directory_username: - oneOf: - - type: 'null' - - type: string + type: boolean azure_active_directory_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean + type: boolean + azure_active_directory_username: + type: string email_connected: - oneOf: - - type: 'null' - - type: boolean + type: boolean email_verified: type: boolean enterprise_connected: - oneOf: - - type: 'null' - - type: boolean + type: boolean enterprise_authentication_method: - oneOf: - - type: 'null' - - type: string - enterprise_idp_attributes: - oneOf: - - type: 'null' - - {} - auth_provider_infos: - oneOf: - - type: 'null' - - {} - api_key: type: string - password: - allOf: - - minLength: 9 - - type: string - confirm_password: + github_connected: + type: boolean + github_username: type: string - permissions: {} - licenses: {} - user_feature_flags: {} - apitoken_last_used: - oneOf: - - type: 'null' - - type: string - format: date-time + gitlab_connected: + type: boolean + gitlab_username: + type: string + id: + type: integer + is_active: + type: boolean + is_staff: + type: boolean sso_only_user: - oneOf: - - type: 'null' - - type: boolean - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + type: boolean + github_token_retrieval_failure: + type: boolean + gitlab_token_retrieval_failure: + type: boolean + required: + - azure_active_directory_connected + - email + - email_connected + - email_verified + - enterprise_connected + - first_name + - github_connected + - gitlab_connected + - is_active + - is_staff + - last_name UserEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status UserRequest: type: object - required: - - id - - first_name - - last_name - - email - - is_staff - - github_connected - - github_username - - gitlab_connected - - gitlab_username - - azure_active_directory_connected - - azure_active_directory_username - - email_connected - - email_verified - - enterprise_connected properties: - id: - oneOf: - - type: 'null' - - type: integer - auth0_user_id: - oneOf: - - type: 'null' - - type: string - auth0_database_user_id: - type: string first_name: type: string + minLength: 1 last_name: type: string + minLength: 1 email: type: string - is_staff: + minLength: 1 + auth0_database_user_id: + type: string + writeOnly: true + minLength: 1 + auth0_user_id: + type: string + writeOnly: true + minLength: 1 + api_key: + type: string + writeOnly: true + minLength: 1 + apitoken_last_used: + type: string + format: date-time + azure_active_directory_access_token: + type: string + writeOnly: true + minLength: 1 + azure_active_directory_connected: type: boolean - is_active: + azure_active_directory_token_retrieval_failure: type: boolean - last_login: - oneOf: - - type: 'null' - - type: string - format: date-time - github_connected: - oneOf: - - type: 'null' - - type: boolean - github_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - github_access_token: - oneOf: - - type: 'null' - - type: string - github_username: - oneOf: - - type: 'null' - - type: string - gitlab_connected: - oneOf: - - type: 'null' - - type: boolean - gitlab_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - gitlab_access_token: - oneOf: - - type: 'null' - - type: string - gitlab_username: - oneOf: - - type: 'null' - - type: string - azure_active_directory_connected: - oneOf: - - type: 'null' - - type: boolean - azure_active_directory_access_token: - oneOf: - - type: 'null' - - type: string azure_active_directory_username: - oneOf: - - type: 'null' - - type: string - azure_active_directory_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean + type: string + minLength: 1 + confirm_password: + type: string + writeOnly: true + minLength: 1 email_connected: - oneOf: - - type: 'null' - - type: boolean + type: boolean email_verified: type: boolean enterprise_connected: - oneOf: - - type: 'null' - - type: boolean + type: boolean enterprise_authentication_method: - oneOf: - - type: 'null' - - type: string + type: string + minLength: 1 enterprise_idp_attributes: - oneOf: - - type: 'null' - - {} - auth_provider_infos: - oneOf: - - type: 'null' - - {} - api_key: + writeOnly: true + github_connected: + type: boolean + github_username: + type: string + minLength: 1 + gitlab_connected: + type: boolean + gitlab_username: type: string + minLength: 1 + id: + type: integer + is_active: + type: boolean + is_staff: + type: boolean password: - allOf: - - minLength: 9 - - type: string - confirm_password: type: string - permissions: {} - licenses: {} - user_feature_flags: {} - apitoken_last_used: - oneOf: - - type: 'null' - - type: string - format: date-time + writeOnly: true + minLength: 1 sso_only_user: - oneOf: - - type: 'null' - - type: boolean - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + type: boolean + github_token_retrieval_failure: + type: boolean + github_access_token: + type: string + writeOnly: true + minLength: 1 + gitlab_token_retrieval_failure: + type: boolean + gitlab_access_token: + type: string + writeOnly: true + minLength: 1 + required: + - azure_active_directory_connected + - email + - email_connected + - email_verified + - enterprise_connected + - first_name + - github_connected + - gitlab_connected + - is_active + - is_staff + - last_name securitySchemes: BearerAuthentication: type: http scheme: bearer bearerFormat: Bearer servers: -- url: https://cloud.getdbt.com/ - description: Production (US) -- url: https://{account_prefix}.us1.dbt.com/ - description: Production (US) - variables: - account_prefix: - default: ab123 - description: Your unique account prefix. Can be found on your account settings - page. -- url: https://emea.dbt.com/ - description: Production (Europe) -- url: https://au.dbt.com/ - description: Production (AU) + - url: https://cloud.getdbt.com/ + description: Production (US) + - url: https://{account_prefix}.us1.dbt.com/ + description: Production (US) + variables: + account_prefix: + default: ab123 + description: + Your unique account prefix. Can be found on your account settings + page. + - url: https://emea.dbt.com/ + description: Production (Europe) + - url: https://au.dbt.com/ + description: Production (AU) diff --git a/openapi-v3.yaml b/openapi-v3.yaml index 44ed6cd..2808069 100644 --- a/openapi-v3.yaml +++ b/openapi-v3.yaml @@ -18,12 +18,12 @@ info: ## Authentication To authenticate an application with the dbt Cloud API, navigate to the - API Settings page in your [dbt Cloud profile](https://cloud.getdbt.com/#/profile/api/). + Account Settings page and go to Personal Tokens from the left sidebar. Create one if you don't have one already. If you cannot access this page, confirm that your dbt Cloud account has access to the API, and that you are using the hosted version of dbt Cloud. If dbt Cloud is running inside of a VPC - in an Enterprise account, contact your account manager for help finding your API key. + in an Enterprise account, contact your account manager for help finding your account-scoped Personal Access Token. - Once you've found your API key, use it in the Authorization header of requests to the dbt Cloud API. + Once you've found your Personal Access Token (PAT) for your account, use it in the Authorization header of requests to the dbt Cloud API. Be sure to include the `Token` prefix in the Authorization header, or the request will fail with a "401 Unauthorized" error. @@ -64,31 +64,31 @@ paths: operationId: List Accounts description: List accounts tags: - - Accounts + - Accounts security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AccountEnveloped' - description: '' + $ref: "#/components/schemas/AccountEnveloped" + description: "" /api/v3/accounts/{account_id}/assign-groups/: post: operationId: Assign User to Groups parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Groups + - Groups security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/audit-logs/: get: @@ -98,22 +98,22 @@ paths: Note: This API is only available to enterprise customers. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Audit Logs + - Audit Logs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PublicAuditLogEnveloped' - description: '' + $ref: "#/components/schemas/PublicAuditLogEnveloped" + description: "" /api/v3/accounts/{account_id}/audit-logs/download/: get: operationId: Get Recent Audit Log Events CSV @@ -122,17 +122,17 @@ paths: Note: This API is only available to enterprise customers. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Audit Logs + - Audit Logs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/audit-logs/export/: get: @@ -142,17 +142,17 @@ paths: Note: This API is only available to enterprise customers. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Audit Logs + - Audit Logs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body post: operationId: Submit Bulk Audit Log Export Request @@ -161,17 +161,17 @@ paths: Note: This API is only available to enterprise customers. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Audit Logs + - Audit Logs security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/audit-logs/export/{job_id}/download/: get: @@ -181,243 +181,406 @@ paths: Note: This API is only available to enterprise customers. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: job_id - schema: - type: string + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: job_id + schema: + type: string + required: true + tags: + - Audit Logs + security: + - BearerAuthentication: [] + responses: + "200": + description: No response body + /api/v3/accounts/{account_id}/connections/: + get: + operationId: List Account Connections + description: + This is our new list endpoint for connections. Connections are + now account-scoped + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: adapter_version + schema: + type: string + enum: + - apache_spark_v0 + - athena_v0 + - bigquery_v0 + - databricks_spark_v0 + - databricks_v0 + - fabric_v0 + - postgres_v0 + - redshift_v0 + - snowflake_v0 + - synapse_v0 + - trino_v0 + description: The adapter to fetch the connections for + tags: + - Connections + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ListListAccountConnectionResponse" + description: "" + post: + operationId: Create Account Connection + description: + This our new post endpoint for connections. Connections are now + account-scoped + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + tags: + - Connections + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PostAccountConnectionRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/PostAccountConnectionRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/PostAccountConnectionRequest" required: true + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetAccountConnectionResponse" + description: "" + /api/v3/accounts/{account_id}/connections/{id}/: + get: + operationId: Get Account Connection + description: + This our new get endpoint for connections. Connections are now + account-scoped + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + tags: + - Connections + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetAccountConnectionResponse" + description: "" + patch: + operationId: Update Account Connection + description: + This our new patch endpoint for connections. Connections are now + account-scoped + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + tags: + - Connections + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PatchAccountConnectionRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/PatchAccountConnectionRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/PatchAccountConnectionRequest" + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetAccountConnectionResponse" + description: "" + delete: + operationId: Delete Account Connection + description: + This our new delete endpoint for connections. Connections are now + account-scoped + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Audit Logs + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "204": description: No response body /api/v3/accounts/{account_id}/group-permissions/{group_id}/: post: operationId: Assign Group Permissions parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: group_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: group_id + schema: + type: integer + required: true tags: - - Groups + - Groups security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/groups/: get: operationId: List Groups parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: pk__in - schema: - type: array - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: pk__in + schema: + type: array + - in: query + name: state + schema: + type: integer tags: - - Groups + - Groups security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/GroupEnveloped' - description: '' + $ref: "#/components/schemas/GroupEnveloped" + description: "" post: operationId: Create Group parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Groups + - Groups requestBody: content: application/json: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" multipart/form-data: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GroupEnveloped' - description: '' + $ref: "#/components/schemas/GroupEnveloped" + description: "" /api/v3/accounts/{account_id}/groups/{id}/: get: operationId: Retrieve Group parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Groups + - Groups security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GroupEnveloped' - description: '' + $ref: "#/components/schemas/GroupEnveloped" + description: "" post: operationId: Update Group parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Groups + - Groups requestBody: content: application/json: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" multipart/form-data: schema: - $ref: '#/components/schemas/GroupRequest' + $ref: "#/components/schemas/GroupRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GroupEnveloped' - description: '' + $ref: "#/components/schemas/GroupEnveloped" + description: "" /api/v3/accounts/{account_id}/invites/: post: operationId: Send user invites description: Send email invites to users who you wish to add to this account parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Invites + - Invites requestBody: content: application/json: schema: - $ref: '#/components/schemas/InviteUsersRequestRequest' + $ref: "#/components/schemas/InviteUsersRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/InviteUsersRequestRequest' + $ref: "#/components/schemas/InviteUsersRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/InviteUsersRequestRequest' + $ref: "#/components/schemas/InviteUsersRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/InviteUsersResponseEnveloped' - description: '' + $ref: "#/components/schemas/InviteUsersResponseEnveloped" + description: "" /api/v3/accounts/{account_id}/ip-restrictions/: get: operationId: List IP Restrictions parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionRuleEnveloped' - description: '' + $ref: "#/components/schemas/IPRestrictionRuleEnveloped" + description: "" post: operationId: Save IP Restriction description: |- @@ -426,62 +589,62 @@ paths: Note: As long as at least one cidr was successfully saved a 2XX will be returned. Check the `extra` key within the response for a list of cidrs that failed to save. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionRequestRequest' + $ref: "#/components/schemas/IPRestrictionRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/IPRestrictionRequestRequest' + $ref: "#/components/schemas/IPRestrictionRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/IPRestrictionRequestRequest' + $ref: "#/components/schemas/IPRestrictionRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionRuleEnveloped' - description: '' + $ref: "#/components/schemas/IPRestrictionRuleEnveloped" + description: "" /api/v3/accounts/{account_id}/ip-restrictions-set/: post: operationId: Enable IP Restrictions description: Toggle the enablement of the IP restriction feature. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionSetRequestRequest' + $ref: "#/components/schemas/IPRestrictionSetRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/IPRestrictionSetRequestRequest' + $ref: "#/components/schemas/IPRestrictionSetRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/IPRestrictionSetRequestRequest' + $ref: "#/components/schemas/IPRestrictionSetRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/ip-restrictions-set/{id}/validate/: get: @@ -490,87 +653,88 @@ paths: This endpoint returns whether the client ip is acceptable based on the configured ip restriction rules associated to the rule set. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionSetValidate' - description: '' + $ref: "#/components/schemas/IPRestrictionSetValidate" + description: "" /api/v3/accounts/{account_id}/ip-restrictions-set/{id}/validate/{rule_id}: get: - operationId: Validate Client IP Against IP Restrictions Excluding Specified + operationId: + Validate Client IP Against IP Restrictions Excluding Specified IP Rule description: |- This endpoint returns whether the client ip is acceptable based on the configured ip restriction rules associated to the rule set - excluding the ip rule id passed into the url parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: rule_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: rule_id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionSetValidate' - description: '' + $ref: "#/components/schemas/IPRestrictionSetValidate" + description: "" /api/v3/accounts/{account_id}/ip-restrictions/{id}: get: operationId: Retrieve IP Restriction parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionRuleEnveloped' - description: '' + $ref: "#/components/schemas/IPRestrictionRuleEnveloped" + description: "" put: operationId: Update IP Restriction description: |- @@ -579,2658 +743,3211 @@ paths: Note: As long as at least one cidr was successfully saved a 2XX will be returned. Check the `extra` key within the response for a list of cidrs that failed to save. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest' + $ref: "#/components/schemas/UpdateIPRestrictionRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest' + $ref: "#/components/schemas/UpdateIPRestrictionRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest' + $ref: "#/components/schemas/UpdateIPRestrictionRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRestrictionRule' - description: '' + $ref: "#/components/schemas/IPRestrictionRule" + description: "" delete: operationId: Delete IP Restriction parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - IP Restriction Endpoints + - IP Restriction Endpoints security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/license-maps/: get: operationId: List License Maps parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: state + schema: + type: integer tags: - - License Maps + - License Maps security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/LicenseMapEnveloped' - description: '' + $ref: "#/components/schemas/LicenseMapEnveloped" + description: "" post: operationId: Create License Map parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - License Maps + - License Maps requestBody: content: application/json: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" multipart/form-data: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LicenseMapEnveloped' - description: '' + $ref: "#/components/schemas/LicenseMapEnveloped" + description: "" /api/v3/accounts/{account_id}/license-maps/{id}/: get: operationId: Retrieve License Map parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - License Maps + - License Maps security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LicenseMapEnveloped' - description: '' + $ref: "#/components/schemas/LicenseMapEnveloped" + description: "" post: operationId: Update License Map parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - License Maps + - License Maps requestBody: content: application/json: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" multipart/form-data: schema: - $ref: '#/components/schemas/LicenseMapRequest' + $ref: "#/components/schemas/LicenseMapRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LicenseMapEnveloped' - description: '' + $ref: "#/components/schemas/LicenseMapEnveloped" + description: "" delete: operationId: Destroy License Map parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - License Maps + - License Maps security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body - /api/v3/accounts/{account_id}/private-link-endpoints/: - get: - operationId: List PrivateLink Endpoints - description: |- - List PrivateLink Endpoints for an account. - - Note: This API is only available to Enterprise BusinessCritical customers. - parameters: - - in: path - name: account_id - schema: - type: integer - required: true - tags: - - Private Link Endpoints - security: - - BearerAuthentication: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PrivateLinkEndpointEnveloped' - description: '' - /api/v3/accounts/{account_id}/projects/: + /api/v3/accounts/{account_id}/oauth-configurations/: get: - operationId: List Projects - description: List Projects + operationId: List OAuthConfigurations + description: List OAuthConfigurations parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name__icontains - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: pk__in - schema: - type: array - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: client_id + schema: + type: string + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: string tags: - - Projects + - OAuth Configurations security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/OAuthConfigurationEnveloped" + description: "" post: - operationId: Create Project - description: Create a new Project + operationId: Create OAuthConfiguration + description: Create a new OAuthConfiguration parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Projects + - OAuth Configurations requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/OAuthConfigurationRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/OAuthConfigurationRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/OAuthConfigurationRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' - /api/v3/accounts/{account_id}/projects/{id}/: + $ref: "#/components/schemas/OAuthConfigurationEnveloped" + description: "" + /api/v3/accounts/{account_id}/oauth-configurations/{id}/: get: - operationId: Retrieve Project - description: Retrieve a Project + operationId: Retrieve OAuth Configuration + description: Retrieve an OAuth Configuration parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - OAuth Configurations security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/OAuthConfigurationEnveloped" + description: "" post: - operationId: Update Project - description: Update a Project + operationId: Update OAuth Configuration + description: Update an OAuthConfiguration parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + tags: + - OAuth Configurations + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/OAuthConfigurationRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/OAuthConfigurationRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/OAuthConfigurationRequest" + required: true + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OAuthConfigurationEnveloped" + description: "" + delete: + operationId: Destroy OAuth Configuration + description: Delete an OAuth Configuration + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + tags: + - OAuth Configurations + security: + - BearerAuthentication: [] + responses: + "204": + description: No response body + /api/v3/accounts/{account_id}/private-link-endpoints/: + get: + operationId: List PrivateLink Endpoints + description: |- + List PrivateLink Endpoints for an account. + + Note: This API is only available to Enterprise BusinessCritical customers. + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + tags: + - Private Link Endpoints + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateLinkEndpointEnveloped" + description: "" + /api/v3/accounts/{account_id}/projects/: + get: + operationId: List Projects + description: List Projects + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name__icontains + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: pk__in + schema: + type: array + - in: query + name: state + schema: + type: integer + tags: + - Projects + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/ProjectEnveloped" + description: "" + post: + operationId: Create Project + description: Create a new Project + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + tags: + - Projects + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ProjectRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/ProjectRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/ProjectRequest" required: true + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ProjectEnveloped" + description: "" + /api/v3/accounts/{account_id}/projects/{id}/: + get: + operationId: Retrieve Project + description: Retrieve a Project + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + tags: + - Projects + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ProjectEnveloped" + description: "" + post: + operationId: Update Project + description: Update a Project + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - Projects requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ProjectRequest' + $ref: "#/components/schemas/ProjectRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectEnveloped' - description: '' + $ref: "#/components/schemas/ProjectEnveloped" + description: "" delete: operationId: Destroy Project description: Delete Project parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Projects + - Projects security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/adapters/: post: operationId: Create Adapter - description: Create a new adapter for a project. The ID from this adapter can + description: + Create a new adapter for a project. The ID from this adapter can be used to create Connections or Credentials when necessary. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Adapters + - Adapters requestBody: content: application/json: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" multipart/form-data: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DbtAdapterEnveloped' - description: '' + $ref: "#/components/schemas/DbtAdapterEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/adapters/{id}/: get: operationId: Retrieve Adapter description: Get an adapter by ID. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Adapters + - Adapters security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DbtAdapterEnveloped' - description: '' + $ref: "#/components/schemas/DbtAdapterEnveloped" + description: "" post: operationId: Update Adapter description: Update an adapter. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Adapters + - Adapters requestBody: content: application/json: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" multipart/form-data: schema: - $ref: '#/components/schemas/DbtAdapterRequest' + $ref: "#/components/schemas/DbtAdapterRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DbtAdapterEnveloped' - description: '' + $ref: "#/components/schemas/DbtAdapterEnveloped" + description: "" delete: operationId: Destroy Adapter description: Delete an adapter. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Adapters + - Adapters security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/connections/: get: operationId: List Connections description: List Connections parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] + deprecated: true responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/BaseConnectionV3Enveloped' - description: '' + $ref: "#/components/schemas/BaseConnectionV3Enveloped" + description: "" post: operationId: Create Connection description: Create a new Connection parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Connections + - Connections requestBody: content: application/json: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] + deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BaseConnectionV3Enveloped' - description: '' + $ref: "#/components/schemas/BaseConnectionV3Enveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/connections/{id}/: get: operationId: Retrieve Connection description: Retrieve a Connection parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] + deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BaseConnectionV3Enveloped' - description: '' + $ref: "#/components/schemas/BaseConnectionV3Enveloped" + description: "" post: operationId: Update Connection description: Update a Connection parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Connections + - Connections requestBody: content: application/json: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/BaseConnectionV3Request' + $ref: "#/components/schemas/BaseConnectionV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] + deprecated: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BaseConnectionV3Enveloped' - description: '' + $ref: "#/components/schemas/BaseConnectionV3Enveloped" + description: "" delete: operationId: Destroy Connection description: Delete a Connection parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Connections + - Connections security: - - BearerAuthentication: [] + - BearerAuthentication: [] + deprecated: true responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/credentials/: get: operationId: List Projects Credentials description: List the credentials for a given project. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body post: operationId: Create Projects Credential description: Create new credentials parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/credentials/{id}/: get: operationId: Retrieve Projects Credential description: Fetch a specific set of credentials. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body post: operationId: Updates Project Credentials description: Update a set of credentials parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body patch: operationId: Partial Update Projects Credential description: Partially update a set of credentials parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body delete: operationId: Destroy Projects Credential description: Delete a set of credentials parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Credentials + - Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/: post: operationId: Create Projects Environment Variable parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - required: true + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/{id}/: post: operationId: Update Projects Environment Variable parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - required: true + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" delete: operationId: Destroy Projects Environment Variable parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/bulk/: post: operationId: Create Projects Environment Variables Bulk parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables + - Environment Variables requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseEnveloped' - description: '' - '400': + $ref: "#/components/schemas/CustomEnvironmentVariableBulkResponseEnveloped" + description: "" + "400": content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseFailEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkResponseFailEnveloped" + description: "" put: operationId: Update Projects Environment Variables Bulk parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/CustomEnvironmentVariableRequest' - required: true + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" delete: operationId: Destroy Projects Environment Variables Bulk parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environment Variables + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/environment/: get: operationId: List Projects Environment Variables Environment parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: environment_id - schema: - type: integer - - in: query - name: job_definition_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: type - schema: - type: string - - in: query - name: user_id - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: environment_id + schema: + type: integer + - in: query + name: job_definition_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: string + - in: query + name: user_id + schema: + type: integer tags: - - Environment Variables + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/job/: get: operationId: List Projects Environment Variables Job parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: environment_id - schema: - type: integer - - in: query - name: job_definition_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: type - schema: - type: string - - in: query - name: user_id - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: environment_id + schema: + type: integer + - in: query + name: job_definition_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: string + - in: query + name: user_id + schema: + type: integer tags: - - Environment Variables + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/user/: get: operationId: List Projects Environment Variables User parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: environment_id - schema: - type: integer - - in: query - name: job_definition_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: type - schema: - type: string - - in: query - name: user_id - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: environment_id + schema: + type: integer + - in: query + name: job_definition_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: string + - in: query + name: user_id + schema: + type: integer tags: - - Environment Variables + - Environment Variables security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped' - description: '' + $ref: "#/components/schemas/CustomEnvironmentVariableEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/environments/: get: operationId: List Environments description: List Environments parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: credentials_id - schema: - type: integer - - in: query - name: dbt_version - schema: - type: string - - in: query - name: dbt_version__in - schema: - type: array - - in: query - name: deployment_type - schema: - type: string - - in: query - name: deployment_type__in - schema: - type: array - - in: query - name: id__gt - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: pk__in - schema: - type: array - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: state - schema: - type: integer - - in: query - name: type - schema: - type: string + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: credentials_id + schema: + type: integer + - in: query + name: dbt_version + schema: + type: string + - in: query + name: dbt_version__in + schema: + type: array + - in: query + name: deployment_type + schema: + type: string + - in: query + name: deployment_type__in + schema: + type: array + - in: query + name: id__gt + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: pk__in + schema: + type: array + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: state + schema: + type: integer + - in: query + name: type + schema: + type: string tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/EnvironmentV3Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV3Enveloped" + description: "" post: operationId: Create Environment description: Create a new Environment parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environments + - Environments requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV3Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV3Enveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/environments/{id}/: get: operationId: Retrieve Environment description: Retrieve an Environment parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV3Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV3Enveloped" + description: "" post: operationId: Update Environment description: Update an Environment parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environments + - Environments requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/EnvironmentV3Request' + $ref: "#/components/schemas/EnvironmentV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EnvironmentV3Enveloped' - description: '' + $ref: "#/components/schemas/EnvironmentV3Enveloped" + description: "" delete: operationId: Destroy Environment description: Delete an Environment parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Environments + - Environments security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/extended-attributes/: post: operationId: Create Extended Attributes description: Create a new Extended Attributes record. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Extended Attributes + - Extended Attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ExtendedAttributesEnveloped' - description: '' + $ref: "#/components/schemas/ExtendedAttributesEnveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/extended-attributes/{id}/: get: operationId: Retrieve Extended Attributes - description: 'Given an account_id, project_id, and primary key: retrieve an - existing Extended Attributes record.' + description: + "Given an account_id, project_id, and primary key: retrieve an + existing Extended Attributes record." parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Extended Attributes + - Extended Attributes security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ExtendedAttributesEnveloped' - description: '' + $ref: "#/components/schemas/ExtendedAttributesEnveloped" + description: "" patch: operationId: Update Extended Attributes description: Update an existing Extended Attributes record by ID. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Extended Attributes + - Extended Attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ExtendedAttributesRequest' + $ref: "#/components/schemas/ExtendedAttributesRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ExtendedAttributesEnveloped' - description: '' + $ref: "#/components/schemas/ExtendedAttributesEnveloped" + description: "" delete: operationId: Destroy Extended Attributes description: Delete an existing Extended Attributes record by ID. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Extended Attributes + - Extended Attributes security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/projects/{project_id}/group-permissions/: post: operationId: Assign Project Group Permissions parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Groups + - Groups security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": description: No response body - /api/v3/accounts/{account_id}/projects/{project_id}/managed-repositories/: - post: - operationId: Create Managed Repository - description: Create a new dbt Cloud managed repository. + /api/v3/accounts/{account_id}/projects/{project_id}/integrations/: + get: + operationId: List Integrations parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Repositories + - Projects Integrations security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Enveloped' - description: '' + $ref: "#/components/schemas/ListIntegrationResponseResponse" + description: "" + post: + operationId: Create Integration + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PostIntegrationRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/PostIntegrationRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/PostIntegrationRequest" + required: true + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntegrationResponse" + description: "" + /api/v3/accounts/{account_id}/projects/{project_id}/integrations/{id}/: + get: + operationId: Get Integration + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntegrationResponse" + description: "" + patch: + operationId: Update Integration + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PatchIntegrationRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/PatchIntegrationRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/PatchIntegrationRequest" + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntegrationResponse" + description: "" + delete: + operationId: Delete Integration + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + security: + - BearerAuthentication: [] + responses: + "204": + description: No response body + /api/v3/accounts/{account_id}/projects/{project_id}/integrations/{id}/collections/: + get: + operationId: List collections from BI tool + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ListIntegrationCollection" + description: "" + /api/v3/accounts/{account_id}/projects/{project_id}/integrations/{id}/collections/{collection_id}/: + get: + operationId: List collections from BI tool_2 + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: collection_id + schema: + type: string + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ListIntegrationCollection" + description: "" + /api/v3/accounts/{account_id}/projects/{project_id}/integrations/{id}/selections: + post: + operationId: Update Integration Selections + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Projects Integrations + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PostIntegrationWatchSelectionRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/PostIntegrationWatchSelectionRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/PostIntegrationWatchSelectionRequest" + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetIntegrationWatchSelectionResponse" + description: "" + /api/v3/accounts/{account_id}/projects/{project_id}/managed-repositories/: + post: + operationId: Create Managed Repository + description: Create a new dbt Cloud managed repository. + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true + tags: + - Repositories + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/RepositoryV3Enveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/repositories/: get: operationId: List Repositories description: List repositories for the given project parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: limit - schema: - type: integer - - in: query - name: offset - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: path - name: project_id - schema: - type: integer - required: true - - in: query - name: project_id - schema: - type: integer - - in: query - name: project_id__in - schema: - type: array - - in: query - name: remote_url - schema: - type: string - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: offset + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: path + name: project_id + schema: + type: integer + required: true + - in: query + name: project_id + schema: + type: integer + - in: query + name: project_id__in + schema: + type: array + - in: query + name: remote_url + schema: + type: string + - in: query + name: state + schema: + type: integer tags: - - Repositories + - Repositories security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/RepositoryV3Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV3Enveloped" + description: "" post: operationId: Create Repository description: Create a new repository for the given project parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Repositories + - Repositories requestBody: content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV3Enveloped" + description: "" /api/v3/accounts/{account_id}/projects/{project_id}/repositories/{id}/: get: operationId: Retrieve Repository description: Get a repository by ID parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Repositories + - Repositories security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV3Enveloped" + description: "" post: operationId: Update Repository description: Update a repository parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Repositories + - Repositories requestBody: content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" multipart/form-data: schema: - $ref: '#/components/schemas/RepositoryV3Request' + $ref: "#/components/schemas/RepositoryV3Request" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RepositoryV3Enveloped' - description: '' + $ref: "#/components/schemas/RepositoryV3Enveloped" + description: "" delete: operationId: Destroy Repository description: Delete a repository parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: project_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: project_id + schema: + type: integer + required: true tags: - - Repositories + - Repositories security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/semantic-layer-credentials/: get: operationId: List Semantic Layer Credentials parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: query - name: account_id - schema: - type: integer - - in: query - name: pk - schema: - type: integer - - in: query - name: state - schema: - type: integer + - in: path + name: account_id + schema: + type: integer + required: true + - in: query + name: account_id + schema: + type: integer + - in: query + name: pk + schema: + type: integer + - in: query + name: project_id + schema: + type: integer + - in: query + name: state + schema: + type: integer tags: - - Semantic Layer Credentials + - Semantic Layer Credentials security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: type: array items: - $ref: '#/components/schemas/SemanticLayerCredentialsEnveloped' - description: '' + $ref: "#/components/schemas/SemanticLayerCredentialsEnveloped" + description: "" /api/v3/accounts/{account_id}/service-tokens/: get: operationId: List Service Tokens parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenEnveloped' - description: '' + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" post: operationId: Create Service Token description: This endpoint is used to generate a new service token for the account. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenEnveloped' - description: '' + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" /api/v3/accounts/{account_id}/service-tokens/{id}/: get: operationId: Retrieve Service Token parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenEnveloped' - description: '' + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" put: operationId: Update Service Token parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" multipart/form-data: schema: - $ref: '#/components/schemas/ServiceTokenRequestRequest' + $ref: "#/components/schemas/ServiceTokenRequestRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenEnveloped' - description: '' + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" delete: operationId: Destroy Service Token parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body /api/v3/accounts/{account_id}/service-tokens/{service_token_id}/permissions/: get: operationId: Retrieve Service Tokens Permission description: List permissions of a given ServiceToken for an account. parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: service_token_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: service_token_id + schema: + type: integer + required: true tags: - - Service Tokens + - Service Tokens security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceTokenPermissionEnveloped' - description: '' + $ref: "#/components/schemas/ServiceTokenPermissionEnveloped" + description: "" /api/v3/accounts/{account_id}/users/: get: operationId: Retrieve User description: List users for a given account. parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserEnveloped' - description: '' - /api/v3/accounts/{account_id}/webhooks/event/{event_id}: + $ref: "#/components/schemas/UserEnveloped" + description: "" + /api/v3/accounts/{account_id}/users/{user_id}/account-apikeys/: get: - operationId: Retrieve Webhooks Event - description: Get a specific event given an event_id + operationId: List Account Scoped PATs parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: event_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Webhooks + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventResponseEnvelope' - description: '' - '404': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' - /api/v3/accounts/{account_id}/webhooks/event/{event_id}/receipts: - get: - operationId: List Webhooks Event Receipts - description: Get all receipts for a given event id + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" + post: + operationId: Create Account Scoped PAT parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: event_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Webhooks + - Users + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AccountScopedPATRequestRequest" + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/AccountScopedPATRequestRequest" + multipart/form-data: + schema: + $ref: "#/components/schemas/AccountScopedPATRequestRequest" + required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ListWebhooksReceiptsResponseEnvelope' - description: '' - '404': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' - /api/v3/accounts/{account_id}/webhooks/receipt/{receipt_id}: + $ref: "#/components/schemas/ServiceToken" + description: "" + /api/v3/accounts/{account_id}/users/{user_id}/account-apikeys/{id}/: get: - operationId: Retrieve Webhooks Receipt - description: Get a specific receipt given its id + operationId: Get Account Scoped PAT parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: receipt_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Webhooks + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetWebhooksReceiptResponseEnvelope' - description: '' - '404': - content: + $ref: "#/components/schemas/AccountScopedPATResponseEnveloped" + description: "" + post: + operationId: Rotate Account Scoped PAT + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true + tags: + - Users + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceTokenEnveloped" + description: "" + delete: + operationId: Delete Account Scoped PAT + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true + tags: + - Users + security: + - BearerAuthentication: [] + responses: + "204": + description: No response body + /api/v3/accounts/{account_id}/webhooks/event/{event_id}: + get: + operationId: Retrieve Webhooks Event + description: Get a specific event given an event_id + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: event_id + schema: + type: string + required: true + tags: + - Webhooks + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/EventResponseEnvelope" + description: "" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/NotFound" + description: "" + /api/v3/accounts/{account_id}/webhooks/event/{event_id}/receipts: + get: + operationId: List Webhooks Event Receipts + description: Get all receipts for a given event id + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: event_id + schema: + type: string + required: true + tags: + - Webhooks + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ListWebhooksReceiptsResponseEnvelope" + description: "" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/NotFound" + description: "" + /api/v3/accounts/{account_id}/webhooks/receipt/{receipt_id}: + get: + operationId: Retrieve Webhooks Receipt + description: Get a specific receipt given its id + parameters: + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: receipt_id + schema: + type: string + required: true + tags: + - Webhooks + security: + - BearerAuthentication: [] + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/GetWebhooksReceiptResponseEnvelope" + description: "" + "404": + content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}: get: operationId: Retrieve Webhooks Subscription description: Get a specific subscription with a subscription id parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: subscription_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: subscription_id + schema: + type: string + required: true tags: - - Webhooks + - Webhooks security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SubscriptionResponseEnvelope' - description: '' - '404': + $ref: "#/components/schemas/SubscriptionResponseEnvelope" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" put: operationId: Update Webhooks Subscription description: Edit a subscription given a subscription id parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: subscription_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: subscription_id + schema: + type: string + required: true tags: - - Webhooks + - Webhooks requestBody: content: application/json: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateSubscriptionResponseEnvelope' - description: '' - '404': + $ref: "#/components/schemas/UpdateSubscriptionResponseEnvelope" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" delete: operationId: Destroy Webhooks Subscription description: Delete a specific subscription parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: subscription_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: subscription_id + schema: + type: string + required: true tags: - - Webhooks + - Webhooks security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteSubscriptionResponseEnvelope' - description: '' - '404': + $ref: "#/components/schemas/DeleteSubscriptionResponseEnvelope" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}/events: get: operationId: List Webhooks Events description: Get all events for a specific subscription parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: subscription_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: subscription_id + schema: + type: string + required: true tags: - - Webhooks + - Webhooks security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PaginatedWebhooksEvents' - description: '' - '404': + $ref: "#/components/schemas/PaginatedWebhooksEvents" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}/test: get: operationId: Test Webhooks Subscription description: Test the client endpoint for a given subscription parameters: - - in: path - name: account_id - schema: - type: integer - required: true - - in: path - name: subscription_id - schema: - type: string - required: true + - in: path + name: account_id + schema: + type: integer + required: true + - in: path + name: subscription_id + schema: + type: string + required: true tags: - - Webhooks + - Webhooks security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TestSubscriptionResponseEnvelope' - description: '' - '404': + $ref: "#/components/schemas/TestSubscriptionResponseEnvelope" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" /api/v3/accounts/{account_id}/webhooks/subscriptions: get: operationId: List Webhooks Subscriptions description: Given an account id list all webhook subscriptions parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Webhooks + - Webhooks security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PaginatedWebhooksSubscriptions' - description: '' + $ref: "#/components/schemas/PaginatedWebhooksSubscriptions" + description: "" post: operationId: Create Webhooks Subscription description: Create a new webhook subscription parameters: - - in: path - name: account_id - schema: - type: integer - required: true + - in: path + name: account_id + schema: + type: integer + required: true tags: - - Webhooks + - Webhooks requestBody: content: application/json: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" multipart/form-data: schema: - $ref: '#/components/schemas/SubscriptionRequest' + $ref: "#/components/schemas/SubscriptionRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateSubscriptionResponseEnvelope' - description: '' - '404': + $ref: "#/components/schemas/CreateSubscriptionResponseEnvelope" + description: "" + "404": content: application/json: schema: - $ref: '#/components/schemas/NotFound' - description: '' + $ref: "#/components/schemas/NotFound" + description: "" /api/v3/adapter-schema/: get: operationId: Retrieve Adapter Schema - description: Fetch the schema for a given adapter. The schema will include details + description: + Fetch the schema for a given adapter. The schema will include details on available fields for connections and credentials. parameters: - - in: query - name: adapter_version - schema: - type: string - enum: - - apache_spark_v0 - - bigquery_v0 - - databricks_spark_v0 - - databricks_v0 - - fabric_v0 - - postgres_v0 - - redshift_v0 - - snowflake_v0 - - synapse_v0 - - trino_v0 - description: The adapter to fetch the schema for - required: true + - in: query + name: adapter_version + schema: + type: string + enum: + - apache_spark_v0 + - athena_v0 + - bigquery_v0 + - databricks_spark_v0 + - databricks_v0 + - fabric_v0 + - postgres_v0 + - redshift_v0 + - snowflake_v0 + - synapse_v0 + - trino_v0 + description: The adapter to fetch the schema for + required: true tags: - - Adapter Schema + - Adapter Schema security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AdapterSchemaResponseEnveloped' - description: '' + $ref: "#/components/schemas/AdapterSchemaResponseEnveloped" + description: "" /api/v3/users/{user_id}/credentials/: get: operationId: List Users Credential description: List the development credentials associated with a given user. parameters: - - in: path - name: user_id - schema: - type: integer - required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsEnveloped' - description: '' + $ref: "#/components/schemas/UserCredentialsEnveloped" + description: "" post: operationId: Create Users Credential description: Associate a set of development credentials with a given user. parameters: - - in: path - name: user_id - schema: - type: integer - required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Users + - Users requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" multipart/form-data: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsEnveloped' - description: '' + $ref: "#/components/schemas/UserCredentialsEnveloped" + description: "" /api/v3/users/{user_id}/credentials/{id}/: get: operationId: Retrieve Users Credential description: Get a development credentials association for a given user. parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_id - schema: - type: integer - required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsEnveloped' - description: '' + $ref: "#/components/schemas/UserCredentialsEnveloped" + description: "" post: operationId: Update Users Credential - description: Update which development credentials are associated with a specific + description: + Update which development credentials are associated with a specific user. parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_id - schema: - type: integer - required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Users + - Users requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" multipart/form-data: schema: - $ref: '#/components/schemas/UserCredentialsRequest' + $ref: "#/components/schemas/UserCredentialsRequest" required: true security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserCredentialsEnveloped' - description: '' + $ref: "#/components/schemas/UserCredentialsEnveloped" + description: "" delete: operationId: Destroy Users Credential description: Delete a development credentials / user association. parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_id - schema: - type: integer - required: true + - in: path + name: id + schema: + type: integer + required: true + - in: path + name: user_id + schema: + type: integer + required: true tags: - - Users + - Users security: - - BearerAuthentication: [] + - BearerAuthentication: [] responses: - '204': + "204": description: No response body components: schemas: Account: type: object required: - - id - - name - - state - - plan - - pending_cancel - - run_slots - - developer_seats - - docs_job_id - - freshness_job_id + - id + - name + - state + - plan + - pending_cancel + - run_slots + - developer_seats + - explorer_seats + - docs_job_id + - freshness_job_id properties: id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer name: allOf: - - type: string - - minLength: 1 - maxLength: 255 + - type: string + - minLength: 1 + maxLength: 255 description: The name of the account state: type: integer @@ -3245,6 +3962,9 @@ components: developer_seats: type: integer description: The total number of developer seats the account may use + explorer_seats: + type: integer + description: The total number of explorer seats the account may use it_seats: type: integer description: The total number of IT seats the account may use @@ -3261,129 +3981,129 @@ components: type: integer stripe_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string metronome_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string salesforce_customer_id: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string third_party_billing: oneOf: - - type: 'null' - - {} + - type: "null" + - {} billing_email_address: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string locked: type: boolean description: Whether the account is currently locked lock_reason: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string description: Why the account is locked lock_cause: oneOf: - - type: 'null' - - {} - - {} - - {} - - {} - - {} + - type: "null" + - {} + - {} + - {} + - {} + - {} description: Why the account is locked develop_file_system: type: boolean unlocked_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time unlock_if_subscription_renewed: type: boolean enterprise_authentication_method: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_login_slug: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string enterprise_unique_identifier: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string business_critical: type: boolean groups: oneOf: - - type: 'null' - - {} + - type: "null" + - {} description: The user groups in the account created_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true updated_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time readOnly: true starter_repo_url: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string git_auth_level: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string identifier: oneOf: - - type: 'null' - - allOf: - - type: string - - minLength: 31 - maxLength: 31 + - type: "null" + - allOf: + - type: string + - minLength: 31 + maxLength: 31 trial_end_date: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time static_subdomain: oneOf: - - type: 'null' - - type: string + - type: "null" + - type: string run_locked_until: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time docs_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) freshness_job_id: oneOf: - - type: 'null' - - type: integer + - type: "null" + - type: integer description: (Deprecated) migration_scheduled_at: oneOf: - - type: 'null' - - type: string - format: date-time + - type: "null" + - type: string + format: date-time account_migration_events: oneOf: - - type: 'null' - - {} + - type: "null" + - {} additionalProperties: false definitions: {} $schema: http://json-schema.org/draft-07/schema# @@ -3393,34 +4113,107 @@ components: data: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" + status: + $ref: "#/components/schemas/Status" + required: + - data + - status + AccountScopedPATRequestRequest: + type: object + properties: + name: + type: string + minLength: 1 + required: + - name + AccountScopedPATResponse: + type: object + properties: + id: + type: integer + account_id: + type: integer + uid: + type: string + name: + type: string + token: + type: string + state: + type: integer + default: 1 + token_string: + type: string + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + last_used: + type: string + format: date-time + user_id: + type: integer + type: + type: integer + expires_at: + type: string + format: date-time + metadata_only: + type: boolean + default: false + webhooks_only: + type: boolean + default: false + service_token_permissions: + type: array + items: + $ref: "#/components/schemas/ServiceTokenPermission" + readOnly: true + default: [] + required: + - created_at + - service_token_permissions + - token_string + - updated_at + AccountScopedPATResponseEnveloped: + type: object + properties: + data: + $ref: "#/components/schemas/AccountScopedPATResponse" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status Adapter: type: object properties: metadata: allOf: - - $ref: '#/components/schemas/AdapterMetadata' + - $ref: "#/components/schemas/AdapterMetadata" description: High level information about the adapter connection: allOf: - - $ref: '#/components/schemas/Schema' + - $ref: "#/components/schemas/Schema" description: The set of connection-level fields for this adapter credential: allOf: - - $ref: '#/components/schemas/Schema' + - $ref: "#/components/schemas/Schema" description: The set of credential-level fields for this adapter semantic_layer_credentials: allOf: - - $ref: '#/components/schemas/Schema' - description: The set of semantic layer credential-level fields for this + - $ref: "#/components/schemas/Schema" + description: + The set of semantic layer credential-level fields for this adapter required: - - metadata + - metadata AdapterMetadata: type: object properties: @@ -3431,36 +4224,37 @@ components: image_link: type: string required: - - docs_link - - image_link - - title + - docs_link + - image_link + - title AdapterSchemaResponse: type: object properties: adapter: - $ref: '#/components/schemas/Adapter' + $ref: "#/components/schemas/Adapter" AdapterSchemaResponseEnveloped: type: object properties: data: - $ref: '#/components/schemas/AdapterSchemaResponse' + $ref: "#/components/schemas/AdapterSchemaResponse" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status AdapterVersionEnum: enum: - - apache_spark_v0 - - databricks_spark_v0 - - databricks_v0 - - trino_v0 - - snowflake_v0 - - bigquery_v0 - - postgres_v0 - - redshift_v0 - - synapse_v0 - - fabric_v0 + - apache_spark_v0 + - databricks_spark_v0 + - databricks_v0 + - trino_v0 + - snowflake_v0 + - bigquery_v0 + - postgres_v0 + - redshift_v0 + - synapse_v0 + - fabric_v0 + - athena_v0 type: string description: |- * `apache_spark_v0` - apache_spark_v0 @@ -3473,6 +4267,106 @@ components: * `redshift_v0` - redshift_v0 * `synapse_v0` - synapse_v0 * `fabric_v0` - fabric_v0 + * `athena_v0` - athena_v0 + ApacheSparkConnection: + title: ApacheSparkConnection + type: object + properties: + host: + title: Host + type: string + cluster: + title: Cluster + type: string + method: + default: http + allOf: + - $ref: "#/components/schemas/ConnectionMethod" + connect_timeout: + title: Connect Timeout + default: 10 + type: integer + connect_retries: + title: Connect Retries + default: 0 + type: integer + organization: + title: Organization + default: "" + type: string + user: + title: User + default: "" + type: string + auth: + title: Auth + default: "" + type: string + kerberos_service_name: + title: Kerberos Service Name + default: "" + type: string + port: + title: Port + default: 443 + minimum: 1 + maximum: 65535 + type: integer + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer + required: + - host + - cluster + AthenaConnection: + title: AthenaConnection + type: object + properties: + region_name: + title: Region Name + type: string + database: + title: Database + type: string + work_group: + title: Work Group + type: string + spark_work_group: + title: Spark Work Group + type: string + s3_staging_dir: + title: S3 Staging Dir + type: string + s3_data_dir: + title: S3 Data Dir + type: string + s3_data_naming: + title: S3 Data Naming + type: string + s3_tmp_table_dir: + title: S3 Tmp Table Dir + type: string + poll_interval: + title: Poll Interval + type: integer + num_retries: + title: Num Retries + type: integer + num_boto3_retries: + title: Num Boto3 Retries + type: integer + num_iceberg_retries: + title: Num Iceberg Retries + type: integer + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer + required: + - region_name + - database + - s3_staging_dir BaseConnectionV3: type: object properties: @@ -3488,7 +4382,9 @@ components: type: string description: The name of the connection type: - $ref: '#/components/schemas/Type32eEnum' + $ref: "#/components/schemas/Type32eEnum" + adapter_version: + $ref: "#/components/schemas/AdapterVersionEnum" created_by_id: type: integer created_by_service_token_id: @@ -3496,25 +4392,31 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string + oauth_configuration_id: + type: integer + description: + The OAuth Configuration associated with this connection. When + set,developer credentials leveraging OAuth may be created. required: - - account_id - - name - - project_id - - type + - account_id + - name + - project_id + - type BaseConnectionV3Enveloped: type: object properties: data: - $ref: '#/components/schemas/BaseConnectionV3' + $ref: "#/components/schemas/BaseConnectionV3" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status BaseConnectionV3Request: type: object properties: @@ -3531,7 +4433,9 @@ components: minLength: 1 description: The name of the connection type: - $ref: '#/components/schemas/Type32eEnum' + $ref: "#/components/schemas/Type32eEnum" + adapter_version: + $ref: "#/components/schemas/AdapterVersionEnum" created_by_id: type: integer created_by_service_token_id: @@ -3539,66 +4443,151 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string minLength: 1 + oauth_configuration_id: + type: integer + description: + The OAuth Configuration associated with this connection. When + set,developer credentials leveraging OAuth may be created. required: - - account_id - - name - - project_id - - type - CreateSubscriptionResponseEnvelope: - type: object - properties: - data: - $ref: '#/components/schemas/Subscription' - status: - $ref: '#/components/schemas/ResponseStatus' - required: - - data - - status - CustomEnvironmentVariable: + - account_id + - name + - project_id + - type + BigqueryConnection: + title: BigqueryConnection type: object properties: - account_id: - type: integer project_id: - type: integer - name: + title: Project Id + maxLength: 255 + minLength: 1 type: string - type: - $ref: '#/components/schemas/CustomEnvironmentVariableTypeEnum' - state: + timeout_seconds: + title: Timeout Seconds + exclusiveMinimum: 0 + maximum: 86400 type: integer - default: 1 - user_id: + private_key_id: + title: Private Key Id + maxLength: 255 + minLength: 1 + type: string + private_key: + title: Private Key + write_only: true + type: string + writeOnly: true + format: password + client_email: + title: Client Email + maxLength: 1024 + minLength: 1 + type: string + client_id: + title: Client Id + maxLength: 255 + minLength: 1 + type: string + auth_uri: + title: Auth Uri + type: string + token_uri: + title: Token Uri + type: string + auth_provider_x509_cert_url: + title: Auth Provider X509 Cert Url + type: string + client_x509_cert_url: + title: Client X509 Cert Url + type: string + priority: + $ref: "#/components/schemas/Priority" + scopes: + title: Scopes + type: array + items: + type: string + location: + title: Location + maxLength: 255 + minLength: 1 + type: string + maximum_bytes_billed: + title: Maximum Bytes Billed type: integer - environment_id: + execution_project: + title: Execution Project + type: string + impersonate_service_account: + title: Impersonate Service Account + type: string + retries: + title: Retries + default: 1 + minimum: 0 + maximum: 60 type: integer - job_definition_id: + job_retry_deadline_seconds: + title: Job Retry Deadline Seconds type: integer - environment: - readOnly: true - display_value: - type: string - id: + job_creation_timeout_seconds: + title: Job Creation Timeout Seconds type: integer - readOnly: true - created_at: + application_id: + title: Application Id + write_only: true type: string - format: date-time - readOnly: true - updated_at: + writeOnly: true + format: password + application_secret: + title: Application Secret + write_only: true type: string - format: date-time - readOnly: true + writeOnly: true + format: password + gcs_bucket: + title: Gcs Bucket + type: string + dataproc_region: + title: Dataproc Region + type: string + dataproc_cluster_name: + title: Dataproc Cluster Name + type: string + required: + - project_id + - timeout_seconds + - private_key_id + - private_key + - client_email + - client_id + - auth_uri + - token_uri + - auth_provider_x509_cert_url + - client_x509_cert_url + ConnectionMethod: + title: ConnectionMethod + description: An enumeration. + enum: + - http + - thrift + type: string + CreateSubscriptionResponseEnvelope: + type: object + properties: + data: + $ref: "#/components/schemas/Subscription" + status: + $ref: "#/components/schemas/ResponseStatus" required: - - created_at - - environment - - id - - updated_at + - data + - status CustomEnvironmentVariableBulkRequest: type: object properties: @@ -3611,24 +4600,26 @@ components: environmentNameExample1: type: string minLength: 1 - description: This key must match the name of the environment you want to + description: + This key must match the name of the environment you want to set this environment variable for. environmentNameExample2: type: string minLength: 1 - description: This key must match the name of the environment you want to + description: + This key must match the name of the environment you want to set this environment variable for. required: - - new_name + - new_name CustomEnvironmentVariableBulkRequestRequest: type: object properties: env_var: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequest' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkRequest" required: - - env_var + - env_var CustomEnvironmentVariableBulkResponse: type: object properties: @@ -3639,19 +4630,19 @@ components: key_name: type: string data: - $ref: '#/components/schemas/ResponseData' + $ref: "#/components/schemas/ResponseData" CustomEnvironmentVariableBulkResponseEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponse' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkResponse" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status CustomEnvironmentVariableBulkResponseFail: type: object properties: @@ -3669,79 +4660,97 @@ components: data: type: array items: - $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseFail' + $ref: "#/components/schemas/CustomEnvironmentVariableBulkResponseFail" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status CustomEnvironmentVariableEnveloped: type: object properties: - data: - $ref: '#/components/schemas/CustomEnvironmentVariable' status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status - CustomEnvironmentVariableRequest: + - status + DatabricksConnection: + title: DatabricksConnection type: object properties: - account_id: - type: integer - project_id: - type: integer - name: + host: + title: Host + pattern: .*databricks.* type: string - minLength: 1 - type: - $ref: '#/components/schemas/CustomEnvironmentVariableTypeEnum' - state: - type: integer - default: 1 - user_id: - type: integer - environment_id: + http_path: + title: Http Path + pattern: ^(\/sql\/|sql\/) + type: string + catalog: + title: Catalog + default: "" + type: string + client_id: + title: Client Id + write_only: true + type: string + writeOnly: true + format: password + client_secret: + title: Client Secret + write_only: true + type: string + writeOnly: true + format: password + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version type: integer - job_definition_id: + required: + - host + - http_path + DatabricksSparkConnection: + title: DatabricksSparkConnection + type: object + properties: + host: + title: Host + type: string + method: + default: odbc + allOf: + - $ref: "#/components/schemas/Method" + port: + title: Port + default: 443 + minimum: 1 + maximum: 65535 type: integer - raw_value: + cluster: + title: Cluster + default: "" type: string - writeOnly: true - minLength: 1 - display_value: + endpoint: + title: Endpoint + default: "" type: string - minLength: 1 + driver: + title: Driver + default: /opt/simba/spark/lib/64/libsparkodbc_sb64.so + type: string + organization: + title: Organization + default: "" + type: string + user: + title: User + default: "" + type: string + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer required: - - account_id - - name - - project_id - - type - CustomEnvironmentVariableTypeEnum: - enum: - - project - - environment - - job - - user - type: string - description: |- - * `project` - project - * `environment` - environment - * `job` - job - * `user` - user - DateEnum: - enum: - - every_day - - days_of_week - - custom_cron - - interval_cron - type: string - description: |- - * `every_day` - every_day - * `days_of_week` - days_of_week - * `custom_cron` - custom_cron - * `interval_cron` - interval_cron + - host DbtAdapter: type: object properties: @@ -3756,7 +4765,7 @@ components: created_by_service_token_id: type: integer adapter_version: - $ref: '#/components/schemas/AdapterVersionEnum' + $ref: "#/components/schemas/AdapterVersionEnum" metadata_json: {} state: type: integer @@ -3770,18 +4779,18 @@ components: format: date-time readOnly: true required: - - created_at - - updated_at + - created_at + - updated_at DbtAdapterEnveloped: type: object properties: data: - $ref: '#/components/schemas/DbtAdapter' + $ref: "#/components/schemas/DbtAdapter" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status DbtAdapterRequest: type: object properties: @@ -3796,35 +4805,52 @@ components: created_by_service_token_id: type: integer adapter_version: - $ref: '#/components/schemas/AdapterVersionEnum' + $ref: "#/components/schemas/AdapterVersionEnum" metadata_json: {} state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - adapter_version - - metadata_json - - project_id + - account_id + - adapter_version + - metadata_json + - project_id + DbtAdapterVersion: + title: DbtAdapterVersion + description: An enumeration. + enum: + - apache_spark_v0 + - databricks_spark_v0 + - databricks_v0 + - trino_v0 + - snowflake_v0 + - bigquery_v0 + - postgres_v0 + - redshift_v0 + - synapse_v0 + - fabric_v0 + - athena_v0 + type: string DeleteSubscriptionResponseData: type: object properties: id: type: string required: - - id + - id DeleteSubscriptionResponseEnvelope: type: object properties: data: - $ref: '#/components/schemas/DeleteSubscriptionResponseData' + $ref: "#/components/schemas/DeleteSubscriptionResponseData" status: - $ref: '#/components/schemas/DeleteSubscriptionResponseStatus' + $ref: "#/components/schemas/DeleteSubscriptionResponseStatus" required: - - data - - status + - data + - status DeleteSubscriptionResponseStatus: type: object properties: @@ -3833,12 +4859,12 @@ components: is_success: type: boolean required: - - code - - is_success + - code + - is_success DeploymentTypeEnum: enum: - - production - - staging + - production + - staging type: string description: |- * `production` - production @@ -3856,8 +4882,12 @@ components: description: The project the environment is associated with credentials_id: type: integer - description: The id of the associated credentials. Null for development + description: + The id of the associated credentials. Null for development environments. + connection_id: + type: integer + description: The id of the associated connection. extended_attributes_id: type: integer name: @@ -3867,7 +4897,7 @@ components: type: string description: The default dbt Version to use for this environment type: - $ref: '#/components/schemas/EnvironmentV3TypeEnum' + $ref: "#/components/schemas/EnvironmentV3TypeEnum" use_custom_branch: type: boolean custom_branch: @@ -3877,28 +4907,32 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted deployment_type: - $ref: '#/components/schemas/DeploymentTypeEnum' + $ref: "#/components/schemas/DeploymentTypeEnum" + enable_model_query_history: + type: boolean + default: false required: - - account_id - - dbt_version - - name - - project_id - - supports_docs - - type - - use_custom_branch + - account_id + - dbt_version + - name + - project_id + - supports_docs + - type + - use_custom_branch EnvironmentV3Enveloped: type: object properties: data: - $ref: '#/components/schemas/EnvironmentV3' + $ref: "#/components/schemas/EnvironmentV3" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status EnvironmentV3Request: type: object properties: @@ -3912,8 +4946,12 @@ components: description: The project the environment is associated with credentials_id: type: integer - description: The id of the associated credentials. Null for development + description: + The id of the associated credentials. Null for development environments. + connection_id: + type: integer + description: The id of the associated connection. extended_attributes_id: type: integer name: @@ -3925,7 +4963,7 @@ components: minLength: 1 description: The default dbt Version to use for this environment type: - $ref: '#/components/schemas/EnvironmentV3TypeEnum' + $ref: "#/components/schemas/EnvironmentV3TypeEnum" use_custom_branch: type: boolean custom_branch: @@ -3936,22 +4974,26 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted deployment_type: - $ref: '#/components/schemas/DeploymentTypeEnum' + $ref: "#/components/schemas/DeploymentTypeEnum" + enable_model_query_history: + type: boolean + default: false required: - - account_id - - dbt_version - - name - - project_id - - supports_docs - - type - - use_custom_branch + - account_id + - dbt_version + - name + - project_id + - supports_docs + - type + - use_custom_branch EnvironmentV3TypeEnum: enum: - - development - - deployment + - development + - deployment type: string description: |- * `development` - DEVELOPMENT @@ -3976,24 +5018,24 @@ components: account_id: type: string required: - - account_id - - account_identifier - - http_status_code - - id - - job_id - - payload - - subscription_id - - trigger_event_type + - account_id + - account_identifier + - http_status_code + - id + - job_id + - payload + - subscription_id + - trigger_event_type EventResponseEnvelope: type: object properties: data: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" status: - $ref: '#/components/schemas/ResponseStatus' + $ref: "#/components/schemas/ResponseStatus" required: - - data - - status + - data + - status ExtendedAttributes: type: object properties: @@ -4016,18 +5058,18 @@ components: type: integer default: 1 required: - - created_at - - updated_at + - created_at + - updated_at ExtendedAttributesEnveloped: type: object properties: data: - $ref: '#/components/schemas/ExtendedAttributes' + $ref: "#/components/schemas/ExtendedAttributes" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ExtendedAttributesRequest: type: object properties: @@ -4041,12 +5083,52 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - extended_attributes - - project_id + - account_id + - extended_attributes + - project_id + FabricConnection: + title: FabricConnection + type: object + properties: + server: + title: Server + type: string + database: + title: Database + type: string + driver: + title: Driver + default: ODBC Driver 18 for SQL Server + type: string + port: + title: Port + default: 1433 + minimum: 1 + maximum: 65535 + type: integer + retries: + title: Retries + default: 1 + type: integer + login_timeout: + title: Login Timeout + default: 0 + type: integer + query_timeout: + title: Query Timeout + default: 0 + type: integer + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer + required: + - server + - database Filters: type: object properties: @@ -4055,25 +5137,184 @@ components: limit: type: integer required: - - limit - - offset + - limit + - offset + GetAccountConnection: + title: GetAccountConnection + type: object + properties: + id: + title: Id + type: integer + created_at: + title: Created At + type: string + format: date-time + updated_at: + title: Updated At + type: string + format: date-time + account_id: + title: Account Id + description: The account the connection is associated with + type: integer + name: + title: Name + description: The name of the connection + type: string + adapter_version: + description: Identifies the warehouse and version of its adapter + allOf: + - $ref: "#/components/schemas/DbtAdapterVersion" + private_link_endpoint_id: + title: Private Link Endpoint Id + type: string + is_ssh_tunnel_enabled: + title: Is Ssh Tunnel Enabled + default: false + type: boolean + oauth_redirect_uri: + title: Oauth Redirect Uri + description: + If OAuth is enabled for this connection, this field is used + internally by dbt Cloud + type: string + oauth_configuration_id: + title: Oauth Configuration Id + type: integer + is_configured_for_native_oauth: + title: Is Configured For Native Oauth + type: boolean + config: + title: Config + description: The adapter-specific configuration for the connection + anyOf: + - $ref: "#/components/schemas/SnowflakeConnection" + - $ref: "#/components/schemas/PostgresConnection" + - $ref: "#/components/schemas/RedshiftConnection" + - $ref: "#/components/schemas/BigqueryConnection" + - $ref: "#/components/schemas/DatabricksConnection" + - $ref: "#/components/schemas/DatabricksSparkConnection" + - $ref: "#/components/schemas/TrinoConnection" + - $ref: "#/components/schemas/FabricConnection" + - $ref: "#/components/schemas/SynapseConnection" + - $ref: "#/components/schemas/ApacheSparkConnection" + - $ref: "#/components/schemas/AthenaConnection" + required: + - id + - created_at + - updated_at + - account_id + - name + - adapter_version + - oauth_redirect_uri + - config + GetAccountConnectionResponse: + title: GetAccountConnectionResponse + type: object + properties: + status: + $ref: "#/components/schemas/Status" + data: + $ref: "#/components/schemas/GetAccountConnection" + extra: + title: Extra + type: object + error_code: + title: Error Code + type: integer + required: + - status + - data + GetIntegration: + title: GetIntegration + type: object + properties: + id: + title: Id + type: integer + created_at: + title: Created At + type: string + format: date-time + updated_at: + title: Updated At + type: string + format: date-time + account_id: + title: Account Id + description: The account the integration is associated with + type: integer + project_id: + title: Project Id + description: The project the integration is associated with + type: integer + name: + title: Name + description: The name of the integration + type: string + config: + title: Config + description: The integration config + allOf: + - $ref: "#/components/schemas/TableauIntegration" + required: + - id + - created_at + - updated_at + - account_id + - project_id + - name + - config + GetIntegrationResponse: + title: GetIntegrationResponse + type: object + properties: + status: + $ref: "#/components/schemas/Status" + data: + $ref: "#/components/schemas/GetIntegration" + extra: + title: Extra + type: object + error_code: + title: Error Code + type: integer + required: + - status + - data + GetIntegrationWatchSelectionResponse: + title: GetIntegrationWatchSelectionResponse + type: object + properties: + added: + title: Added + description: Number of collections additionally being watched + type: integer + removed: + title: Removed + description: Number of collections no longer being watched + type: integer + required: + - added + - removed GetWebhooksReceiptResponseEnvelope: type: object properties: data: - $ref: '#/components/schemas/Receipt' + $ref: "#/components/schemas/Receipt" status: - $ref: '#/components/schemas/ResponseStatus' + $ref: "#/components/schemas/ResponseStatus" required: - - data - - status + - data + - status GitCloneStrategyEnum: enum: - - azure_active_directory_app - - deploy_key - - deploy_token - - github_app - - git_token + - azure_active_directory_app + - deploy_key + - deploy_token + - github_app + - git_token type: string description: |- * `azure_active_directory_app` - azure_active_directory_app @@ -4087,30 +5328,32 @@ components: account_id: type: integer provider_type: - $ref: '#/components/schemas/ProviderTypeEnum' + $ref: "#/components/schemas/ProviderTypeEnum" state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - provider_type + - account_id + - provider_type GitProviderRequest: type: object properties: account_id: type: integer provider_type: - $ref: '#/components/schemas/ProviderTypeEnum' + $ref: "#/components/schemas/ProviderTypeEnum" state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - provider_type + - account_id + - provider_type Group: type: object properties: @@ -4141,23 +5384,23 @@ components: group_permissions: type: array items: - $ref: '#/components/schemas/GroupPermission' + $ref: "#/components/schemas/GroupPermission" readOnly: true default: [] required: - - created_at - - group_permissions - - updated_at + - created_at + - group_permissions + - updated_at GroupEnveloped: type: object properties: data: - $ref: '#/components/schemas/Group' + $ref: "#/components/schemas/Group" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status GroupPermission: type: object properties: @@ -4170,7 +5413,7 @@ components: all_projects: type: boolean permission_set: - $ref: '#/components/schemas/PermissionSetEnum' + $ref: "#/components/schemas/PermissionSetEnum" permission_level: type: integer id: @@ -4178,18 +5421,19 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted writable_environment_categories: type: array items: type: string required: - - account_id - - all_projects - - group_id - - permission_set - - writable_environment_categories + - account_id + - all_projects + - group_id + - permission_set + - writable_environment_categories GroupRequest: type: object properties: @@ -4203,7 +5447,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted assign_by_default: type: boolean @@ -4213,16 +5458,17 @@ components: type: string minLength: 1 required: - - account_id - - assign_by_default - - name + - account_id + - assign_by_default + - name IPRestrictionCidr: type: object properties: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted ip_restriction_rule_id: type: integer @@ -4233,16 +5479,17 @@ components: cidr_ipv6: type: string required: - - cidr - - enabled - - ip_restriction_rule_id + - cidr + - enabled + - ip_restriction_rule_id IPRestrictionCidrRequestRequest: type: object properties: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted cidr: type: string @@ -4250,13 +5497,15 @@ components: id: type: integer required: - - cidr + - cidr IPRestrictionRequestRequest: type: object properties: name: type: string minLength: 1 + type: + $ref: "#/components/schemas/TypeEdaEnum" rule_set_enabled: type: boolean account_id: @@ -4264,15 +5513,16 @@ components: cidrs: type: array items: - $ref: '#/components/schemas/IPRestrictionCidrRequestRequest' + $ref: "#/components/schemas/IPRestrictionCidrRequestRequest" description: type: string minLength: 1 required: - - account_id - - cidrs - - name - - rule_set_enabled + - account_id + - cidrs + - name + - rule_set_enabled + - type IPRestrictionRule: type: object properties: @@ -4283,7 +5533,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted ip_restriction_rule_set_id: type: integer @@ -4294,7 +5545,7 @@ components: cidrs: type: array items: - $ref: '#/components/schemas/IPRestrictionCidr' + $ref: "#/components/schemas/IPRestrictionCidr" created_by_id: type: integer created_by_service_token_id: @@ -4316,34 +5567,40 @@ components: format: date-time readOnly: true required: - - created_at - - enabled_for_service_tokens - - id - - updated_at + - created_at + - enabled_for_service_tokens + - id + - updated_at IPRestrictionRuleEnveloped: type: object properties: data: - $ref: '#/components/schemas/IPRestrictionRule' + $ref: "#/components/schemas/IPRestrictionRule" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status IPRestrictionSetRequestRequest: type: object properties: enabled: type: boolean required: - - enabled + - enabled IPRestrictionSetValidate: type: object properties: is_valid_for_admin: type: boolean required: - - is_valid_for_admin + - is_valid_for_admin + IntegrationType: + title: IntegrationType + description: An enumeration. + enum: + - tableau + type: string InviteUsersRequestRequest: type: object properties: @@ -4355,14 +5612,14 @@ components: type: string minLength: 1 license_type: - $ref: '#/components/schemas/LicenseTypeEnum' + $ref: "#/components/schemas/LicenseTypeEnum" group_ids: type: array items: type: integer required: - - email_addresses - - license_type + - email_addresses + - license_type InviteUsersResponse: type: object properties: @@ -4372,126 +5629,12 @@ components: type: object properties: data: - $ref: '#/components/schemas/InviteUsersResponse' + $ref: "#/components/schemas/InviteUsersResponse" status: - $ref: '#/components/schemas/Status' - required: - - data - - status - JobDefinitionExecution: - type: object - properties: - timeout_seconds: - type: integer - required: - - timeout_seconds - JobDefinitionSchedule: - type: object - properties: - cron: - type: string - date: - $ref: '#/components/schemas/DateEnum' - time: - $ref: '#/components/schemas/TimeEnum' - required: - - cron - - date - - time - JobDefinitionSettings: - type: object - properties: - threads: - type: integer - target_name: - type: string - required: - - target_name - - threads - JobDefinitionTriggers: - type: object - properties: - github_webhook: - type: boolean - schedule: - type: boolean - git_provider_webhook: - type: boolean - on_merge: - type: boolean - required: - - github_webhook - - schedule - JobDefinitionV2: - type: object - properties: - environment_id: - type: integer - account_id: - type: integer - project_id: - type: integer - name: - type: string - description: - type: string - generate_docs: - type: boolean - run_generate_sources: - type: boolean - state: - type: integer - default: 1 - description: A value of 1 means this entity is active and a value of 2 means - this entity is deleted - dbt_version: - type: string - triggers: - $ref: '#/components/schemas/JobDefinitionTriggers' - settings: - $ref: '#/components/schemas/JobDefinitionSettings' - execution: - $ref: '#/components/schemas/JobDefinitionExecution' - schedule: - $ref: '#/components/schemas/JobDefinitionSchedule' - execute_steps: - type: array - items: - type: string - most_recent_run: - $ref: '#/components/schemas/Run' - most_recent_completed_run: - $ref: '#/components/schemas/Run' - job_type: - $ref: '#/components/schemas/JobTypeEnum' - triggers_on_draft_pr: - type: boolean - default: false - run_audit_helper: - type: boolean - default: false - run_compare_changes: - type: boolean - default: false + $ref: "#/components/schemas/Status" required: - - account_id - - environment_id - - generate_docs - - name - - project_id - - run_generate_sources - JobTypeEnum: - enum: - - ci - - scheduled - - other - - merge - type: string - description: |- - * `ci` - ci - * `scheduled` - scheduled - * `other` - other - * `merge` - merge + - data + - status LicenseMap: type: object properties: @@ -4500,7 +5643,7 @@ components: account_id: type: integer license_type: - $ref: '#/components/schemas/LicenseTypeEnum' + $ref: "#/components/schemas/LicenseTypeEnum" state: type: integer default: 1 @@ -4517,18 +5660,18 @@ components: format: date-time readOnly: true required: - - created_at - - updated_at + - created_at + - updated_at LicenseMapEnveloped: type: object properties: data: - $ref: '#/components/schemas/LicenseMap' + $ref: "#/components/schemas/LicenseMap" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status LicenseMapRequest: type: object properties: @@ -4537,11 +5680,12 @@ components: account_id: type: integer license_type: - $ref: '#/components/schemas/LicenseTypeEnum' + $ref: "#/components/schemas/LicenseTypeEnum" state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted sso_license_mapping_groups: type: array @@ -4549,168 +5693,931 @@ components: type: string minLength: 1 required: - - account_id - - license_type + - account_id + - license_type LicenseTypeEnum: enum: - - developer - - read_only - - it + - developer + - read_only + - it + - explorer type: string description: |- * `developer` - DEVELOPER * `read_only` - READ_ONLY * `it` - IT - ListWebhooksReceiptsResponseEnvelope: + * `explorer` - EXPLORER + ListAccountConnection: + title: ListAccountConnection type: object properties: - data: + id: + title: Id + type: integer + created_at: + title: Created At + type: string + format: date-time + updated_at: + title: Updated At + type: string + format: date-time + account_id: + title: Account Id + description: The account the connection is associated with + type: integer + name: + title: Name + description: The name of the connection + type: string + adapter_version: + description: Identifies the warehouse and version of its adapter + allOf: + - $ref: "#/components/schemas/DbtAdapterVersion" + private_link_endpoint_id: + title: Private Link Endpoint Id + type: string + is_ssh_tunnel_enabled: + title: Is Ssh Tunnel Enabled + default: false + type: boolean + oauth_configuration_id: + title: Oauth Configuration Id + description: + The OAuth Configuration associated with this connection. When + set,developer credentials leveraging OAuth may be created. + type: integer + environment__count: + title: Environment Count + description: The number of environments using this connection + type: integer + required: + - id + - created_at + - updated_at + - account_id + - name + - adapter_version + - environment__count + ListIntegrationCollection: + title: ListIntegrationCollection + type: object + properties: + collections: + title: Collections + description: List of collections type: array items: - $ref: '#/components/schemas/Receipt' - status: - $ref: '#/components/schemas/ResponseStatus' + $ref: "#/components/schemas/WatchSelectionItem" required: - - data - - status - NotFound: + - collections + ListIntegrationResponse: + title: ListIntegrationResponse type: object properties: - data: + id: + title: Id + description: The integration's ID + type: integer + created_at: + title: Created At + type: string + format: date-time + updated_at: + title: Updated At + type: string + format: date-time + account_id: + title: Account Id + description: The account the integration is associated with + type: integer + project_id: + title: Project Id + description: The project the integration is associated with + type: integer + name: + title: Name + description: The name of the integration + type: string + required: + - id + - created_at + - updated_at + - account_id + - project_id + - name + ListIntegrationResponseResponse: + title: ListIntegrationResponseResponse + type: object + properties: + status: + $ref: "#/components/schemas/Status" + data: + $ref: "#/components/schemas/ListIntegrationResponse" + extra: + title: Extra + type: object + error_code: + title: Error Code + type: integer + required: + - status + - data + ListListAccountConnectionResponse: + title: ListListAccountConnectionResponse + type: object + properties: + status: + $ref: "#/components/schemas/Status" + data: + title: Data + type: array + items: + $ref: "#/components/schemas/ListAccountConnection" + extra: + title: Extra + type: object + error_code: + title: Error Code + type: integer + required: + - status + - data + ListWebhooksReceiptsResponseEnvelope: + type: object + properties: + data: + type: array + items: + $ref: "#/components/schemas/Receipt" + status: + $ref: "#/components/schemas/ResponseStatus" + required: + - data + - status + Method: + title: Method + description: An enumeration. + enum: + - odbc + type: string + NotFound: + type: object + properties: + data: type: object additionalProperties: {} nullable: true status: - $ref: '#/components/schemas/NotFoundStatus' + $ref: "#/components/schemas/NotFoundStatus" required: - - status + - status NotFoundStatus: type: object properties: - code: + code: + type: integer + default: 404 + is_success: + type: boolean + user_message: + type: string + developer_message: + type: string + required: + - developer_message + - is_success + - user_message + OAuthConfiguration: + type: object + properties: + account_id: + type: integer + type: + type: string + name: + type: string + extra_data: {} + client_id: + type: string + authorize_url: + type: string + token_url: + type: string + redirect_uri: + type: string + id: + type: integer + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + required: + - created_at + - id + - updated_at + OAuthConfigurationEnveloped: + type: object + properties: + data: + $ref: "#/components/schemas/OAuthConfiguration" + status: + $ref: "#/components/schemas/Status" + required: + - data + - status + OAuthConfigurationRequest: + type: object + properties: + account_id: + type: integer + type: + type: string + minLength: 1 + name: + type: string + minLength: 1 + extra_data: {} + client_id: + type: string + minLength: 1 + client_secret: + type: string + writeOnly: true + minLength: 1 + authorize_url: + type: string + minLength: 1 + token_url: + type: string + minLength: 1 + redirect_uri: + type: string + minLength: 1 + required: + - account_id + - type + OptionalApacheSparkConnection: + title: OptionalApacheSparkConnection + type: object + properties: + host: + title: Host + type: string + cluster: + title: Cluster + type: string + method: + $ref: "#/components/schemas/ConnectionMethod" + connect_timeout: + title: Connect Timeout + type: integer + connect_retries: + title: Connect Retries + type: integer + organization: + title: Organization + type: string + user: + title: User + type: string + auth: + title: Auth + type: string + kerberos_service_name: + title: Kerberos Service Name + type: string + port: + title: Port + type: integer + adapter_id: + title: Adapter Id + type: integer + OptionalAthenaConnection: + title: OptionalAthenaConnection + type: object + properties: + region_name: + title: Region Name + type: string + database: + title: Database + type: string + work_group: + title: Work Group + type: string + spark_work_group: + title: Spark Work Group + type: string + s3_staging_dir: + title: S3 Staging Dir + type: string + s3_data_dir: + title: S3 Data Dir + type: string + s3_data_naming: + title: S3 Data Naming + type: string + s3_tmp_table_dir: + title: S3 Tmp Table Dir + type: string + poll_interval: + title: Poll Interval + type: integer + num_retries: + title: Num Retries + type: integer + num_boto3_retries: + title: Num Boto3 Retries + type: integer + num_iceberg_retries: + title: Num Iceberg Retries + type: integer + adapter_id: + title: Adapter Id + type: integer + OptionalBigqueryConnection: + title: OptionalBigqueryConnection + type: object + properties: + project_id: + title: Project Id + type: string + timeout_seconds: + title: Timeout Seconds + type: integer + private_key_id: + title: Private Key Id + type: string + private_key: + title: Private Key + type: string + writeOnly: true + format: password + client_email: + title: Client Email + type: string + client_id: + title: Client Id + type: string + auth_uri: + title: Auth Uri + type: string + token_uri: + title: Token Uri + type: string + auth_provider_x509_cert_url: + title: Auth Provider X509 Cert Url + type: string + client_x509_cert_url: + title: Client X509 Cert Url + type: string + priority: + $ref: "#/components/schemas/Priority" + scopes: + title: Scopes + type: array + items: + type: string + location: + title: Location + type: string + maximum_bytes_billed: + title: Maximum Bytes Billed + type: integer + execution_project: + title: Execution Project + type: string + impersonate_service_account: + title: Impersonate Service Account + type: string + retries: + title: Retries + type: integer + job_retry_deadline_seconds: + title: Job Retry Deadline Seconds + type: integer + job_creation_timeout_seconds: + title: Job Creation Timeout Seconds + type: integer + application_id: + title: Application Id + type: string + writeOnly: true + format: password + application_secret: + title: Application Secret + type: string + writeOnly: true + format: password + gcs_bucket: + title: Gcs Bucket + type: string + dataproc_region: + title: Dataproc Region + type: string + dataproc_cluster_name: + title: Dataproc Cluster Name + type: string + OptionalDatabricksConnection: + title: OptionalDatabricksConnection + type: object + properties: + host: + title: Host + type: string + http_path: + title: Http Path + type: string + catalog: + title: Catalog + type: string + client_id: + title: Client Id + type: string + writeOnly: true + format: password + client_secret: + title: Client Secret + type: string + writeOnly: true + format: password + adapter_id: + title: Adapter Id + type: integer + OptionalDatabricksSparkConnection: + title: OptionalDatabricksSparkConnection + type: object + properties: + host: + title: Host + type: string + method: + $ref: "#/components/schemas/Method" + port: + title: Port + type: integer + cluster: + title: Cluster + type: string + endpoint: + title: Endpoint + type: string + driver: + title: Driver + type: string + organization: + title: Organization + type: string + user: + title: User + type: string + adapter_id: + title: Adapter Id + type: integer + OptionalFabricConnection: + title: OptionalFabricConnection + type: object + properties: + server: + title: Server + type: string + database: + title: Database + type: string + driver: + title: Driver + type: string + port: + title: Port + type: integer + retries: + title: Retries + type: integer + login_timeout: + title: Login Timeout + type: integer + query_timeout: + title: Query Timeout + type: integer + adapter_id: + title: Adapter Id + type: integer + OptionalPostgresConnection: + title: OptionalPostgresConnection + type: object + properties: + hostname: + title: Hostname + type: string + dbname: + title: Dbname + type: string + port: + title: Port + type: integer + OptionalRedshiftConnection: + title: OptionalRedshiftConnection + type: object + properties: + hostname: + title: Hostname + type: string + dbname: + title: Dbname + type: string + port: + title: Port + type: integer + OptionalSnowflakeConnection: + title: OptionalSnowflakeConnection + type: object + properties: + account: + title: Account + type: string + database: + title: Database + type: string + warehouse: + title: Warehouse + type: string + client_session_keep_alive: + title: Client Session Keep Alive + type: boolean + role: + title: Role + type: string + allow_sso: + title: Allow Sso + type: boolean + oauth_client_id: + title: Oauth Client Id + type: string + writeOnly: true + format: password + oauth_client_secret: + title: Oauth Client Secret + type: string + writeOnly: true + format: password + OptionalSynapseConnection: + title: OptionalSynapseConnection + type: object + properties: + host: + title: Host + type: string + database: + title: Database + type: string + driver: + title: Driver + type: string + port: + title: Port + type: integer + retries: + title: Retries + type: integer + login_timeout: + title: Login Timeout + type: integer + query_timeout: + title: Query Timeout + type: integer + adapter_id: + title: Adapter Id + type: integer + OptionalTableauIntegration: + title: OptionalTableauIntegration + type: object + properties: + host: + title: Host + type: string + site_id: + title: Site Id + type: string + token_name: + title: Token Name + type: string + token: + title: Token + type: string + writeOnly: true + format: password + OptionalTrinoConnection: + title: OptionalTrinoConnection + type: object + properties: + host: + title: Host + type: string + method: + title: Method + type: string + port: + title: Port + type: integer + adapter_id: + title: Adapter Id + type: integer + PaginatedWebhooksEvents: + type: object + properties: + data: + type: array + items: + $ref: "#/components/schemas/Event" + status: + $ref: "#/components/schemas/ResponseStatus" + extra: + $ref: "#/components/schemas/PaginationExtra" + required: + - data + - extra + - status + PaginatedWebhooksSubscriptions: + type: object + properties: + data: + type: array + items: + $ref: "#/components/schemas/Subscription" + status: + $ref: "#/components/schemas/ResponseStatus" + extra: + $ref: "#/components/schemas/PaginationExtra" + required: + - data + - extra + - status + Pagination: + type: object + properties: + total_count: + type: integer + count: + type: integer + required: + - count + - total_count + PaginationExtra: + type: object + properties: + pagination: + $ref: "#/components/schemas/Pagination" + filters: + $ref: "#/components/schemas/Filters" + required: + - filters + - pagination + PatchAccountConnectionRequest: + title: PatchAccountConnection + description: parent class for all request bodies, to be extended by each endpoint + type: object + properties: + account_id: + title: Account Id + description: The account the connection is associated with + type: integer + name: + title: Name + description: The name of the connection + type: string + private_link_endpoint_id: + title: Private Link Endpoint Id + type: string + is_ssh_tunnel_enabled: + title: Is Ssh Tunnel Enabled + default: false + type: boolean + oauth_configuration_id: + title: Oauth Configuration Id + type: integer + config: + title: Config + description: The adapter-specific configuration for the connection + anyOf: + - $ref: "#/components/schemas/OptionalSnowflakeConnection" + - $ref: "#/components/schemas/OptionalPostgresConnection" + - $ref: "#/components/schemas/OptionalRedshiftConnection" + - $ref: "#/components/schemas/OptionalBigqueryConnection" + - $ref: "#/components/schemas/OptionalDatabricksConnection" + - $ref: "#/components/schemas/OptionalDatabricksSparkConnection" + - $ref: "#/components/schemas/OptionalTrinoConnection" + - $ref: "#/components/schemas/OptionalFabricConnection" + - $ref: "#/components/schemas/OptionalSynapseConnection" + - $ref: "#/components/schemas/OptionalApacheSparkConnection" + - $ref: "#/components/schemas/OptionalAthenaConnection" + additionalProperties: false + PatchIntegrationRequest: + title: PatchIntegration + description: parent class for all request bodies, to be extended by each endpoint + type: object + properties: + name: + description: The name of the integration + allOf: + - $ref: "#/components/schemas/IntegrationType" + account_id: + title: Account Id + description: The account the integration is associated with + type: integer + project_id: + title: Project Id + description: The project the integration is associated with + type: integer + config: + title: Config + description: The integration configuration for this type of integration + allOf: + - $ref: "#/components/schemas/OptionalTableauIntegration" + additionalProperties: false + PermissionSetEnum: + enum: + - owner + - member + - account_admin + - security_admin + - billing_admin + - admin + - database_admin + - git_admin + - team_admin + - job_admin + - job_runner + - job_viewer + - analyst + - developer + - stakeholder + - readonly + - project_creator + - account_viewer + - metadata_only + - semantic_layer_only + - webhooks_only + - manage_marketplace_apps + type: string + description: |- + * `owner` - OWNER + * `member` - MEMBER + * `account_admin` - ACCOUNT_ADMIN + * `security_admin` - SECURITY_ADMIN + * `billing_admin` - BILLING_ADMIN + * `admin` - ADMIN + * `database_admin` - DATABASE_ADMIN + * `git_admin` - GIT_ADMIN + * `team_admin` - TEAM_ADMIN + * `job_admin` - JOB_ADMIN + * `job_runner` - JOB_RUNNER + * `job_viewer` - JOB_VIEWER + * `analyst` - ANALYST + * `developer` - DEVELOPER + * `stakeholder` - STAKEHOLDER + * `readonly` - READONLY + * `project_creator` - PROJECT_CREATOR + * `account_viewer` - ACCOUNT_VIEWER + * `metadata_only` - METADATA_ONLY + * `semantic_layer_only` - SEMANTIC_LAYER_ONLY + * `webhooks_only` - WEBHOOKS_ONLY + * `manage_marketplace_apps` - MANAGE_MARKETPLACE_APPS + PostAccountConnectionRequest: + title: PostAccountConnection + description: parent class for all request bodies, to be extended by each endpoint + type: object + properties: + account_id: + title: Account Id + description: The account the connection is associated with type: integer - default: 404 - is_success: - type: boolean - user_message: + name: + title: Name + description: The name of the connection type: string - developer_message: + adapter_version: + description: Identifies the warehouse and version of its adapter + allOf: + - $ref: "#/components/schemas/DbtAdapterVersion" + private_link_endpoint_id: + title: Private Link Endpoint Id type: string + is_ssh_tunnel_enabled: + title: Is Ssh Tunnel Enabled + default: false + type: boolean + oauth_configuration_id: + title: Oauth Configuration Id + type: integer + config: + title: Config + description: The adapter-specific configuration for the connection + anyOf: + - $ref: "#/components/schemas/SnowflakeConnection" + - $ref: "#/components/schemas/PostgresConnection" + - $ref: "#/components/schemas/RedshiftConnection" + - $ref: "#/components/schemas/BigqueryConnection" + - $ref: "#/components/schemas/DatabricksConnection" + - $ref: "#/components/schemas/DatabricksSparkConnection" + - $ref: "#/components/schemas/TrinoConnection" + - $ref: "#/components/schemas/FabricConnection" + - $ref: "#/components/schemas/SynapseConnection" + - $ref: "#/components/schemas/ApacheSparkConnection" + - $ref: "#/components/schemas/AthenaConnection" required: - - developer_message - - is_success - - user_message - PaginatedWebhooksEvents: + - account_id + - name + - adapter_version + additionalProperties: false + PostIntegrationRequest: + title: PostIntegration + description: parent class for all request bodies, to be extended by each endpoint type: object properties: - data: - type: array - items: - $ref: '#/components/schemas/Event' - status: - $ref: '#/components/schemas/ResponseStatus' - extra: - $ref: '#/components/schemas/PaginationExtra' + name: + description: The name of the integration + allOf: + - $ref: "#/components/schemas/IntegrationType" + account_id: + title: Account Id + description: The account the integration is associated with + type: integer + project_id: + title: Project Id + description: The project the integration is associated with + type: integer + config: + title: Config + description: The integration configuration for this type of integration + allOf: + - $ref: "#/components/schemas/TableauIntegration" required: - - data - - extra - - status - PaginatedWebhooksSubscriptions: + - name + - account_id + additionalProperties: false + PostIntegrationWatchSelectionRequest: + title: PostIntegrationWatchSelection + description: parent class for all request bodies, to be extended by each endpoint type: object properties: - data: + to_add: + title: To Add + description: Collections to start watching type: array items: - $ref: '#/components/schemas/Subscription' - status: - $ref: '#/components/schemas/ResponseStatus' - extra: - $ref: '#/components/schemas/PaginationExtra' - required: - - data - - extra - - status - Pagination: + $ref: "#/components/schemas/WatchSelectionItem" + to_remove: + title: To Remove + description: Identifiers of collections to stop watching + type: array + items: + type: string + additionalProperties: false + PostgresConnection: + title: PostgresConnection type: object properties: - total_count: - type: integer - count: + hostname: + title: Hostname + maxLength: 1024 + minLength: 1 + type: string + dbname: + title: Dbname + maxLength: 63 + minLength: 1 + type: string + port: + title: Port + default: 5432 + exclusiveMinimum: 0 + maximum: 65535 type: integer required: - - count - - total_count - PaginationExtra: - type: object - properties: - pagination: - $ref: '#/components/schemas/Pagination' - filters: - $ref: '#/components/schemas/Filters' - required: - - filters - - pagination - PermissionSetEnum: - enum: - - owner - - member - - account_admin - - security_admin - - billing_admin - - admin - - database_admin - - git_admin - - team_admin - - job_admin - - job_runner - - job_viewer - - analyst - - developer - - stakeholder - - readonly - - project_creator - - account_viewer - - metadata_only - - semantic_layer_only - - webhooks_only - type: string - description: |- - * `owner` - owner - * `member` - member - * `account_admin` - account_admin - * `security_admin` - security_admin - * `billing_admin` - billing_admin - * `admin` - admin - * `database_admin` - database_admin - * `git_admin` - git_admin - * `team_admin` - team_admin - * `job_admin` - job_admin - * `job_runner` - job_runner - * `job_viewer` - job_viewer - * `analyst` - analyst - * `developer` - developer - * `stakeholder` - stakeholder - * `readonly` - readonly - * `project_creator` - project_creator - * `account_viewer` - account_viewer - * `metadata_only` - metadata_only - * `semantic_layer_only` - semantic_layer_only - * `webhooks_only` - webhooks_only + - hostname + - dbname PostgresCredentials: type: object properties: - id: - type: integer account_id: type: integer + id: + type: integer project_id: type: integer type: - $ref: '#/components/schemas/Type32eEnum' + $ref: "#/components/schemas/Type32eEnum" state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted threads: type: integer @@ -4720,13 +6627,37 @@ components: type: string target_name: type: string + adapter_version: + allOf: + - $ref: "#/components/schemas/AdapterVersionEnum" + description: |- + The version of the adapter used to create this connection. Can use instead of adapter_id. + + * `apache_spark_v0` - apache_spark_v0 + * `databricks_spark_v0` - databricks_spark_v0 + * `databricks_v0` - databricks_v0 + * `trino_v0` - trino_v0 + * `snowflake_v0` - snowflake_v0 + * `bigquery_v0` - bigquery_v0 + * `postgres_v0` - postgres_v0 + * `redshift_v0` - redshift_v0 + * `synapse_v0` - synapse_v0 + * `fabric_v0` - fabric_v0 + * `athena_v0` - athena_v0 required: - - account_id - - default_schema - - target_name - - threads - - type - - username + - account_id + - default_schema + - target_name + - threads + - type + - username + Priority: + title: Priority + description: An enumeration. + enum: + - interactive + - batch + type: string PrivateLinkEndpoint: type: object properties: @@ -4744,7 +6675,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted id: type: string @@ -4758,21 +6690,21 @@ components: format: date-time readOnly: true required: - - created_at - - id - - updated_at + - created_at + - id + - updated_at PrivateLinkEndpointEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/PrivateLinkEndpoint' + $ref: "#/components/schemas/PrivateLinkEndpoint" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status Project: type: object properties: @@ -4814,21 +6746,21 @@ components: type: string connection: allOf: - - $ref: '#/components/schemas/BaseConnectionV3' + - $ref: "#/components/schemas/BaseConnectionV3" readOnly: true environments: type: array items: - $ref: '#/components/schemas/EnvironmentV3' + $ref: "#/components/schemas/EnvironmentV3" readOnly: true repository: allOf: - - $ref: '#/components/schemas/RepositoryV3' + - $ref: "#/components/schemas/RepositoryV3" readOnly: true group_permissions: type: array items: - $ref: '#/components/schemas/GroupPermission' + $ref: "#/components/schemas/GroupPermission" readOnly: true docs_job_id: type: integer @@ -4836,33 +6768,23 @@ components: freshness_job_id: type: integer description: The job used for source freshness generation - docs_job: - allOf: - - $ref: '#/components/schemas/JobDefinitionV2' - readOnly: true - freshness_job: - allOf: - - $ref: '#/components/schemas/JobDefinitionV2' - readOnly: true required: - - connection - - created_at - - docs_job - - environments - - freshness_job - - group_permissions - - repository - - updated_at + - connection + - created_at + - environments + - group_permissions + - repository + - updated_at ProjectEnveloped: type: object properties: data: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ProjectRequest: type: object properties: @@ -4894,7 +6816,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted dbt_project_subdirectory: type: string @@ -4906,16 +6829,16 @@ components: type: integer description: The job used for source freshness generation required: - - account_id - - name + - account_id + - name ProviderTypeEnum: enum: - - azure_active_directory - - github - - gitlab - - git_url - - managed_github - - manual_config + - azure_active_directory + - github + - gitlab + - git_url + - managed_github + - manual_config type: string description: |- * `azure_active_directory` - azure_active_directory @@ -4944,19 +6867,19 @@ components: format: date-time readOnly: true required: - - created_at + - created_at PublicAuditLogEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/PublicAuditLog' + $ref: "#/components/schemas/PublicAuditLog" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status Receipt: type: object properties: @@ -4979,22 +6902,40 @@ components: response_body: type: string required: - - dispatched_at - - error_info - - event_id - - http_status_code - - id - - request_body - - request_headers - - response_body - - subscription_id + - dispatched_at + - error_info + - event_id + - http_status_code + - id + - request_body + - request_headers + - response_body + - subscription_id + RedshiftConnection: + title: RedshiftConnection + type: object + properties: + hostname: + title: Hostname + type: string + dbname: + title: Dbname + type: string + port: + title: Port + default: 5432 + exclusiveMinimum: 0 + maximum: 65535 + type: integer + required: + - hostname RemoteBackendEnum: enum: - - azure_active_directory - - github - - managed - - gitlab - - manual_config + - azure_active_directory + - github + - managed + - gitlab + - manual_config type: string description: |- * `azure_active_directory` - azure_active_directory @@ -5016,7 +6957,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted project_access_token_id: type: integer @@ -5024,8 +6966,8 @@ components: type: string format: date-time required: - - account_id - - gitlab_project_id + - account_id + - gitlab_project_id RepositoryGitlabRequest: type: object properties: @@ -5040,7 +6982,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted project_access_token_id: type: integer @@ -5052,8 +6995,8 @@ components: type: string format: date-time required: - - account_id - - gitlab_project_id + - account_id + - gitlab_project_id RepositoryV3: type: object properties: @@ -5070,7 +7013,7 @@ components: description: The name of the repo remote_backend: allOf: - - $ref: '#/components/schemas/RemoteBackendEnum' + - $ref: "#/components/schemas/RemoteBackendEnum" description: |- The associated git provider @@ -5081,7 +7024,7 @@ components: * `manual_config` - manual_config git_clone_strategy: allOf: - - $ref: '#/components/schemas/GitCloneStrategyEnum' + - $ref: "#/components/schemas/GitCloneStrategyEnum" description: |- The strategy to use when cloning the repo @@ -5101,28 +7044,29 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string git_provider_id: type: integer gitlab: - $ref: '#/components/schemas/RepositoryGitlab' + $ref: "#/components/schemas/RepositoryGitlab" git_provider: - $ref: '#/components/schemas/GitProvider' + $ref: "#/components/schemas/GitProvider" required: - - account_id + - account_id RepositoryV3Enveloped: type: object properties: data: - $ref: '#/components/schemas/RepositoryV3' + $ref: "#/components/schemas/RepositoryV3" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status RepositoryV3Request: type: object properties: @@ -5140,7 +7084,7 @@ components: description: The name of the repo remote_backend: allOf: - - $ref: '#/components/schemas/RemoteBackendEnum' + - $ref: "#/components/schemas/RemoteBackendEnum" description: |- The associated git provider @@ -5151,7 +7095,7 @@ components: * `manual_config` - manual_config git_clone_strategy: allOf: - - $ref: '#/components/schemas/GitCloneStrategyEnum' + - $ref: "#/components/schemas/GitCloneStrategyEnum" description: |- The strategy to use when cloning the repo @@ -5175,7 +7119,8 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted private_link_endpoint_id: type: string @@ -5183,11 +7128,11 @@ components: git_provider_id: type: integer gitlab: - $ref: '#/components/schemas/RepositoryGitlabRequest' + $ref: "#/components/schemas/RepositoryGitlabRequest" git_provider: - $ref: '#/components/schemas/GitProviderRequest' + $ref: "#/components/schemas/GitProviderRequest" required: - - account_id + - account_id ResponseData: type: object properties: @@ -5198,77 +7143,19 @@ components: items: type: integer failures: - description: This field will detail specific failures within a single environment + description: + This field will detail specific failures within a single environment variable you are attempting to create. required: - - message - - new_var_ids + - message + - new_var_ids ResponseStatus: type: object properties: code: type: integer required: - - code - Run: - type: object - properties: - id: - type: integer - trigger_id: - type: integer - account_id: - type: integer - environment_id: - type: integer - project_id: - type: integer - job_definition_id: - type: integer - status: - type: integer - dbt_version: - type: string - git_branch: - type: string - git_sha: - type: string - status_message: - type: string - owner_thread_id: - type: string - executed_by_thread_id: - type: string - deferring_run_id: - type: integer - artifacts_saved: - type: boolean - artifact_s3_path: - type: string - has_docs_generated: - type: boolean - has_sources_generated: - type: boolean - notifications_sent: - type: boolean - blocked_by: - type: array - items: - type: integer - is_running: - type: boolean - required: - - account_id - - artifacts_saved - - blocked_by - - dbt_version - - environment_id - - has_docs_generated - - has_sources_generated - - job_definition_id - - notifications_sent - - project_id - - status + - code Schema: type: object properties: @@ -5280,13 +7167,13 @@ components: field_groups: type: array items: - $ref: '#/components/schemas/Group' + $ref: "#/components/schemas/Group" description: Specification of how certain fields should be grouped SchemaTypeEnum: enum: - - connection - - credential - - semantic_layer_credentials + - connection + - credential + - semantic_layer_credentials type: string description: |- * `connection` - connection @@ -5300,9 +7187,12 @@ components: account_id: type: integer description: The account the credentials are associated with + project_id: + type: integer + description: The project the credentials are associated with adapter_version: allOf: - - $ref: '#/components/schemas/AdapterVersionEnum' + - $ref: "#/components/schemas/AdapterVersionEnum" description: |- The adapter version. Should match the associated project's adapter version. @@ -5316,15 +7206,24 @@ components: * `redshift_v0` - redshift_v0 * `synapse_v0` - synapse_v0 * `fabric_v0` - fabric_v0 + * `athena_v0` - athena_v0 schema_type: allOf: - - $ref: '#/components/schemas/SchemaTypeEnum' + - $ref: "#/components/schemas/SchemaTypeEnum" description: |- The adapter schema type. Should always be 'semantic_layer_credentials' * `connection` - connection * `credential` - credential * `semantic_layer_credentials` - semantic_layer_credentials + name: + type: string + description: The user-facing name to identify these credentials. + service_tokens: + type: array + items: + $ref: "#/components/schemas/ServiceTokenLite" + readOnly: true created_at: type: string format: date-time @@ -5337,18 +7236,19 @@ components: type: integer default: 1 required: - - created_at - - updated_at + - created_at + - service_tokens + - updated_at SemanticLayerCredentialsEnveloped: type: object properties: data: - $ref: '#/components/schemas/SemanticLayerCredentials' + $ref: "#/components/schemas/SemanticLayerCredentials" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ServiceToken: type: object properties: @@ -5382,7 +7282,7 @@ components: user_id: type: integer type: - type: string + type: integer expires_at: type: string format: date-time @@ -5395,26 +7295,41 @@ components: service_token_permissions: type: array items: - $ref: '#/components/schemas/ServiceTokenPermission' + $ref: "#/components/schemas/ServiceTokenPermission" readOnly: true default: [] required: - - created_at - - service_token_permissions - - token_string - - updated_at + - created_at + - service_token_permissions + - token_string + - updated_at ServiceTokenEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/ServiceToken' + $ref: "#/components/schemas/ServiceToken" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" + required: + - data + - status + ServiceTokenLite: + type: object + properties: + id: + type: integer + account_id: + type: integer + uid: + type: string + name: + type: string required: - - data - - status + - account_id + - name + - uid ServiceTokenPermission: type: object properties: @@ -5427,34 +7342,35 @@ components: all_projects: type: boolean permission_set: - $ref: '#/components/schemas/PermissionSetEnum' + $ref: "#/components/schemas/PermissionSetEnum" state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted writable_environment_categories: type: array items: type: string required: - - account_id - - all_projects - - permission_set - - service_token_id - - writable_environment_categories + - account_id + - all_projects + - permission_set + - service_token_id + - writable_environment_categories ServiceTokenPermissionEnveloped: type: object properties: data: type: array items: - $ref: '#/components/schemas/ServiceTokenPermission' + $ref: "#/components/schemas/ServiceTokenPermission" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status ServiceTokenRequestRequest: type: object properties: @@ -5466,9 +7382,57 @@ components: webhooks_only: type: boolean required: - - metadata_only - - name - - webhooks_only + - metadata_only + - name + - webhooks_only + SnowflakeConnection: + title: SnowflakeConnection + type: object + properties: + account: + title: Account + maxLength: 255 + minLength: 1 + type: string + database: + title: Database + maxLength: 255 + minLength: 1 + type: string + warehouse: + title: Warehouse + maxLength: 255 + minLength: 1 + type: string + client_session_keep_alive: + title: Client Session Keep Alive + default: false + type: boolean + role: + title: Role + maxLength: 255 + minLength: 1 + type: string + allow_sso: + title: Allow Sso + default: false + type: boolean + oauth_client_id: + title: Oauth Client Id + write_only: true + type: string + writeOnly: true + format: password + oauth_client_secret: + title: Oauth Client Secret + write_only: true + type: string + writeOnly: true + format: password + required: + - account + - database + - warehouse Status: type: object properties: @@ -5482,9 +7446,9 @@ components: developer_message: type: string required: - - developer_message - - is_success - - user_message + - developer_message + - is_success + - user_message Subscription: type: object properties: @@ -5504,7 +7468,8 @@ components: type: array items: type: integer - description: Job IDs that trigger this webhook. Leave empty to trigger for + description: + Job IDs that trigger this webhook. Leave empty to trigger for all jobs. client_url: type: string @@ -5514,7 +7479,8 @@ components: description: Whether or not this Webhook is currently active http_status_code: type: string - description: The latest HTTP status code received from the client URL. 0 + description: + The latest HTTP status code received from the client URL. 0 indicates that the webhook has not been dispatched. dispatched_at: type: string @@ -5527,10 +7493,10 @@ components: account_identifier: type: string required: - - active - - client_url - - event_types - - name + - active + - client_url + - event_types + - name SubscriptionRequest: type: object properties: @@ -5553,7 +7519,8 @@ components: type: array items: type: integer - description: Job IDs that trigger this webhook. Leave empty to trigger for + description: + Job IDs that trigger this webhook. Leave empty to trigger for all jobs. client_url: type: string @@ -5565,7 +7532,8 @@ components: http_status_code: type: string minLength: 1 - description: The latest HTTP status code received from the client URL. 0 + description: + The latest HTTP status code received from the client URL. 0 indicates that the webhook has not been dispatched. dispatched_at: type: string @@ -5581,20 +7549,85 @@ components: type: string minLength: 1 required: - - active - - client_url - - event_types - - name + - active + - client_url + - event_types + - name SubscriptionResponseEnvelope: type: object properties: data: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" status: - $ref: '#/components/schemas/ResponseStatus' + $ref: "#/components/schemas/ResponseStatus" + required: + - data + - status + SynapseConnection: + title: SynapseConnection + type: object + properties: + host: + title: Host + type: string + database: + title: Database + type: string + driver: + title: Driver + default: ODBC Driver 18 for SQL Server + type: string + port: + title: Port + default: 1433 + exclusiveMinimum: 0 + maximum: 65535 + type: integer + retries: + title: Retries + default: 1 + type: integer + login_timeout: + title: Login Timeout + default: 0 + type: integer + query_timeout: + title: Query Timeout + default: 0 + type: integer + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer required: - - data - - status + - host + - database + TableauIntegration: + title: TableauIntegration + type: object + properties: + host: + title: Host + maxLength: 255 + type: string + site_id: + title: Site Id + maxLength: 255 + type: string + token_name: + title: Token Name + maxLength: 255 + type: string + token: + title: Token + write_only: true + type: string + writeOnly: true + format: password + required: + - host + - site_id + - token_name TestSubscriptionResponseData: type: object properties: @@ -5606,27 +7639,42 @@ components: type: object properties: data: - $ref: '#/components/schemas/TestSubscriptionResponseData' + $ref: "#/components/schemas/TestSubscriptionResponseData" status: - $ref: '#/components/schemas/ResponseStatus' + $ref: "#/components/schemas/ResponseStatus" required: - - data - - status - TimeEnum: - enum: - - every_hour - - at_exact_hours - type: string - description: |- - * `every_hour` - every_hour - * `at_exact_hours` - at_exact_hours + - data + - status + TrinoConnection: + title: TrinoConnection + type: object + properties: + host: + title: Host + type: string + method: + title: Method + default: ldap + type: string + port: + title: Port + default: 443 + exclusiveMinimum: 0 + maximum: 65535 + type: integer + adapter_id: + title: Adapter Id + description: Deprecated, use connection_details.adapter_version + type: integer + required: + - host Type32eEnum: enum: - - postgres - - redshift - - snowflake - - bigquery - - adapter + - postgres + - redshift + - snowflake + - bigquery + - adapter type: string description: |- * `postgres` - postgres @@ -5634,12 +7682,22 @@ components: * `snowflake` - snowflake * `bigquery` - bigquery * `adapter` - adapter + TypeEdaEnum: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - ALLOW + * `2` - DENY UpdateIPRestrictionRequestRequest: type: object properties: name: type: string minLength: 1 + type: + $ref: "#/components/schemas/TypeEdaEnum" rule_set_enabled: type: boolean account_id: @@ -5647,168 +7705,29 @@ components: cidrs: type: array items: - $ref: '#/components/schemas/IPRestrictionCidrRequestRequest' + $ref: "#/components/schemas/IPRestrictionCidrRequestRequest" description: type: string minLength: 1 id: type: integer required: - - account_id - - cidrs - - id - - name - - rule_set_enabled + - account_id + - cidrs + - id + - name + - rule_set_enabled + - type UpdateSubscriptionResponseEnvelope: type: object properties: data: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" status: - $ref: '#/components/schemas/ResponseStatus' - required: - - data - - status - User: - type: object + $ref: "#/components/schemas/ResponseStatus" required: - - id - - first_name - - last_name - - email - - is_staff - - github_connected - - github_username - - gitlab_connected - - gitlab_username - - azure_active_directory_connected - - azure_active_directory_username - - email_connected - - email_verified - - enterprise_connected - properties: - id: - oneOf: - - type: 'null' - - type: integer - auth0_user_id: - oneOf: - - type: 'null' - - type: string - auth0_database_user_id: - type: string - first_name: - type: string - last_name: - type: string - email: - type: string - is_staff: - type: boolean - is_active: - type: boolean - created_at: - type: string - format: date-time - readOnly: true - last_login: - oneOf: - - type: 'null' - - type: string - format: date-time - github_connected: - oneOf: - - type: 'null' - - type: boolean - github_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - github_access_token: - oneOf: - - type: 'null' - - type: string - github_username: - oneOf: - - type: 'null' - - type: string - gitlab_connected: - oneOf: - - type: 'null' - - type: boolean - gitlab_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - gitlab_access_token: - oneOf: - - type: 'null' - - type: string - gitlab_username: - oneOf: - - type: 'null' - - type: string - azure_active_directory_connected: - oneOf: - - type: 'null' - - type: boolean - azure_active_directory_access_token: - oneOf: - - type: 'null' - - type: string - azure_active_directory_username: - oneOf: - - type: 'null' - - type: string - azure_active_directory_token_retrieval_failure: - oneOf: - - type: 'null' - - type: boolean - email_connected: - oneOf: - - type: 'null' - - type: boolean - email_verified: - type: boolean - enterprise_connected: - oneOf: - - type: 'null' - - type: boolean - enterprise_authentication_method: - oneOf: - - type: 'null' - - type: string - enterprise_idp_attributes: - oneOf: - - type: 'null' - - {} - auth_provider_infos: - oneOf: - - type: 'null' - - {} - api_key: - type: string - password: - allOf: - - minLength: 9 - - type: string - confirm_password: - type: string - permissions: {} - licenses: {} - user_feature_flags: {} - apitoken_last_used: - oneOf: - - type: 'null' - - type: string - format: date-time - sso_only_user: - oneOf: - - type: 'null' - - type: boolean - additionalProperties: false - definitions: {} - $schema: http://json-schema.org/draft-07/schema# + - data + - status UserCredentials: type: object properties: @@ -5839,27 +7758,27 @@ components: readOnly: true credentials: allOf: - - $ref: '#/components/schemas/PostgresCredentials' + - $ref: "#/components/schemas/PostgresCredentials" readOnly: true project: allOf: - - $ref: '#/components/schemas/Project' + - $ref: "#/components/schemas/Project" readOnly: true required: - - created_at - - credentials - - project - - updated_at + - created_at + - credentials + - project + - updated_at UserCredentialsEnveloped: type: object properties: data: - $ref: '#/components/schemas/UserCredentials' + $ref: "#/components/schemas/UserCredentials" status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" required: - - data - - status + - data + - status UserCredentialsRequest: type: object properties: @@ -5880,41 +7799,64 @@ components: state: type: integer default: 1 - description: A value of 1 means this entity is active and a value of 2 means + description: + A value of 1 means this entity is active and a value of 2 means this entity is deleted required: - - account_id - - credentials_id - - project_id - - user_id + - account_id + - credentials_id + - project_id + - user_id UserEnveloped: type: object properties: - data: - type: array - items: - $ref: '#/components/schemas/User' status: - $ref: '#/components/schemas/Status' + $ref: "#/components/schemas/Status" + required: + - status + WatchSelectionItem: + title: WatchSelectionItem + type: object + properties: + identifier: + title: Identifier + type: string + name: + title: Name + type: string + type: + $ref: "#/components/schemas/WatchSelectionType" + watching: + title: Watching + type: boolean required: - - data - - status + - identifier + - name + - type + WatchSelectionType: + title: WatchSelectionType + description: An enumeration. + enum: + - folder + - dashboard + type: string securitySchemes: BearerAuthentication: type: http scheme: bearer bearerFormat: Bearer servers: -- url: https://cloud.getdbt.com/ - description: Production (US) -- url: https://{account_prefix}.us1.dbt.com/ - description: Production (US) - variables: - account_prefix: - default: ab123 - description: Your unique account prefix. Can be found on your account settings - page. -- url: https://emea.dbt.com/ - description: Production (Europe) -- url: https://au.dbt.com/ - description: Production (AU) + - url: https://cloud.getdbt.com/ + description: Production (US) + - url: https://{account_prefix}.us1.dbt.com/ + description: Production (US) + variables: + account_prefix: + default: ab123 + description: + Your unique account prefix. Can be found on your account settings + page. + - url: https://emea.dbt.com/ + description: Production (Europe) + - url: https://au.dbt.com/ + description: Production (AU)