Create a bundle

Create a Dag or non-Dag bundle on a Deployment. Set isDagBundle to true with a name to create a Dag bundle, or to false with a nonDagMountPath to create a non-Dag bundle. A non-Dag bundle is served alongside the Dag bundles in dagBundleIds, which defaults to the Deployment’s default Dag bundle. The bundle has no version until its first deploy. The Deployment must have Dag deploys enabled, and creating a Dag bundle requires Airflow 3.

POST

organizations

{organizationId}

deployments

{deploymentId}

bundles

Create a bundle

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "DEPLOY",
  "dagBundleIds": [
    "<string>"
  ],
  "description": "Finance team Dags",
  "isDagBundle": true,
  "name": "finance",
  "nonDagBundleType": "dbt",
  "nonDagMountPath": "/usr/local/airflow/dbt"
}
'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles"

payload = {
    "type": "DEPLOY",
    "dagBundleIds": ["<string>"],
    "description": "Finance team Dags",
    "isDagBundle": True,
    "name": "finance",
    "nonDagBundleType": "dbt",
    "nonDagMountPath": "/usr/local/airflow/dbt"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'DEPLOY',
    dagBundleIds: ['<string>'],
    description: 'Finance team Dags',
    isDagBundle: true,
    name: 'finance',
    nonDagBundleType: 'dbt',
    nonDagMountPath: '/usr/local/airflow/dbt'
  })
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'DEPLOY',
    'dagBundleIds' => [
        '<string>'
    ],
    'description' => 'Finance team Dags',
    'isDagBundle' => true,
    'name' => 'finance',
    'nonDagBundleType' => 'dbt',
    'nonDagMountPath' => '/usr/local/airflow/dbt'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles"

	payload := strings.NewReader("{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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.

Body

application/json

The request body for creating a bundle.

type

enum<string>

required

The bundle's type. DEPLOY for a bundle written by a deploy.

Available options:

DEPLOY

Example:

"DEPLOY"

dagBundleIds

string[]

The IDs of the Dag bundles that Astro serves the bundle alongside. Only valid for non-Dag bundles. Defaults to the Deployment's default Dag bundle.

Required array length: 1 - 1000 elements

description

string

The bundle's description.

Maximum string length: 500

Example:

"Finance team Dags"

isDagBundle

boolean

Whether to create a Dag bundle, which requires name, or a non-Dag bundle, which requires nonDagMountPath.

name

string

The bundle's name. Required for, and only valid for, Dag bundles. Lowercase letters, numbers, dashes, and underscores; may not be main.

Maximum string length: 32

Example:

"finance"

nonDagBundleType

string

The kind of files the bundle contains. Only valid for non-Dag bundles.

Maximum string length: 64

Example:

"dbt"

nonDagMountPath

string

The absolute path where Astro mounts the bundle on the Airflow component pods. Required for, and only valid for, non-Dag bundles.

Maximum string length: 256

Example:

"/usr/local/airflow/dbt"

Response

createdAt

string<date-time>

required

The time when the bundle was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

deletionIsPending

boolean

required

Whether the bundle has been deleted but is still on the Deployment.

string

required

The bundle's ID.

Example:

"clvetru2w000201mowqwua63n"

isDagBundle

boolean

required

Whether the bundle contains Dags. A non-Dag bundle contains other files, such as a dbt project.

isDefault

boolean

required

Whether the bundle is the Deployment's default Dag bundle.

type

enum<string>

required

The bundle's type. DEPLOY for a bundle written by a deploy.

Available options:

DEPLOY

Example:

"DEPLOY"

updatedAt

string<date-time>

required

The time when the bundle was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

currentVersion

string

The bundle version most recently reported as running on the Deployment.

dagBundleIds

string[]

The IDs of the Dag bundles that Astro serves the bundle alongside. Appears only for non-Dag bundles.

description

string

The bundle's description.

Example:

"Finance team Dags"

desiredVersion

string

The bundle version the Deployment is configured to run.

lastDeployId

string

The ID of the deploy that last changed the bundle. Appears only after the bundle's first deploy.

Example:

"clvetru2w000201mowqwua63n"

name

string

The bundle's name. Appears only for Dag bundles.

Example:

"finance"

nonDagBundleType

string

The kind of files the bundle contains. Appears only for non-Dag bundles.

Example:

"dbt"

nonDagMountPath

string

The path where Astro mounts the bundle on the Airflow component pods. Appears only for non-Dag bundles.

Example:

"/usr/local/airflow/dbt"

⌘I

Create a bundle

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "DEPLOY",
  "dagBundleIds": [
    "<string>"
  ],
  "description": "Finance team Dags",
  "isDagBundle": true,
  "name": "finance",
  "nonDagBundleType": "dbt",
  "nonDagMountPath": "/usr/local/airflow/dbt"
}
'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles"

payload = {
    "type": "DEPLOY",
    "dagBundleIds": ["<string>"],
    "description": "Finance team Dags",
    "isDagBundle": True,
    "name": "finance",
    "nonDagBundleType": "dbt",
    "nonDagMountPath": "/usr/local/airflow/dbt"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'DEPLOY',
    dagBundleIds: ['<string>'],
    description: 'Finance team Dags',
    isDagBundle: true,
    name: 'finance',
    nonDagBundleType: 'dbt',
    nonDagMountPath: '/usr/local/airflow/dbt'
  })
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'DEPLOY',
    'dagBundleIds' => [
        '<string>'
    ],
    'description' => 'Finance team Dags',
    'isDagBundle' => true,
    'name' => 'finance',
    'nonDagBundleType' => 'dbt',
    'nonDagMountPath' => '/usr/local/airflow/dbt'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles"

	payload := strings.NewReader("{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/bundles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"DEPLOY\",\n  \"dagBundleIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"Finance team Dags\",\n  \"isDagBundle\": true,\n  \"name\": \"finance\",\n  \"nonDagBundleType\": \"dbt\",\n  \"nonDagMountPath\": \"/usr/local/airflow/dbt\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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>"
    }
  ]
}