List the details about all Organizations that you have access to. Requires using a personal access token (PAT) for authentication.

List Organizations

Filters the Organization list by support plan.

Filters the Organization list by product.

The number of results to skip before returning values.

Retrieve information about a specific Organization.

Get an Organization

Whether to show only Organization metadata.

Update an Organization

Organization

Get all possible options for configuring a cluster.

Get cluster options

The ID of the Organization to get cluster options for.

Get the options available for configuring a Deployment.

Get Deployment options

The ID of the Organization to retrieve Deployment options for.

The ID of a Deployment to retrieve options for.

The cloud provider of the cluster for the deployment.

Options

List clusters

A list of names for Clusters to filter by. The API returns details only for the specified Clusters.

The cloud provider to list clusters for. Clusters from other providers will be filtered out of the results.

Create a cluster in the Organization. An Astro cluster is a Kubernetes cluster that hosts the infrastructure required to run Deployments.

Create a cluster

The ID of the Organization to create the cluster in.

Get a cluster

The ID of the Organization to which the cluster belongs.

Update a cluster

Delete a cluster

Cluster

List Deployments

The ID of the Organization to list Deployments for.

A list of IDs for Deployments to show. The API returns details only for the specified Deployments.

A list of names for Deployments to filter by. The API returns details only for the specified Deployments.

A list of IDs for Workspaces to filter on. The API returns details for all Deployments belonging only to the specified Workspaces.

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

Create a Deployment

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

Get a Deployment

The ID of the Organization to which the Deployment belongs.

Update a Deployment

Delete a Deployment from an Organization.

Delete a Deployment

Configure a hibernation override for a deployment

Delete a hibernation override for a deployment

Deployment

List Workspaces

The ID of the Organization to list Workspaces for.

A list of IDs for specific Workspaces to list. The API will list information only for Workspaces which have been specified in this list.

A list of names for specific Workspaces to filter by. The API will list information only for Workspaces which have been specified in this list.

Create Workspace

The ID of the Organization to which the Workspace will belong.

Get Workspace

The ID of the Organization to which the Workspace belongs.

Update Workspace

Delete Workspace

Workspace

BasicSubjectProfile

BasicSubjectProfileSubjectType

The name of the cluster's cloud provider.

The type of database instance that is used for the cluster.

The list of node pools that are created in the cluster.

The ID of the Organization that the cluster belongs to.

The subnet range for Pods. For GCP clusters only.

The provider account ID. For GCP clusters only.

The region in which the cluster is created.

The service peering range. For GCP clusters only.

The service subnet range. For GCP clusters only.

The Kubernetes tags in the cluster. For AWS Hybrid clusters only.

The list of Workspaces that are authorized to the cluster.

ClusterCloudProvider

ClusterK8STag

ClusterMetadata

ClusterOptions

ClusterOptionsProvider

ClusterStatus

ClusterType

ClustersPaginated

The list of clusters in the current page.

The maximum number of clusters in one page.

The offset of the current page of clusters.

CreateAwsClusterRequest

The type of database instance that is used for the cluster. Required for Hybrid clusters.

The list of node pools to create in the cluster.

The provider account ID. Required for Hybrid clusters.

CreateAwsClusterRequestCloudProvider

CreateAwsClusterRequestType

CreateAzureClusterRequest

CreateAzureClusterRequestCloudProvider

CreateAzureClusterRequestType

CreateClusterRequest

CreateDedicatedDeploymentRequest

The ID of the cluster where the Deployment will be created.

A list of contact emails for the Deployment.

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

List of environment variables to add to the Deployment.

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

Whether the Deployment has DAG deploys enabled.

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

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.

The ID of the workspace to which the Deployment belongs.

CreateDedicatedDeploymentRequestExecutor

CreateDedicatedDeploymentRequestSchedulerSize

CreateDedicatedDeploymentRequestType

CreateDeploymentRequest

CreateGcpClusterRequest

CreateGcpClusterRequestCloudProvider

CreateGcpClusterRequestType

CreateHybridDeploymentRequest

CreateHybridDeploymentRequestExecutor

CreateHybridDeploymentRequestType

CreateNodePoolRequest

Whether the node pool is the default node pool of the cluster.

The maximum number of nodes that can be created in the node pool.

The type of node instance that is used for the node pool.

CreateStandardDeploymentRequest

The ID of the cluster to which the Deployment will be created in. Optional if cloud provider and region is specified.

CreateStandardDeploymentRequestCloudProvider

CreateStandardDeploymentRequestExecutor

CreateStandardDeploymentRequestSchedulerSize

CreateStandardDeploymentRequestType

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

The ID of the cluster where the Deployment is hosted.

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

The list of contact emails for the Deployment.

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.

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.

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

The URL of the Deployment's image repository.

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

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

The Deployment's namespace name in the Kubernetes cluster.

OIDC issuer URL of the deployment's cluster

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

Deprecated: runtimeVersion has been replaced with astroRuntimeVersion

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

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

The number of schedulers to use in the Deployment.

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

The type of cluster that the Deployment runs on.

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

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

The Deployment's webserver's ingress hostname.

A list of the Deployment's worker queues.

The ID of the Workspace to which the Deployment belongs.

The name of the Workspace to which the Deployment belongs.

DeploymentCloudProvider

DeploymentEnvironmentVariable

Whether the environment variable is a secret.

The environment variable key, used to call the value in code.

DeploymentEnvironmentVariableRequest

DeploymentExecutor

DeploymentHibernationOverride

Whether the override is currently active or not

Whether to go into hibernation or not via the override rule

Timestamp till the override on the hibernation schedule is in effect

DeploymentHibernationOverrideRequest

DeploymentHibernationSchedule

A 5-part cron expression defining the times at which the deployment should hibernate

Toggle this schedule on or off. If set to false, this schedule will have no effect on hibernation.

A 5-part cron expression definingh the times at which the deployment should wake from hibernation

DeploymentHibernationSpec

The list of schedules for deployment hibernation

DeploymentHibernationSpecRequest

DeploymentHibernationStatus

If the deployment is currently in hibernating state or not

Timestamp of the next scheduled hibernation event for the deployment

The type of the next scheduled event for the deployment. Either HIBERNATE or WAKE

Reason for the current hibernation state of the deployment

DeploymentHibernationStatusNextEventType

DeploymentInstanceSpecRequest

DeploymentOptions

DeploymentScalingSpec

DeploymentScalingSpecRequest

DeploymentScalingStatus

DeploymentSchedulerSize

DeploymentStatus

DeploymentType

DeploymentsPaginated

A list of Deployments in the current page.

The maximum number of Deployments in one page.

The offset of the current page of Deployments.

Error

HybridWorkerQueueRequest

The worker queue's ID. If not provided, a new worker queue will be created.

Whether the worker queue is the default worker queue on the Deployment.

The maximum number of workers that can run at once.

The minimum number of workers running at once.

The node pool ID associated with the worker queue.

The maximum number of concurrent tasks that a worker Pod can run at a time.

MachineSpec

The maximum number of tasks that a given machine instance can run at once.

The CPU quantity. Units are in number of CPU cores.

ManagedDomain

A list of login types that are enforced for users belonging to the domain.

The ID of the Organization to which the managed domain belongs.

Whether the managed domain has completed the verification process.

ManagedDomainStatus

NodePool

The ID of the cluster that the node pool belongs to.

The list of supported Astro machines for the node pool. Returned only for Hosted dedicated clusters.

Astro API

Platform API Reference

IAM API Reference

Delete a Deployment

Path parameters

1	curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId \
2	-H "Authorization: Bearer <token>"