Create a Deployment

POST

https://api.astronomer.io/v1/organizations/:organizationId/deployments

POST

/v1/organizations/:organizationId/deployments

$ curl -X POST https://api.astronomer.io/v1/organizations/organizationId/deployments \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "My deployment",
>   "workspaceId": "clmh8ol3x000008jo656y4285"
> }'

1 {
2   "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
3   "apiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed/api/v1",
4   "astroRuntimeVersion": "9.1.0",
5   "createdAt": "2022-11-22T04:37:12Z",
6   "createdBy": {
7     "id": "clm8qv74h000008mlf08scq7k",
8     "apiTokenName": "my-token",
9     "avatarUrl": "https://avatar.url",
10     "fullName": "Jane Doe",
11     "subjectType": "USER",
12     "username": "user1@company.com"
13   },
14   "id": "clmh57jtm000008lb58fe2wmv",
15   "imageRepository": "https://my-image-repository",
16   "imageTag": "my-image-tag",
17   "isCicdEnforced": true,
18   "isDagDeployEnabled": true,
19   "name": "My deployment",
20   "namespace": "weightless-diameter-8927",
21   "organizationId": "clmh59gt0000308lbgswe5fvh",
22   "runtimeVersion": "9.1.0",
23   "schedulerCpu": "1",
24   "schedulerMemory": "1Gi",
25   "schedulerReplicas": 1,
26   "status": "HEALTHY",
27   "uiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed?orgId=org_bvqayGttQauxdxB2",
28   "updatedAt": "2022-11-22T04:37:12Z",
29   "updatedBy": {
30     "id": "clm8qv74h000008mlf08scq7k",
31     "apiTokenName": "my-token",
32     "avatarUrl": "https://avatar.url",
33     "fullName": "Jane Doe",
34     "subjectType": "USER",
35     "username": "user1@company.com"
36   },
37   "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
38   "webServerCpu": "0.5",
39   "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
40   "webServerMemory": "0.5Gi",
41   "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
42   "workspaceId": "clmh58o7d000108lb74ktc9o64",
43   "cloudProvider": "AZURE",
44   "clusterId": "clmh597sg000208lb2kjhcn8q",
45   "clusterName": "my cluster",
46   "contactEmails": [
47     "user1@company.com"
48   ],
49   "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
50   "defaultTaskPodCpu": "0.5",
51   "defaultTaskPodMemory": "1Gi",
52   "description": "My deployment description",
53   "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z",
54   "drExternalIPs": [
55     "string"
56   ],
57   "drOidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
58   "effectiveDRWorkloadIdentity": "string",
59   "effectiveWorkloadIdentity": "string",
60   "environmentVariables": [
61     {
62       "isSecret": true,
63       "key": "my-var",
64       "updatedAt": "2022-11-22T04:37:12Z",
65       "value": "my-var-value"
66     }
67   ],
68   "executor": "CELERY",
69   "externalIPs": [
70     "0.0.0.0"
71   ],
72   "imageVersion": "deploy-2023-09-14T19-04",
73   "isDevelopmentMode": true,
74   "isHighAvailability": true,
75   "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
76   "region": "us-east-1",
77   "remoteExecution": {
78     "allowedIpAddressRanges": [
79       "string"
80     ],
81     "enabled": true,
82     "remoteApiUrl": "string",
83     "taskLogBucket": "string",
84     "taskLogUrlPattern": "string"
85   },
86   "resourceQuotaCpu": "160",
87   "resourceQuotaMemory": "320Gi",
88   "scalingSpec": {
89     "hibernationSpec": {
90       "override": {
91         "isActive": true,
92         "isHibernating": true,
93         "overrideUntil": "2024-01-15T09:30:00Z"
94       },
95       "schedules": [
96         {
97           "hibernateAtCron": "string",
98           "isEnabled": true,
99           "wakeAtCron": "string",
100           "description": "string"
101         }
102       ]
103     }
104   },
105   "scalingStatus": {
106     "hibernationStatus": {
107       "isHibernating": true,
108       "nextEventAt": "string",
109       "nextEventType": "HIBERNATE",
110       "reason": "string"
111     }
112   },
113   "schedulerAu": 5,
114   "schedulerSize": "MEDIUM",
115   "statusReason": "Successfully Deployed",
116   "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
117   "type": "DEDICATED",
118   "webServerReplicas": 1,
119   "workerQueues": [
120     {
121       "id": "clmh9vsuf000908midngba9mw",
122       "isDefault": true,
123       "maxWorkerCount": 10,
124       "minWorkerCount": 1,
125       "name": "default",
126       "podCpu": "1",
127       "podMemory": "2Gi",
128       "workerConcurrency": 20,
129       "astroMachine": "A5",
130       "nodePoolId": "clmh9yjcn000a08mi8dsgbno9"
131     }
132   ],
133   "workspaceName": "my-workspace"
134 }

