List bundles - Astronomer

GET

organizations

{organizationId}

deployments

{deploymentId}

bundles

Error

A valid request URL is required to generate request examples

{
  "bundles": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "deletionIsPending": true,
      "id": "clvetru2w000201mowqwua63n",
      "isDagBundle": true,
      "isDefault": true,
      "type": "DEPLOY",
      "updatedAt": "2022-11-22T04:37:12Z",
      "currentVersion": "<string>",
      "dagBundleIds": [
        "<string>"
      ],
      "description": "Finance team Dags",
      "desiredVersion": "<string>",
      "lastDeployId": "clvetru2w000201mowqwua63n",
      "name": "finance",
      "nonDagBundleType": "dbt",
      "nonDagMountPath": "/usr/local/airflow/dbt"
    }
  ],
  "limit": 123,
  "offset": 123,
  "totalCount": 123
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

The ID of the Organization to which the Deployment belongs.

deploymentId

string

required

The Deployment's ID.

Query Parameters

isDagBundle

boolean

If true, list only Dag bundles. If false, list only non-Dag bundles.

offset

integer

default:0

The number of results to skip before returning values.

Required range: x >= 0

limit

integer

default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000

Response

bundles

object[]

required

A list of bundles in the current page.

Show child attributes

limit

integer

required

The maximum number of bundles in one page.

offset

integer

required

The offset of the current page of bundles.

totalCount

integer

required

The total number of bundles.

⌘I

Error

A valid request URL is required to generate request examples

{
  "bundles": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "deletionIsPending": true,
      "id": "clvetru2w000201mowqwua63n",
      "isDagBundle": true,
      "isDefault": true,
      "type": "DEPLOY",
      "updatedAt": "2022-11-22T04:37:12Z",
      "currentVersion": "<string>",
      "dagBundleIds": [
        "<string>"
      ],
      "description": "Finance team Dags",
      "desiredVersion": "<string>",
      "lastDeployId": "clvetru2w000201mowqwua63n",
      "name": "finance",
      "nonDagBundleType": "dbt",
      "nonDagMountPath": "/usr/local/airflow/dbt"
    }
  ],
  "limit": 123,
  "offset": 123,
  "totalCount": 123
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}