Skip to main content

Platform API reference

Use the following reference to learn about all of the possible requests within the Platform schema.

tip

To use this schema in Postman:

  1. Click the Download button on this page to download the YAML file for the schema.
  2. Follow the Postman documentation to import the schema to Postman.
API docs by Redocly

Astro Platform API (v1beta1)

Download OpenAPI specification:Download

Astro Platform API

Cluster

A cluster object represents an Astro cluster, which is a Kubernetes cluster that hosts the infrastructure required to run Deployments. Make requests to cluster endpoints to manage your standard and dedicated clusters. See Create a dedicated cluster.

List clusters

List clusters in an Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The Organization's unique ID.

query Parameters
provider
string
Enum: "AWS" "AZURE" "GCP"

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

offset
integer >= 0
Default: 0

The number of results to skip before returning values.

limit
integer [ 0 .. 1000 ]
Default: 20

The maximum number of results to return.

sorts
Array of strings
Items Enum: "name:asc" "name:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ],
  • "limit": 10,
  • "offset": 0,
  • "totalCount": 100
}

Create a cluster

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

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to create the cluster in.

Request Body schema: application/json

The request body for creating a cluster

One of
cloudProvider
required
string
Enum: "AWS" "AZURE" "GCP"

The cluster's cloud provider.

dbInstanceType
string

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

Array of objects (ClusterK8sTag)

The Kubernetes tags in the cluster.

name
required
string

The cluster's name.

Array of objects (CreateNodePoolRequest)

The list of node pools to create in the cluster.

providerAccount
string

The provider account ID. Required for Hybrid clusters.

region
required
string

The cluster's region.

type
required
string
Enum: "DEDICATED" "HYBRID"

The cluster's type.

vpcSubnetRange
required
string

The VPC subnet range.

workspaceIds
Array of strings unique

The list of Workspaces that are authorized to the cluster.

Responses

Request samples

Content type
application/json
Example
{
  • "cloudProvider": "AZURE",
  • "dbInstanceType": "Small General Purpose",
  • "k8sTags": [
    ],
  • "name": "My cluster",
  • "nodePools": [
    ],
  • "providerAccount": "provider-account",
  • "region": "us-east-1",
  • "type": "DEDICATED",
  • "vpcSubnetRange": "172.20.0.0/22",
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "cloudProvider": "AWS",
  • "createdAt": "2022-11-22T04:37:12Z",
  • "dbInstanceType": "db.t3.medium",
  • "id": "clm7k8tgw000008jz97i37y81",
  • "isLimited": false,
  • "metadata": {
    },
  • "name": "my cluster",
  • "nodePools": [
    ],
  • "organizationId": "clm88r8hi000008jwhzxu5crg",
  • "podSubnetRange": "172.21.0.0/19",
  • "providerAccount": "provider-account",
  • "region": "us-east-1",
  • "servicePeeringRange": "172.23.0.0/20",
  • "serviceSubnetRange": "172.22.0.0/22",
  • "status": "CREATED",
  • "tags": [
    ],
  • "tenantId": "your-tenant-id",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "vpcSubnetRange": "172.20.0.0/22",
  • "workspaceIds": [
    ]
}

Delete a cluster

Delete a cluster.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the cluster belongs.

clusterId
required
string

The cluster's ID.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "requestId": "string",
  • "statusCode": 400
}

Get a cluster

Retrieve details about a cluster.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the cluster belongs.

clusterId
required
string

The cluster's ID.

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "AWS",
  • "createdAt": "2022-11-22T04:37:12Z",
  • "dbInstanceType": "db.t3.medium",
  • "id": "clm7k8tgw000008jz97i37y81",
  • "isLimited": false,
  • "metadata": {
    },
  • "name": "my cluster",
  • "nodePools": [
    ],
  • "organizationId": "clm88r8hi000008jwhzxu5crg",
  • "podSubnetRange": "172.21.0.0/19",
  • "providerAccount": "provider-account",
  • "region": "us-east-1",
  • "servicePeeringRange": "172.23.0.0/20",
  • "serviceSubnetRange": "172.22.0.0/22",
  • "status": "CREATED",
  • "tags": [
    ],
  • "tenantId": "your-tenant-id",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "vpcSubnetRange": "172.20.0.0/22",
  • "workspaceIds": [
    ]
}

Update a cluster

