List Deployments

GET

List Deployments in an Organization.

Path parameters

organizationIdstringRequired

The ID of the Organization to list Deployments for.

Query parameters

deploymentIdslist of stringsOptional

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

To list multiple Deployments, you must string together the parameter with the deploymentIds. For example, deployments?deploymentIds=deploymentId1&deploymentIds=deploymentId2

nameslist of stringsOptional

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

workspaceIdslist of stringsOptional

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

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning values.

limitintegerOptional>=0Defaults to 20

The maximum number of results to return.

sortslist of enumsOptional

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

Response

deploymentslist of objects

A list of Deployments in the current page.

limitinteger

The maximum number of Deployments in one page.

offsetinteger

The offset of the current page of Deployments.

totalCountinteger

The total number of Deployments.

Errors

GET

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

200Retrieved

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

Built with

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

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