Skip to main content
GET
/
organizations
/
{organizationId}
/
deployments
List Deployments
curl --request GET \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/deployments \
  --header 'Authorization: Bearer <token>'
{
  "deployments": [
    {
      "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
      "apiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed/api/v1",
      "astroRuntimeVersion": "9.1.0",
      "createdAt": "2022-11-22T04:37:12Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "id": "clmh57jtm000008lb58fe2wmv",
      "imageRepository": "https://my-image-repository",
      "imageTag": "my-image-tag",
      "isCicdEnforced": true,
      "isDagDeployEnabled": true,
      "name": "My deployment",
      "namespace": "weightless-diameter-8927",
      "organizationId": "clmh59gt0000308lbgswe5fvh",
      "runtimeVersion": "9.1.0",
      "schedulerCpu": "1",
      "schedulerMemory": "1Gi",
      "schedulerReplicas": 1,
      "status": "HEALTHY",
      "uiUrl": "https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed?orgId=org_bvqayGttQauxdxB2",
      "updatedAt": "2022-11-22T04:37:12Z",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
      "webServerCpu": "0.5",
      "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
      "webServerMemory": "0.5Gi",
      "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
      "workspaceId": "clmh58o7d000108lb74ktc9o64",
      "cloudProvider": "AZURE",
      "clusterId": "clmh597sg000208lb2kjhcn8q",
      "clusterName": "my cluster",
      "contactEmails": [
        "user1@company.com"
      ],
      "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
      "defaultTaskPodCpu": "0.5",
      "defaultTaskPodMemory": "1Gi",
      "description": "My deployment description",
      "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z",
      "drExternalIPs": [
        "<string>"
      ],
      "drOidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
      "drWorkloadIdentity": "<string>",
      "environmentVariables": [
        {
          "isSecret": true,
          "key": "my-var",
          "updatedAt": "2022-11-22T04:37:12Z",
          "value": "my-var-value"
        }
      ],
      "executor": "CELERY",
      "externalIPs": [
        "0.0.0.0"
      ],
      "imageVersion": "deploy-2023-09-14T19-04",
      "isDevelopmentMode": true,
      "isHighAvailability": true,
      "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
      "region": "us-east-1",
      "remoteExecution": {
        "allowedIpAddressRanges": [
          "<string>"
        ],
        "enabled": true,
        "remoteApiUrl": "<string>",
        "taskLogBucket": "<string>",
        "taskLogUrlPattern": "<string>"
      },
      "resourceQuotaCpu": "160",
      "resourceQuotaMemory": "320Gi",
      "scalingSpec": {
        "hibernationSpec": {
          "override": {
            "isActive": true,
            "isHibernating": true,
            "overrideUntil": "2023-11-07T05:31:56Z"
          },
          "schedules": [
            {
              "hibernateAtCron": "<string>",
              "isEnabled": true,
              "wakeAtCron": "<string>",
              "description": "<string>"
            }
          ]
        }
      },
      "scalingStatus": {
        "hibernationStatus": {
          "isHibernating": true,
          "nextEventAt": "<string>",
          "nextEventType": "HIBERNATE",
          "reason": "<string>"
        }
      },
      "schedulerAu": 5,
      "schedulerSize": "MEDIUM",
      "statusReason": "Successfully Deployed",
      "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
      "type": "DEDICATED",
      "webServerReplicas": 1,
      "workerQueues": [
        {
          "id": "clmh9vsuf000908midngba9mw",
          "isDefault": true,
          "maxWorkerCount": 10,
          "minWorkerCount": 1,
          "name": "default",
          "podCpu": "1",
          "podMemory": "2Gi",
          "workerConcurrency": 20,
          "astroMachine": "A5",
          "nodePoolId": "clmh9yjcn000a08mi8dsgbno9"
        }
      ],
      "workloadIdentity": "<string>",
      "workspaceName": "my-workspace"
    }
  ],
  "limit": 10,
  "offset": 0,
  "totalCount": 100
}

Documentation Index

Fetch the complete documentation index at: https://astronomer-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationId
string
required

The ID of the Organization to list Deployments for.

Query Parameters

​
deploymentIds
string[]

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

​
names
string[]

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

​
workspaceIds
string[]

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

​
offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
​
limit
integer
default:20

The maximum number of results to return.

Required range: x >= 0
​
sorts
enum<string>[]

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

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

​
deployments
object[]
required

A list of Deployments in the current page.

​
limit
integer
required

The maximum number of Deployments in one page.

Example:

10

​
offset
integer
required

The offset of the current page of Deployments.

Example:

0

​
totalCount
integer
required

The total number of Deployments.

Example:

100