Update a cluster in the Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the cluster belongs.

clusterId
required
string

The cluster's ID

Request Body schema: application/json

The request body for updating the cluster

dbInstanceType
string

The cluster's database instance type. Required for Hybrid clusters.

required
Array of objects (ClusterK8sTag)

A list of Kubernetes tags to add to the cluster.

name
required
string

The cluster's name.

Array of objects (UpdateNodePoolRequest)

A list of node pools to add to the cluster. For Hybrid clusters only.

workspaceIds
Array of strings unique

The list of Workspaces that are authorized to the cluster. If this value is not provided, the existing list of Workspaces remains. If this value is '[]' then all workspace cluster mappings are removed.

Responses

Request samples

Content type
application/json
{
  • "dbInstanceType": "Small General Purpose",
  • "k8sTags": [
    ],
  • "name": "My cluster",
  • "nodePools": [
    ],
  • "workspaceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "cloudProvider": "AWS",
  • "createdAt": "2022-11-22T04:37:12Z",
  • "dbInstanceType": "db.t3.medium",
  • "id": "clm7k8tgw000008jz97i37y81",
  • "isLimited": false,
  • "metadata": {
    },
  • "name": "my cluster",
  • "nodePools": [
    ],
  • "organizationId": "clm88r8hi000008jwhzxu5crg",
  • "podSubnetRange": "172.21.0.0/19",
  • "providerAccount": "provider-account",
  • "region": "us-east-1",
  • "servicePeeringRange": "172.23.0.0/20",
  • "serviceSubnetRange": "172.22.0.0/22",
  • "status": "CREATED",
  • "tags": [
    ],
  • "tenantId": "your-tenant-id",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "vpcSubnetRange": "172.20.0.0/22",
  • "workspaceIds": [
    ]
}

Organization

The organization object contains the metadata and configurations of an Astro Organization. It does not include objects within the Organization, such as users and clusters. Make requests to organization endpoints to view and update high level settings for your Organization, including settings related to authentication and billing. To manage resources within an Organization, make requests to the endpoints related to those resources, such as users. See Billing, Set up single sign-on, and Manage domains.

List Organizations

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

Authorizations:
JWT
query Parameters
supportPlan
string
Enum: "TRIAL" "BASIC" "STANDARD" "PREMIUM" "BUSINESS_CRITICAL"

Filters the Organization list by support plan.

product
string
Enum: "HOSTED" "HYBRID"

Filters the Organization list by product.

offset
integer >= 0
Default: 0

The number of results to skip before returning values.

limit
integer [ 0 .. 1000 ]
Default: 20

The maximum number of results to return.

sorts
Array of strings
Items Enum: "name:asc" "name:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "organizations": [
    ],
  • "totalCount": 100
}

Get an Organization

Retrieve information about a specific Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The Organization's ID.

query Parameters
isLookUpOnly
boolean

Whether to show only Organization metadata.

Responses

Response samples

Content type
application/json
{
  • "billingEmail": "billing@company.com",
  • "createdAt": "2022-11-22T04:37:12T",
  • "createdBy": {
    },
  • "id": "clmaxoarx000008l2c5ayb9pt",
  • "isScimEnabled": false,
  • "managedDomains": [
    ],
  • "name": "My organization",
  • "paymentMethod": "CREDIT_CARD",
  • "product": "HOSTED",
  • "status": "ACTIVE",
  • "supportPlan": "BUSINESS_CRITICAL",
  • "trialExpiresAt": "2022-11-22T04:37:12T",
  • "updatedAt": "2022-11-22T04:37:12T",
  • "updatedBy": {
    }
}

Update an Organization

Update an Organization's details.

Authorizations:
JWT
path Parameters
organizationId
required
string

The Organization's ID.

Request Body schema: application/json

The request body for updating the Organization.

billingEmail
required
string

The Organization's billing email.

isScimEnabled
required
boolean

Whether SCIM is enabled for the Organization.

name
required
string <= 50 characters

The name of the Organization.

Responses

Request samples

Content type
application/json
{
  • "billingEmail": "billing@company.com",
  • "isScimEnabled": false,
  • "name": "My Organization"
}

Response samples