Create a Deployment in the Organization. An Astro Deployment is an Airflow environment that is powered by all core Airflow components.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization in which to create the Deployment.

Request

The request body for creating a Deployment.

DEDICATEDobjectRequired

HYBRIDobjectRequired

STANDARDobjectRequired

Response

airflowVersionstring

The Deployment's Airflow version.

apiUrlstring

The base URL to directly access the Airflow API.

astroRuntimeVersionstring

The Deployment's Astro Runtime version.

createdAtstringformat: "date-time"

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

createdByobject

idstring

The Deployment's ID.

imageRepositorystring

The URL of the Deployment's image repository.

imageTagstring

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

isCicdEnforcedboolean

Whether the Deployment requires that all deploys are made through CI/CD.

isDagDeployEnabledboolean

Whether the Deployment has DAG deploys enabled.

namestring

The Deployment's name.

namespacestring

The Deployment's namespace name in the Kubernetes cluster.

organizationIdstring

The ID of the Organization to which the Deployment belongs.

runtimeVersionstring

Deprecated: runtimeVersion has been replaced with astroRuntimeVersion

schedulerCpustring

The CPU limit for the Deployment's scheduler. Specified in number of CPU cores.

schedulerMemorystring

The memory limit for the Deployment’s scheduler. Units in Gibibytes or Gi.

schedulerReplicasinteger

The number of schedulers to use in the Deployment.

statusenum

The status of the Deployment.

uiUrlstring

The URL to access the Airflow UI.

updatedAtstringformat: "date-time"

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

updatedByobject

webServerAirflowApiUrlstring

The Deployment's webserver's base url to directly access the Airflow api.

webServerCpustring

The CPU limit for the Deployment's webserver. Units are in number of CPU cores.

webServerIngressHostnamestring

The Deployment's webserver's ingress hostname.

webServerMemorystring

The memory limit for the Deployment’s webserver. Units in Gibibytes or Gi.

webServerUrlstring

The Deployment's webserver's url.

workspaceIdstring

The ID of the Workspace to which the Deployment belongs.

cloudProviderenum

The cloud provider of the cluster. Only for Standard Deployment.

Allowed values:

clusterIdstring

The ID of the cluster where the Deployment is hosted.

clusterNamestring

The name of the cluster where the Deployment is hosted. Only for Dedicated and Hybrid Deployments.

contactEmailslist of strings

The list of contact emails for the Deployment.

dagTarballVersionstring

The Deployment's current DAG tarball version, also known as the Bundle Version in the Astro UI. If no deploys are currently processing, this value should be the same as DesiredDagTarballVersion.

defaultTaskPodCpustring

The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores.

defaultTaskPodMemorystring

The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in Gi. This value must always be twice the value of DefaultTaskPodCpu.

descriptionstring

The Deployment's description.

desiredDagTarballVersionstring

The Deployment’s expected DAG tarball version after a currently processing deploy completes. This value is updated when a user triggers a DAG-only deploy to indicate that the Deployment is expecting a new DAG tarball version. If no deploys are currently processing, this value should be the same as DagTarballVersion.

drExternalIPslist of strings

A list of the Deployment's external IPs in the DR cluster

drOidcIssuerUrlstring

OIDC issuer URL of the deployment's DR cluster

effectiveDRWorkloadIdentitystring

The DR workload identity being used by the deployment. Either user-configured or Astronomer-provided default.

effectiveWorkloadIdentitystring

The workload identity being used by the deployment. Either user-configured or Astronomer-provided default.

environmentVariableslist of objects

The Deployment's environment variables. Secret values will be omitted from response.

executorenum

The Deployment's executor type.

Allowed values:

externalIPslist of strings

A list of the Deployment's external IPs.

imageVersionstring

A tag that Astronomer applies to the Deployment's Astro Runtime image during a deploy. It includes the date and time of the deploy.

isDevelopmentModeboolean

If true, deployment will be able to use development-only features, such as hibernation, but will not have guaranteed uptime SLAs

isHighAvailabilityboolean

Whether the Deployment has high availability (HA) enabled. If true, multiple scheduler Pods will run at once.

oidcIssuerUrlstring

OIDC issuer URL of the deployment's cluster

regionstring

The region of the cluster. Only for Dedicated and Hybrid Deployments.

remoteExecutionobject

resourceQuotaCpustring

The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores.

resourceQuotaMemorystring

The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in Gi. This value must always be twice the value of ResourceQuotaCpu.

scalingSpecobject

scalingStatusobject

schedulerAuinteger

The number of Astronomer units (AU) for the Deployment’s scheduler. Applies only to Deployments hosted on Hybrid clusters.

schedulerSizeenum

The Deployment's scheduler size.

Allowed values:

statusReasonstring

A message that provides context for the Deployment's status.

taskPodNodePoolIdstring

The node pool ID for the task pod.

typeenum

The type of cluster that the Deployment runs on.

Allowed values:

