Update a Deployment — Astro API Reference

Update a Deployment in the Organization.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the Deployment belongs.

deploymentIdstringRequired

The Deployment’s ID.

Request

This endpoint expects an object.

Update Dedicated Deployment Requestobject

Update Hybrid Deployment Requestobject

Update Standard Deployment Requestobject

Response

airflowVersionstring

The Deployment’s Airflow version.

astroRuntimeVersionstring

The Deployment’s Astro Runtime version.

createdAtdatetime

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.

updatedAtdatetime

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.

cloudProviderenumOptional

Allowed values: AWSAZUREGCP

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

clusterIdstringOptional

The ID of the cluster where the Deployment is hosted.

clusterNamestringOptional

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

contactEmailslist of stringsOptional

The list of contact emails for the Deployment.

dagTarballVersionstringOptional

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.

defaultTaskPodCpustringOptional

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

defaultTaskPodMemorystringOptional

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.

descriptionstringOptional

The Deployment’s description.

desiredDagTarballVersionstringOptional

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.

environmentVariableslist of objectsOptional

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

executor"CELERY" or "KUBERNETES"Optional

Allowed values: CELERYKUBERNETES

The Deployment’s executor type.

externalIPslist of stringsOptional

A list of the Deployment’s external IPs.

imageVersionstringOptional

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

isDevelopmentModebooleanOptional

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

isHighAvailabilitybooleanOptional

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

oidcIssuerUrlstringOptional

OIDC issuer URL of the deployment’s cluster

regionstringOptional

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

resourceQuotaCpustringOptional

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.

resourceQuotaMemorystringOptional

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.

scalingSpecobjectOptional

scalingStatusobjectOptional

schedulerAuintegerOptional

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

schedulerSizeenumOptional

Allowed values: SMALLMEDIUMLARGEEXTRA_LARGE

The Deployment’s scheduler size.

statusReasonstringOptional

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

taskPodNodePoolIdstringOptional

The node pool ID for the task pod.

typeenumOptional

Allowed values: DEDICATEDHYBRIDSTANDARD

The type of cluster that the Deployment runs on.

webServerReplicasintegerOptional

The number of webserver replicas.

workerQueueslist of objectsOptional

A list of the Deployment’s worker queues.

workloadIdentitystringOptional

The Deployment’s workload identity.

workspaceNamestringOptional

The name of the Workspace to which the Deployment belongs.

1	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"defaultTaskPodCpu": "0.5",
6	"defaultTaskPodMemory": "1Gi",
7	"environmentVariables": [
8	{
9	"isSecret": false,
10	"key": "my-var"
11	}
12	],
13	"executor": "CELERY",
14	"isCicdEnforced": true,
15	"isDagDeployEnabled": true,
16	"isHighAvailability": true,
17	"name": "My deployment",
18	"resourceQuotaCpu": "160",
19	"resourceQuotaMemory": "320Gi",
20	"schedulerSize": "SMALL",
21	"type": "DEDICATED",
22	"workspaceId": "clmh7vdf4000008lhhlnk9t6o"
23	}'

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