Content type
application/json
{
  • "billingEmail": "billing@company.com",
  • "createdAt": "2022-11-22T04:37:12T",
  • "createdBy": {
    },
  • "id": "clmaxoarx000008l2c5ayb9pt",
  • "isScimEnabled": false,
  • "managedDomains": [
    ],
  • "name": "My organization",
  • "paymentMethod": "CREDIT_CARD",
  • "product": "HOSTED",
  • "status": "ACTIVE",
  • "supportPlan": "BUSINESS_CRITICAL",
  • "trialExpiresAt": "2022-11-22T04:37:12T",
  • "updatedAt": "2022-11-22T04:37:12T",
  • "updatedBy": {
    }
}

Options

The options object represents all possible configurations for a given Astro component. Make requests to the options object to get the configuration constraints for creating or updating a given Astro component.

Get cluster options

Get all possible options for configuring a cluster.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to get cluster options for.

query Parameters
provider
string
Enum: "AWS" "AZURE" "GCP"

The cluster's cloud provider.

type
required
string
Enum: "DEDICATED" "HYBRID"

The cluster type.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Deployment options

Get the options available for configuring a Deployment.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to retrieve Deployment options for.

query Parameters
deploymentId
string

The ID of a Deployment to retrieve options for.

deploymentType
string
Enum: "HYBRID" "DEDICATED" "STANDARD"

The runtime type of the deployment.

cloudProvider
string
Enum: "AWS" "AZURE" "GCP"

The cloud provider of the cluster for the deployment.

Responses

Response samples

Content type
application/json
{
  • "executors": [
    ],
  • "resourceQuotas": {
    },
  • "runtimeReleases": [
    ],
  • "schedulerMachines": [
    ],
  • "workerMachines": [
    ],
  • "workerQueues": {
    },
  • "workloadIdentityOptions": [
    ]
}

Workspace

The workspace object represents an Astro Workspace, which is a collection of Deployments that can be accessed by a specific group of users. It contains metadata about a Workspace, but does not contain objects within the Workspace such as users and Deployments. Make requests to workspace endpoints to manage high level details about your Workspace. To manage resources within a Workspace, make requests to the endpoints related to those resources, such as users, and use the workspaceIds parameter to filter results by Workspace. See Configure Workspaces.

List Workspaces

List Workspaces in an Organization

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to list Workspaces for.

query Parameters
workspaceIds
Array of strings

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

offset
integer >= 0
Default: 0

The number of results to skip before returning values.

limit
integer [ 0 .. 1000 ]
Default: 20

The maximum number of results to return.

sorts
Array of strings
Items Enum: "name:asc" "name:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "totalCount": 0,
  • "workspaces": [
    ]
}

Create Workspace

Create a Workspace.

Authorizations:
JWT
path Parameters
organizationId
required
string

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

Request Body schema: application/json

The request body for creating a new Workspace.

cicdEnforcedDefault
boolean

Whether new Deployments enforce CI/CD deploys by default.

description
string

The Workspace's description.

name
required
string <= 50 characters

The Workspace's name.

Responses

Request samples

Content type
application/json
{
  • "cicdEnforcedDefault": true,
  • "description": "This is a test workspace",
  • "name": "My Workspace"
}

Response samples

Content type
application/json
{
  • "cicdEnforcedDefault": true,
  • "createdAt": "2023-09-08T12:00:00Z",
  • "createdBy": {
    },
  • "description": "This is a test workspace",
  • "id": "clm8t5u4q000008jq4qoc3036",
  • "name": "My Workspace",
  • "organizationId": "clm8t5u4q000008jq4qoc3036",
  • "organizationName": "My Organization",
  • "updatedAt": "2023-09-08T13:30:00Z",
  • "updatedBy": {
    }
}

Delete Workspace

Delete a Workspace.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Workspace belongs.

workspaceId
required
string

The Workspace's ID.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "requestId": "string",
  • "statusCode": 400
}

Get Workspace

Get information about a Workspace.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Workspace belongs.

workspaceId
required
string

The Workspace's ID.

Responses

Response samples

Content type
application/json
{
  • "cicdEnforcedDefault": true,
  • "createdAt": "2023-09-08T12:00:00Z",
  • "createdBy": {
    },
  • "description": "This is a test workspace",
  • "id": "clm8t5u4q000008jq4qoc3036",
  • "name": "My Workspace",
  • "organizationId": "clm8t5u4q000008jq4qoc3036",
  • "organizationName": "My Organization",
  • "updatedAt": "2023-09-08T13:30:00Z",
  • "updatedBy": {
    }
}

