GEgetdbt
Environments

GET /api/v3/accounts/{account_id}/projects/{project_id}/environments/

Changed on

List Environments

Request

  • Base URL
    https://cloud.getdbt.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required
project_idinteger required

Query parameters

credentials_idinteger
dbt_versionstring
dbt_version__instring[]
deployment_type'production' | 'staging'
deployment_type__instring[]
id__gtinteger
include_relatedstring

Comma-separated list of related objects to include in the response. Available: project, connection, credentials, repository.

limitinteger
namestring
name__icontainsstring
offsetinteger
order_bystring

Field to order results by. Prefix with '-' for descending order.

pkinteger
pk__ininteger[]
project_id__ininteger[]
integer
OR
'active' | 'deleted' | 'all'

Filters by soft deletion state. <ul> <li> <strong>"active"</strong> / <strong>1</strong>: Only active resources </li> <li> <strong>"deleted"</strong> / <strong>2</strong>: Only deleted resources </li> <li> <strong>"all"</strong>: All resources </li> </ul>

typestring

Response

Example response

{
  "data": [
    {
      "state": 1,
      "project": {
        "state": 1
      },
      "credentials": {
        "state": 1
      }
    }
  ]
}

Changes

  • v3e32fbfcdc9ecRevision changes
    • info

      added the optional property // to the response with the status

  • v37d5c1b4c8d8aRevision changes
    • breaking

      for the query request parameter pk__in, the format of property items/ was specialized from no format to int64

    • breaking

      for the query request parameter project_id__in, the format of property items/ was specialized from no format to int64

    • breaking

      for the path request parameter account_id, the format changed from no format to int64

    • breaking

      for the path request parameter project_id, the format changed from no format to int64

    • breaking

      for the query request parameter credentials_id, the format changed from no format to int64

    • breaking

      for the query request parameter id__gt, the format changed from no format to int64

    • breaking

      for the query request parameter pk, the format changed from no format to int64