Platform API ReferenceDeployment

Update a Deployment

Update a Deployment in the Organization.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the Deployment belongs.
deploymentIdstringRequired
The Deployment's ID.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
Update Dedicated Deployment RequestobjectRequired
OR
Update Hybrid Deployment RequestobjectRequired
OR
Update Standard Deployment RequestobjectRequired

Response

OK
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.
cloudProviderenum or null
The cloud provider of the cluster. Only for Standard Deployment.
Allowed values:
clusterIdstring or null
The ID of the cluster where the Deployment is hosted.
clusterNamestring or null
The name of the cluster where the Deployment is hosted. Only for Dedicated and Hybrid Deployments.
contactEmailslist of strings or null
The list of contact emails for the Deployment.
dagTarballVersionstring or null
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 or null
The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores.
defaultTaskPodMemorystring or null

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 or null
The Deployment's description.
desiredDagTarballVersionstring or null

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 objects or null
The Deployment's environment variables. Secret values will be omitted from response.
executorenum or null
The Deployment's executor type.
Allowed values:
externalIPslist of strings or null
A list of the Deployment's external IPs.
imageVersionstring or null
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 or null

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

isHighAvailabilityboolean or null

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

oidcIssuerUrlstring or null
OIDC issuer URL of the deployment's cluster
regionstring or null
The region of the cluster. Only for Dedicated and Hybrid Deployments.
resourceQuotaCpustring or null
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 or null

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 or null
scalingStatusobject or null
schedulerAuinteger or null

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

schedulerSizeenum or null
The Deployment's scheduler size.
Allowed values:
statusReasonstring or null
A message that provides context for the Deployment's status.
taskPodNodePoolIdstring or null
The node pool ID for the task pod.
typeenum or null
The type of cluster that the Deployment runs on.
Allowed values:
webServerReplicasinteger or null
The number of webserver replicas.
workerQueueslist of objects or null
A list of the Deployment's worker queues.
workloadIdentitystring or null
The Deployment's workload identity.
workspaceNamestring or null
The name of the Workspace to which the Deployment belongs.

Errors