Update Workspace

Update a Workspace.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Workspace belongs.

workspaceId
required
string

The Workspace's ID.

Request Body schema: application/json

The request body for updating a new Workspace.

cicdEnforcedDefault
required
boolean

Whether new Deployments enforce CI/CD deploys by default.

description
required
string

The Workspace's description.

name
required
string <= 50 characters

The Workspace's name.

Responses

Request samples

Content type
application/json
{
  • "cicdEnforcedDefault": true,
  • "description": "This is a test workspace",
  • "name": "My Workspace"
}

Response samples

Content type
application/json
{
  • "cicdEnforcedDefault": true,
  • "createdAt": "2023-09-08T12:00:00Z",
  • "createdBy": {
    },
  • "description": "This is a test workspace",
  • "id": "clm8t5u4q000008jq4qoc3036",
  • "name": "My Workspace",
  • "organizationId": "clm8t5u4q000008jq4qoc3036",
  • "organizationName": "My Organization",
  • "updatedAt": "2023-09-08T13:30:00Z",
  • "updatedBy": {
    }
}

Deployment

List Deployments

List Deployments in an Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to list Deployments for.

query Parameters
deploymentIds
Array of strings

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

workspaceIds
Array of strings

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

offset
integer >= 0
Default: 0

The number of results to skip before returning values.

limit
integer >= 0
Default: 20

The maximum number of results to return.

sorts
Array of strings
Items Enum: "name:asc" "name:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Responses

Response samples

Content type
application/json
{
  • "deployments": [
    ],
  • "limit": 10,
  • "offset": 0,
  • "totalCount": 100
}

Create a Deployment

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

Authorizations:
JWT
path Parameters
organizationId
required
string

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

Request Body schema: application/json

The request body for creating a Deployment.

One of
astroRuntimeVersion
required
string

Deployment's Astro Runtime version.

clusterId
required
string

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

defaultTaskPodCpu
required
string

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

defaultTaskPodMemory
required
string

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.

description
string <= 1000 characters

The Deployment's description.

executor
required
string
Enum: "CELERY" "KUBERNETES"

The Deployment's executor type.

isCicdEnforced
required
boolean

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

isDagDeployEnabled
required
boolean

Whether the Deployment has DAG deploys enabled.

isHighAvailability
required
boolean

Whether the Deployment is configured for high availability. If true, multiple scheduler pods will be online.

name
required
string <= 500 characters

The Deployment's name.

resourceQuotaCpu
required
string

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.

resourceQuotaMemory
required
string

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.

schedulerSize
required
string
Enum: "SMALL" "MEDIUM" "LARGE"

The size of the scheduler pod.

type
required
string
Enum: "DEDICATED" "HYBRID" "STANDARD"

The type of the Deployment.

Array of objects (WorkerQueueRequest) non-empty

The list of worker queues configured for the Deployment. Applies only when Executor is CELERY. At least 1 worker queue is needed. All Deployments need at least 1 worker queue called default.

workspaceId
required
string

The ID of the workspace to which the Deployment belongs.

Responses

Request samples

Content type
application/json
Example
{
  • "astroRuntimeVersion": "9.1.0",
  • "clusterId": "clmh9g6zj000008mg77if5wa2",
  • "defaultTaskPodCpu": "0.5",
  • "defaultTaskPodMemory": "1",
  • "description": "My deployment description",
  • "executor": "CELERY",
  • "isCicdEnforced": true,
  • "isDagDeployEnabled": true,
  • "isHighAvailability": true,
  • "name": "My deployment",
  • "resourceQuotaCpu": "160",
  • "resourceQuotaMemory": "320Gi",
  • "schedulerSize": "MEDIUM",
  • "type": "DEDICATED",
  • "workerQueues": [
    ],
  • "workspaceId": "clmh8ol3x000008jo656y4285"
}

Response samples

