Create a Deploy - Astronomer

POST

organizations

{organizationId}

deployments

{deploymentId}

deploys

Create a Deploy

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/deploys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "IMAGE_AND_DAG",
  "bundleMountPath": "<string>",
  "bundleName": "finance",
  "bundleType": "dbt",
  "description": "My deploy description"
}
'

import requests

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

payload = {
    "type": "IMAGE_AND_DAG",
    "bundleMountPath": "<string>",
    "bundleName": "finance",
    "bundleType": "dbt",
    "description": "My deploy description"
}
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: 'IMAGE_AND_DAG',
    bundleMountPath: '<string>',
    bundleName: 'finance',
    bundleType: 'dbt',
    description: 'My deploy description'
  })
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/deploys', 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}/deploys",
  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' => 'IMAGE_AND_DAG',
    'bundleMountPath' => '<string>',
    'bundleName' => 'finance',
    'bundleType' => 'dbt',
    'description' => 'My deploy description'
  ]),
  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}/deploys"

	payload := strings.NewReader("{\n  \"type\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\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}/deploys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\n}"

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

{
  "createdAt": "2022-11-22T04:37:12Z",
  "deploymentId": "clmh57jtm000008lb58fe2wmv",
  "id": "clvetru2w000201mowqwua63n",
  "imageRepository": "https://my-image-repository",
  "imageTag": "my-image-tag",
  "isDagDeployEnabled": true,
  "status": "DEPLOYED",
  "type": "IMAGE_AND_DAG",
  "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
  "astroRuntimeVersion": "9.1.0",
  "bundleId": "clvetru2w000201mowqwua63n",
  "bundleMountPath": "<string>",
  "bundleUploadUrl": "<string>",
  "bundles": [
    {
      "bundleType": "<string>",
      "deployId": "<string>",
      "isDagBundle": true,
      "mountPath": "<string>",
      "type": "DEPLOY",
      "currentVersion": "<string>",
      "desiredVersion": "<string>",
      "name": "finance"
    }
  ],
  "createdBySubject": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
  "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv",
  "description": "My deploy description",
  "git": {
    "commitSha": "abc123def456",
    "provider": "GITHUB",
    "account": "astronomer",
    "authorName": "Astronomer Bot",
    "authorUrl": "https://github.com/astronomer-bot",
    "authorUsername": "astronomer-bot",
    "beforeCommitSha": "def456abc123",
    "branch": "main",
    "commitUrl": "https://github.com/astronomer/astro-cli/commit/abc123def456",
    "path": "dags/",
    "remoteUrl": "git@gitlab.com:team/project.git",
    "repo": "astro-cli"
  },
  "rollbackFromId": "clvcz1lrq000101oitxtp276e",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBySubject": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

{
  "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 in which to create the Deployment.

deploymentId

string

required

The Deployment's ID.

Body

application/json

The Request body for creating a Deploy.

type

enum<string>

required

The type of deploy.

Available options:

IMAGE_AND_DAG,

IMAGE_ONLY,

DAG_ONLY,

BUNDLE

Example:

"IMAGE_AND_DAG"

bundleMountPath

string

The path where Astro mounts the bundle on the Airflow component pods. Required if deploy type is BUNDLE.

bundleName

string

The name of the Dag bundle to deploy. Only valid if deploy type is IMAGE_AND_DAG or DAG_ONLY. Defaults to the Deployment's default Dag bundle.

Maximum string length: 32

Example:

"finance"

bundleType

string

The type of bundle deployed. Required if deploy type is BUNDLE.

Example:

"dbt"

description

string

The deploy's description.

Maximum string length: 500

Example:

"My deploy description"

git

object

Show child attributes

Response

createdAt

string<date-time>

required

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

Example:

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

deploymentId

string

required

The Deployment's ID.

Example:

"clmh57jtm000008lb58fe2wmv"

string

required

The deploy's ID.

Example:

"clvetru2w000201mowqwua63n"

imageRepository

string

required

The URL of the deploy's image repository.

Example:

"https://my-image-repository"

imageTag

string

required

The deploy's image tag. Appears only if specified in the most recent deploy.

Example:

"my-image-tag"

isDagDeployEnabled

boolean

required

Whether the deploy was triggered on a Deployment with Dag deploys enabled.

Example:

true

status

enum<string>

required

The status of the deploy.

Available options:

INITIALIZED,

DEPLOYED,

FAILED

Example:

"DEPLOYED"

type

enum<string>

required

The type of deploy.

Available options:

IMAGE_AND_DAG,

IMAGE_ONLY,

DAG_ONLY,

BUNDLE,

BASE_IMAGE

Example:

"IMAGE_AND_DAG"

airflowVersion

string

The deploy's Airflow version.

Example:

"2.7.2, if airflow version is not found, it will return NA"

astroRuntimeVersion

string

The deploy's Astro Runtime version.

Example:

"9.1.0"

bundleId

string

The ID of the Dag bundle that the deploy updates. Appears only for Dag deploys.

Example:

"clvetru2w000201mowqwua63n"

bundleMountPath

string

The path where Astro mounts the bundle on the Airflow component pods.

bundleUploadUrl

string

The URL where the deploy uploads the bundle. Appears only if Dag deploys are enabled on the Deployment and deploy type is BUNDLE.

bundles

object[]

The bundles included in a specific Deployment.

Show child attributes

createdBySubject

object

Show child attributes

dagTarballVersion

string

The deploy's Dag tarball version, also known as the Bundle Version in the Astro UI.

Example:

"2024-01-12T18:32:20.5898930Z"

dagsUploadUrl

string

The deploy's upload URL to upload Dag bundles. Appears only if dag deploys are enabled on the Deployment.

Example:

"https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv"

description

string

The deploy's description.

Example:

"My deploy description"

git

object

Show child attributes

rollbackFromId

string

The ID of the deploy that you completed a rollback on. Appears only if a rollback has been performed.

Example:

"clvcz1lrq000101oitxtp276e"

updatedAt

string<date-time>

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

Example:

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

updatedBySubject

object

Show child attributes

⌘I

Create a Deploy

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/deploys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "IMAGE_AND_DAG",
  "bundleMountPath": "<string>",
  "bundleName": "finance",
  "bundleType": "dbt",
  "description": "My deploy description"
}
'

import requests

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

payload = {
    "type": "IMAGE_AND_DAG",
    "bundleMountPath": "<string>",
    "bundleName": "finance",
    "bundleType": "dbt",
    "description": "My deploy description"
}
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: 'IMAGE_AND_DAG',
    bundleMountPath: '<string>',
    bundleName: 'finance',
    bundleType: 'dbt',
    description: 'My deploy description'
  })
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/deploys', 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}/deploys",
  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' => 'IMAGE_AND_DAG',
    'bundleMountPath' => '<string>',
    'bundleName' => 'finance',
    'bundleType' => 'dbt',
    'description' => 'My deploy description'
  ]),
  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}/deploys"

	payload := strings.NewReader("{\n  \"type\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\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}/deploys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"IMAGE_AND_DAG\",\n  \"bundleMountPath\": \"<string>\",\n  \"bundleName\": \"finance\",\n  \"bundleType\": \"dbt\",\n  \"description\": \"My deploy description\"\n}"

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

{
  "createdAt": "2022-11-22T04:37:12Z",
  "deploymentId": "clmh57jtm000008lb58fe2wmv",
  "id": "clvetru2w000201mowqwua63n",
  "imageRepository": "https://my-image-repository",
  "imageTag": "my-image-tag",
  "isDagDeployEnabled": true,
  "status": "DEPLOYED",
  "type": "IMAGE_AND_DAG",
  "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
  "astroRuntimeVersion": "9.1.0",
  "bundleId": "clvetru2w000201mowqwua63n",
  "bundleMountPath": "<string>",
  "bundleUploadUrl": "<string>",
  "bundles": [
    {
      "bundleType": "<string>",
      "deployId": "<string>",
      "isDagBundle": true,
      "mountPath": "<string>",
      "type": "DEPLOY",
      "currentVersion": "<string>",
      "desiredVersion": "<string>",
      "name": "finance"
    }
  ],
  "createdBySubject": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
  "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv",
  "description": "My deploy description",
  "git": {
    "commitSha": "abc123def456",
    "provider": "GITHUB",
    "account": "astronomer",
    "authorName": "Astronomer Bot",
    "authorUrl": "https://github.com/astronomer-bot",
    "authorUsername": "astronomer-bot",
    "beforeCommitSha": "def456abc123",
    "branch": "main",
    "commitUrl": "https://github.com/astronomer/astro-cli/commit/abc123def456",
    "path": "dags/",
    "remoteUrl": "git@gitlab.com:team/project.git",
    "repo": "astro-cli"
  },
  "rollbackFromId": "clvcz1lrq000101oitxtp276e",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBySubject": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

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