openapi: 3.0.1
info:
title: dbt Cloud Administrative Accounts Run Artifacts API
description: The dbt Cloud Administrative API enables programmatic administration of a dbt Cloud account. Use it to list and trigger jobs, poll and cancel runs, download run artifacts, and manage accounts, projects, and environments. This document models the documented v2 REST surface served from https://cloud.getdbt.com/api/v2. Requests are authenticated with a Bearer service token or personal access token. dbt Labs also offers a v3 REST API for additional resource management, a GraphQL Discovery (Metadata) API at metadata.cloud.getdbt.com/graphql, and a Semantic Layer API (GraphQL and JDBC).
termsOfService: https://www.getdbt.com/cloud/terms
contact:
name: dbt Labs Support
url: https://docs.getdbt.com/docs/dbt-cloud-apis/overview
version: '2'
servers:
- url: https://cloud.getdbt.com/api/v2
description: dbt Cloud Administrative API v2 (multi-tenant North America). Account-specific regions use cloud.getdbt.com, emea.dbt.com, au.dbt.com, or a single-tenant host.
security:
- BearerAuthentication: []
tags:
- name: Run Artifacts
description: Artifacts (manifest, catalog, run results) produced by runs.
paths:
/accounts/{account_id}/runs/{run_id}/artifacts/:
get:
operationId: listRunArtifacts
tags:
- Run Artifacts
summary: List artifact files generated by a completed run.
parameters:
- $ref: '#/components/parameters/AccountId'
- name: run_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArtifactListResponse'
/accounts/{account_id}/runs/{run_id}/artifacts/{path}:
get:
operationId: retrieveRunArtifact
tags:
- Run Artifacts
summary: Download a specific artifact file (e.g. manifest.json, catalog.json) from a run.
parameters:
- $ref: '#/components/parameters/AccountId'
- name: run_id
in: path
required: true
schema:
type: integer
- name: path
in: path
required: true
schema:
type: string
description: Relative artifact path, e.g. manifest.json or run_results.json.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
components:
schemas:
ArtifactListResponse:
type: object
properties:
status:
$ref: '#/components/schemas/StatusMeta'
data:
type: array
items:
type: string
description: Relative paths of artifact files available for download.
StatusMeta:
type: object
properties:
code:
type: integer
is_success:
type: boolean
user_message:
type: string
developer_message:
type: string
parameters:
AccountId:
name: account_id
in: path
required: true
schema:
type: integer
description: Numeric dbt Cloud account ID.
securitySchemes:
BearerAuthentication:
type: http
scheme: bearer
description: 'dbt Cloud service token or personal access token passed in the Authorization header as ''Authorization: Token <token>'' or ''Authorization: Bearer <token>''.'