Content type
application/json
{
  • "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
  • "cloudProvider": "azure",
  • "clusterId": "clmh597sg000208lb2kjhcn8q",
  • "clusterName": "my cluster",
  • "contactEmails": [
    ],
  • "createdAt": "2022-11-22T04:37:12Z",
  • "createdBy": {
    },
  • "dagTarballVersion": "1",
  • "defaultTaskPodCpu": "0.5",
  • "defaultTaskPodMemory": "1",
  • "description": "My deployment description",
  • "environmentVariables": [
    ],
  • "executor": "CELERY",
  • "externalIPs": [
    ],
  • "id": "clmh57jtm000008lb58fe2wmv",
  • "imageRepository": "https://my-image-repository",
  • "imageTag": "my-image-tag",
  • "imageVersion": "deploy-2023-09-14T19-04",
  • "isCicdEnforced": true,
  • "isDagDeployEnabled": true,
  • "isHighAvailability": true,
  • "name": "My deployment",
  • "namespace": "weightless-diameter-8927",
  • "organizationId": "clmh59gt0000308lbgswe5fvh",
  • "region": "us-east-1",
  • "resourceQuotaCpu": "160",
  • "resourceQuotaMemory": "320Gi",
  • "runtimeVersion": "9.1.0",
  • "schedulerAu": 5,
  • "schedulerCpu": "1",
  • "schedulerMemory": "1Gi",
  • "schedulerReplicas": 1,
  • "schedulerSize": "MEDIUM",
  • "status": "HEALTHY",
  • "statusReason": "Successfully Deployed",
  • "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "updatedBy": {
    },
  • "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
  • "webServerCpu": "0.5",
  • "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
  • "webServerMemory": "0.5Gi",
  • "webServerReplicas": 1,
  • "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
  • "workerQueues": [
    ],
  • "workloadIdentity": "string",
  • "workspaceId": "clmh58o7d000108lb74ktc9o64",
  • "workspaceName": "my-workspace"
}

Delete a Deployment

Delete a Deployment from an Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Deployment belongs.

deploymentId
required
string

The Deployment's ID.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "requestId": "string",
  • "statusCode": 400
}

Get a Deployment

Retrieve details about a Deployment.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Deployment belongs.

deploymentId
required
string

The Deployment's ID.

Responses

Response samples

Content type
application/json
{
  • "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
  • "cloudProvider": "azure",
  • "clusterId": "clmh597sg000208lb2kjhcn8q",
  • "clusterName": "my cluster",
  • "contactEmails": [
    ],
  • "createdAt": "2022-11-22T04:37:12Z",
  • "createdBy": {
    },
  • "dagTarballVersion": "1",
  • "defaultTaskPodCpu": "0.5",
  • "defaultTaskPodMemory": "1",
  • "description": "My deployment description",
  • "environmentVariables": [
    ],
  • "executor": "CELERY",
  • "externalIPs": [
    ],
  • "id": "clmh57jtm000008lb58fe2wmv",
  • "imageRepository": "https://my-image-repository",
  • "imageTag": "my-image-tag",
  • "imageVersion": "deploy-2023-09-14T19-04",
  • "isCicdEnforced": true,
  • "isDagDeployEnabled": true,
  • "isHighAvailability": true,
  • "name": "My deployment",
  • "namespace": "weightless-diameter-8927",
  • "organizationId": "clmh59gt0000308lbgswe5fvh",
  • "region": "us-east-1",
  • "resourceQuotaCpu": "160",
  • "resourceQuotaMemory": "320Gi",
  • "runtimeVersion": "9.1.0",
  • "schedulerAu": 5,
  • "schedulerCpu": "1",
  • "schedulerMemory": "1Gi",
  • "schedulerReplicas": 1,
  • "schedulerSize": "MEDIUM",
  • "status": "HEALTHY",
  • "statusReason": "Successfully Deployed",
  • "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "updatedBy": {
    },
  • "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
  • "webServerCpu": "0.5",
  • "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
  • "webServerMemory": "0.5Gi",
  • "webServerReplicas": 1,
  • "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
  • "workerQueues": [
    ],
  • "workloadIdentity": "string",
  • "workspaceId": "clmh58o7d000108lb74ktc9o64",
  • "workspaceName": "my-workspace"
}

Update a Deployment

Update a Deployment in the Organization.

Authorizations:
JWT
path Parameters
organizationId
required
string

The ID of the Organization to which the Deployment belongs.

deploymentId
required
string

The Deployment's ID.

Request Body schema: application/json

The request body for updating a Deployment.

One of
contactEmails
Array of strings

A list of contact emails for the Deployment.

defaultTaskPodCpu
required
string

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

defaultTaskPodMemory
required
string

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.

