List Deployments

GET

List Deployments in an Organization.

Path parameters

organizationIdstringRequired

The ID of the Organization to list Deployments for.

Query parameters

deploymentIdsstringOptional

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

namesstringOptional

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

workspaceIdsstringOptional

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

offsetintegerOptional>=0

The number of results to skip before returning values.

limitintegerOptional>=0

The maximum number of results to return.

sortsenumOptional

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.

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       "createdAt": "2022-11-22T04:37:12Z",
7       "createdBy": {
8         "id": "clm8qv74h000008mlf08scq7k",
9         "apiTokenName": "my-token",
10         "avatarUrl": "https://avatar.url",
11         "fullName": "Jane Doe",
12         "username": "user1@company.com"
13       },
14       "id": "clmh57jtm000008lb58fe2wmv",
15       "imageRepository": "https://my-image-repository",
16       "imageTag": "my-image-tag",
17       "isCicdEnforced": true,
18       "isDagDeployEnabled": true,
19       "name": "My deployment",
20       "namespace": "weightless-diameter-8927",
21       "organizationId": "clmh59gt0000308lbgswe5fvh",
22       "runtimeVersion": "9.1.0",
23       "schedulerCpu": "1",
24       "schedulerMemory": "1Gi",
25       "schedulerReplicas": 1,
26       "status": "CREATING",
27       "updatedAt": "2022-11-22T04:37:12Z",
28       "updatedBy": {
29         "id": "clm8qv74h000008mlf08scq7k",
30         "apiTokenName": "my-token",
31         "avatarUrl": "https://avatar.url",
32         "fullName": "Jane Doe",
33         "username": "user1@company.com"
34       },
35       "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
36       "webServerCpu": "0.5",
37       "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
38       "webServerMemory": "0.5Gi",
39       "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
40       "workspaceId": "clmh58o7d000108lb74ktc9o64",
41       "cloudProvider": "AWS",
42       "clusterId": "clmh597sg000208lb2kjhcn8q",
43       "clusterName": "my cluster",
44       "contactEmails": [
45         "user1@company.com"
46       ],
47       "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
48       "defaultTaskPodCpu": "0.5",
49       "defaultTaskPodMemory": "1Gi",
50       "description": "My deployment description",
51       "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z",
52       "environmentVariables": [
53         {
54           "isSecret": true,
55           "key": "my-var",
56           "updatedAt": "2022-11-22T04:37:12Z",
57           "value": "my-var-value"
58         }
59       ],
60       "executor": "CELERY",
61       "externalIPs": [
62         "0.0.0.0"
63       ],
64       "imageVersion": "deploy-2023-09-14T19-04",
65       "isDevelopmentMode": true,
66       "isHighAvailability": true,
67       "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
68       "region": "us-east-1",
69       "resourceQuotaCpu": "160",
70       "resourceQuotaMemory": "320Gi",
71       "schedulerAu": 5,
72       "schedulerSize": "SMALL",
73       "statusReason": "Successfully Deployed",
74       "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
75       "type": "DEDICATED",
76       "webServerReplicas": 1,
77       "workerQueues": [
78         {
79           "id": "clmh9vsuf000908midngba9mw",
80           "isDefault": true,
81           "maxWorkerCount": 10,
82           "minWorkerCount": 1,
83           "name": "default",
84           "podCpu": "1",
85           "podMemory": "2Gi",
86           "workerConcurrency": 20,
87           "astroMachine": "A5",
88           "nodePoolId": "clmh9yjcn000a08mi8dsgbno9"
89         }
90       ],
91       "workloadIdentity": "workloadIdentity",
92       "workspaceName": "my-workspace"
93     }
94   ],
95   "limit": 10,
96   "offset": 0,
97   "totalCount": 100
98 }

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	"createdAt": "2022-11-22T04:37:12Z",
7	"createdBy": {
8	"id": "clm8qv74h000008mlf08scq7k",
9	"apiTokenName": "my-token",
10	"avatarUrl": "https://avatar.url",
11	"fullName": "Jane Doe",
12	"username": "user1@company.com"
13	},
14	"id": "clmh57jtm000008lb58fe2wmv",
15	"imageRepository": "https://my-image-repository",
16	"imageTag": "my-image-tag",
17	"isCicdEnforced": true,
18	"isDagDeployEnabled": true,
19	"name": "My deployment",
20	"namespace": "weightless-diameter-8927",
21	"organizationId": "clmh59gt0000308lbgswe5fvh",
22	"runtimeVersion": "9.1.0",
23	"schedulerCpu": "1",
24	"schedulerMemory": "1Gi",
25	"schedulerReplicas": 1,
26	"status": "CREATING",
27	"updatedAt": "2022-11-22T04:37:12Z",
28	"updatedBy": {
29	"id": "clm8qv74h000008mlf08scq7k",
30	"apiTokenName": "my-token",
31	"avatarUrl": "https://avatar.url",
32	"fullName": "Jane Doe",
33	"username": "user1@company.com"
34	},
35	"webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1",
36	"webServerCpu": "0.5",
37	"webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv",
38	"webServerMemory": "0.5Gi",
39	"webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5",
40	"workspaceId": "clmh58o7d000108lb74ktc9o64",
41	"cloudProvider": "AWS",
42	"clusterId": "clmh597sg000208lb2kjhcn8q",
43	"clusterName": "my cluster",
44	"contactEmails": [
45	"user1@company.com"
46	],
47	"dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
48	"defaultTaskPodCpu": "0.5",
49	"defaultTaskPodMemory": "1Gi",
50	"description": "My deployment description",
51	"desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z",
52	"environmentVariables": [
53	{
54	"isSecret": true,
55	"key": "my-var",
56	"updatedAt": "2022-11-22T04:37:12Z",
57	"value": "my-var-value"
58	}
59	],
60	"executor": "CELERY",
61	"externalIPs": [
62	"0.0.0.0"
63	],
64	"imageVersion": "deploy-2023-09-14T19-04",
65	"isDevelopmentMode": true,
66	"isHighAvailability": true,
67	"oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/",
68	"region": "us-east-1",
69	"resourceQuotaCpu": "160",
70	"resourceQuotaMemory": "320Gi",
71	"schedulerAu": 5,
72	"schedulerSize": "SMALL",
73	"statusReason": "Successfully Deployed",
74	"taskPodNodePoolId": "clmh5mash000008mia6lnbs0f",
75	"type": "DEDICATED",
76	"webServerReplicas": 1,
77	"workerQueues": [
78	{
79	"id": "clmh9vsuf000908midngba9mw",
80	"isDefault": true,
81	"maxWorkerCount": 10,
82	"minWorkerCount": 1,
83	"name": "default",
84	"podCpu": "1",
85	"podMemory": "2Gi",
86	"workerConcurrency": 20,
87	"astroMachine": "A5",
88	"nodePoolId": "clmh9yjcn000a08mi8dsgbno9"
89	}
90	],
91	"workloadIdentity": "workloadIdentity",
92	"workspaceName": "my-workspace"
93	}
94	],
95	"limit": 10,
96	"offset": 0,
97	"totalCount": 100
98	}