webServerReplicasinteger

The number of webserver replicas.

workerQueueslist of objects

A list of the Deployment's worker queues.

workspaceNamestring

The name of the Workspace to which the Deployment belongs.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -X POST https://api.astronomer.io/v1/organizations/organizationId/deployments \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "My deployment",
>	"workspaceId": "clmh8ol3x000008jo656y4285"
>	}'

1	{
2	"airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
3	"apiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed/api/v1",
4	"astroRuntimeVersion": "9.1.0",
5	"createdAt": "2022-11-22T04:37:12Z",
6	"createdBy": {
7	"id": "clm8qv74h000008mlf08scq7k",
8	"apiTokenName": "my-token",
9	"avatarUrl": "https://avatar.url",
10	"fullName": "Jane Doe",
11	"subjectType": "USER",
12	"username": "user1@company.com"
13	},
14	"id": "clmh57jtm000008lb58fe2wmv",
15	"imageRepository": "https://my-image-repository",
16	"imageTag": "my-image-tag",
17	"isCicdEnforced": true,
18	"isDagDeployEnabled": true,
19	"name": "My deployment",
20	"namespace": "weightless-diameter-8927",
21	"organizationId": "clmh59gt0000308lbgswe5fvh",
22	"runtimeVersion": "9.1.0",
23	"schedulerCpu": "1",
24	"schedulerMemory": "1Gi",
25	"schedulerReplicas": 1,
26	"status": "HEALTHY",
27	"uiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed?orgId=org_bvqayGttQauxdxB2",
28	"updatedAt": "2022-11-22T04:37:12Z",
29	"updatedBy": {
30	"id": "clm8qv74h000008mlf08scq7k",
31	"apiTokenName": "my-token",
32	"avatarUrl": "https://avatar.url",
33	"fullName": "Jane Doe",
34	"subjectType": "USER",
35	"username": "user1@company.com"
36	},
37	"webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
38	"webServerCpu": "0.5",
39	"webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
40	"webServerMemory": "0.5Gi",
41	"webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
42	"workspaceId": "clmh58o7d000108lb74ktc9o64",
43	"cloudProvider": "AZURE",
44	"clusterId": "clmh597sg000208lb2kjhcn8q",
45	"clusterName": "my cluster",
46	"contactEmails": [
47	"user1@company.com"
48	],
49	"dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
50	"defaultTaskPodCpu": "0.5",
51	"defaultTaskPodMemory": "1Gi",
52	"description": "My deployment description",
53	"desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z",
54	"drExternalIPs": [
55	"string"
56	],
57	"drOidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
58	"effectiveDRWorkloadIdentity": "string",
59	"effectiveWorkloadIdentity": "string",
60	"environmentVariables": [
61	{
62	"isSecret": true,
63	"key": "my-var",
64	"updatedAt": "2022-11-22T04:37:12Z",
65	"value": "my-var-value"
66	}
67	],
68	"executor": "CELERY",
69	"externalIPs": [
70	"0.0.0.0"
71	],
72	"imageVersion": "deploy-2023-09-14T19-04",
73	"isDevelopmentMode": true,
74	"isHighAvailability": true,
75	"oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
76	"region": "us-east-1",
77	"remoteExecution": {
78	"allowedIpAddressRanges": [
79	"string"
80	],
81	"enabled": true,
82	"remoteApiUrl": "string",
83	"taskLogBucket": "string",
84	"taskLogUrlPattern": "string"
85	},
86	"resourceQuotaCpu": "160",
87	"resourceQuotaMemory": "320Gi",
88	"scalingSpec": {
89	"hibernationSpec": {
90	"override": {
91	"isActive": true,
92	"isHibernating": true,
93	"overrideUntil": "2024-01-15T09:30:00Z"
94	},
95	"schedules": [
96	{
97	"hibernateAtCron": "string",
98	"isEnabled": true,
99	"wakeAtCron": "string",
100	"description": "string"
101	}
102	]
103	}
104	},
105	"scalingStatus": {
106	"hibernationStatus": {
107	"isHibernating": true,
108	"nextEventAt": "string",
109	"nextEventType": "HIBERNATE",
110	"reason": "string"
111	}
112	},
113	"schedulerAu": 5,
114	"schedulerSize": "MEDIUM",
115	"statusReason": "Successfully Deployed",
116	"taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
117	"type": "DEDICATED",
118	"webServerReplicas": 1,
119	"workerQueues": [
120	{
121	"id": "clmh9vsuf000908midngba9mw",
122	"isDefault": true,
123	"maxWorkerCount": 10,
124	"minWorkerCount": 1,
125	"name": "default",
126	"podCpu": "1",
127	"podMemory": "2Gi",
128	"workerConcurrency": 20,
129	"astroMachine": "A5",
130	"nodePoolId": "clmh9yjcn000a08mi8dsgbno9"
131	}
132	],
133	"workspaceName": "my-workspace"
134	}