description
string <= 1000 characters

The Deployment's description.

required
Array of objects (DeploymentEnvironmentVariableRequest)

List of environment variables to add to the Deployment.

executor
required
string
Enum: "CELERY" "KUBERNETES"

The executor Deployment's executor.

isCicdEnforced
required
boolean

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

isDagDeployEnabled
required
boolean

Whether the Deployment has DAG deploys enabled.

isHighAvailability
required
boolean

Whether the Deployment is configured for high availability. If true, multiple scheduler pods will be online.

name
required
string <= 500 characters

The Deployment's name.

resourceQuotaCpu
required
string

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.

resourceQuotaMemory
required
string

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.

schedulerSize
required
string
Enum: "SMALL" "MEDIUM" "LARGE"

The size of the scheduler pod.

type
required
string
Enum: "DEDICATED" "HYBRID" "STANDARD"

The type of the Deployment.

Array of objects (WorkerQueueRequest) non-empty

A list of the Deployment's worker queues. Applies only when Executor is CELERY. All Deployments need at least 1 worker queue called default.

workloadIdentity
string

The Deployment's workload identity.

workspaceId
required
string

The ID of the Workspace to which the Deployment belongs.

Responses

Request samples

Content type
application/json
Example
{
  • "contactEmails": [
    ],
  • "defaultTaskPodCpu": "0.5",
  • "defaultTaskPodMemory": "1",
  • "description": "My deployment description",
  • "environmentVariables": [
    ],
  • "executor": "CELERY",
  • "isCicdEnforced": true,
  • "isDagDeployEnabled": true,
  • "isHighAvailability": true,
  • "name": "My deployment",
  • "resourceQuotaCpu": "160",
  • "resourceQuotaMemory": "320Gi",
  • "schedulerSize": "MEDIUM",
  • "type": "DEDICATED",
  • "workerQueues": [
    ],
  • "workloadIdentity": "arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0",
  • "workspaceId": "clmh7vdf4000008lhhlnk9t6o"
}

Response samples

Content type
application/json
{
  • "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
  • "cloudProvider": "azure",
  • "clusterId": "clmh597sg000208lb2kjhcn8q",
  • "clusterName": "my cluster",
  • "contactEmails": [
    ],
  • "createdAt": "2022-11-22T04:37:12Z",
  • "createdBy": {
    },
  • "dagTarballVersion": "1",
  • "defaultTaskPodCpu": "0.5",
  • "defaultTaskPodMemory": "1",
  • "description": "My deployment description",
  • "environmentVariables": [
    ],
  • "executor": "CELERY",
  • "externalIPs": [
    ],
  • "id": "clmh57jtm000008lb58fe2wmv",
  • "imageRepository": "https://my-image-repository",
  • "imageTag": "my-image-tag",
  • "imageVersion": "deploy-2023-09-14T19-04",
  • "isCicdEnforced": true,
  • "isDagDeployEnabled": true,
  • "isHighAvailability": true,
  • "name": "My deployment",
  • "namespace": "weightless-diameter-8927",
  • "organizationId": "clmh59gt0000308lbgswe5fvh",
  • "region": "us-east-1",
  • "resourceQuotaCpu": "160",
  • "resourceQuotaMemory": "320Gi",
  • "runtimeVersion": "9.1.0",
  • "schedulerAu": 5,
  • "schedulerCpu": "1",
  • "schedulerMemory": "1Gi",
  • "schedulerReplicas": 1,
  • "schedulerSize": "MEDIUM",
  • "status": "HEALTHY",
  • "statusReason": "Successfully Deployed",
  • "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
  • "type": "DEDICATED",
  • "updatedAt": "2022-11-22T04:37:12Z",
  • "updatedBy": {
    },
  • "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
  • "webServerCpu": "0.5",
  • "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
  • "webServerMemory": "0.5Gi",
  • "webServerReplicas": 1,
  • "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
  • "workerQueues": [
    ],
  • "workloadIdentity": "string",
  • "workspaceId": "clmh58o7d000108lb74ktc9o64",
  • "workspaceName": "my-workspace"
}

Was this page helpful?

Sign up for Developer Updates

Get a summary of new Astro features once a month.

You can unsubscribe at any time.
By proceeding you agree to our Privacy Policy, our Website Terms and to receive emails from Astronomer.