List deploys for a deployment | Astronomer Documentation

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

{
  "deploys": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "deploymentId": "clmh57jtm000008lb58fe2wmv",
      "id": "clvetru2w000201mowqwua63n",
      "imageRepository": "https://my-image-repository",
      "imageTag": "my-image-tag",
      "isDagDeployEnabled": true,
      "status": "DEPLOYED",
      "type": "IMAGE_AND_DAG",
      "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
      "astroRuntimeVersion": "9.1.0",
      "bundleMountPath": "string",
      "bundleUploadUrl": "string",
      "bundles": [
        {
          "bundleType": "string",
          "deployId": "string",
          "mountPath": "string",
          "currentVersion": "string",
          "desiredVersion": "string"
        }
      ],
      "createdBySubject": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
      "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv",
      "description": "My deploy description",
      "rollbackFromId": "clvcz1lrq000101oitxtp276e",
      "updatedAt": "2022-11-22T04:37:12Z",
      "updatedBySubject": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      }
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

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

{
  "deploys": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "deploymentId": "clmh57jtm000008lb58fe2wmv",
      "id": "clvetru2w000201mowqwua63n",
      "imageRepository": "https://my-image-repository",
      "imageTag": "my-image-tag",
      "isDagDeployEnabled": true,
      "status": "DEPLOYED",
      "type": "IMAGE_AND_DAG",
      "airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
      "astroRuntimeVersion": "9.1.0",
      "bundleMountPath": "string",
      "bundleUploadUrl": "string",
      "bundles": [
        {
          "bundleType": "string",
          "deployId": "string",
          "mountPath": "string",
          "currentVersion": "string",
          "desiredVersion": "string"
        }
      ],
      "createdBySubject": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
      "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv",
      "description": "My deploy description",
      "rollbackFromId": "clvcz1lrq000101oitxtp276e",
      "updatedAt": "2022-11-22T04:37:12Z",
      "updatedBySubject": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      }
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

List deploys for a deployment

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to which the Deployment belongs.

deploymentIdstringRequired

The Deployment's ID.

Query parameters

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning values.

limitintegerOptional0-1000Defaults to 20

The maximum number of results to return.

Response

deployslist of objects

A list of deploys in the current page.

limitinteger

The maximum number of deploys in one page.

offsetinteger

The offset of the current page of deploys.

totalCountinteger

The total number of deploys.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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

1	{
2	"deploys": [
3	{
4	"createdAt": "2022-11-22T04:37:12Z",
5	"deploymentId": "clmh57jtm000008lb58fe2wmv",
6	"id": "clvetru2w000201mowqwua63n",
7	"imageRepository": "https://my-image-repository",
8	"imageTag": "my-image-tag",
9	"isDagDeployEnabled": true,
10	"status": "DEPLOYED",
11	"type": "IMAGE_AND_DAG",
12	"airflowVersion": "2.7.2, if airflow version is not found, it will return NA",
13	"astroRuntimeVersion": "9.1.0",
14	"bundleMountPath": "string",
15	"bundleUploadUrl": "string",
16	"bundles": [
17	{
18	"bundleType": "string",
19	"deployId": "string",
20	"mountPath": "string",
21	"currentVersion": "string",
22	"desiredVersion": "string"
23	}
24	],
25	"createdBySubject": {
26	"id": "clm8qv74h000008mlf08scq7k",
27	"apiTokenName": "my-token",
28	"avatarUrl": "https://avatar.url",
29	"fullName": "Jane Doe",
30	"subjectType": "USER",
31	"username": "user1@company.com"
32	},
33	"dagTarballVersion": "2024-01-12T18:32:20.5898930Z",
34	"dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv",
35	"description": "My deploy description",
36	"rollbackFromId": "clvcz1lrq000101oitxtp276e",
37	"updatedAt": "2022-11-22T04:37:12Z",
38	"updatedBySubject": {
39	"id": "clm8qv74h000008mlf08scq7k",
40	"apiTokenName": "my-token",
41	"avatarUrl": "https://avatar.url",
42	"fullName": "Jane Doe",
43	"subjectType": "USER",
44	"username": "user1@company.com"
45	}
46	}
47	],
48	"limit": 1,
49	"offset": 1,
50	"totalCount": 1
51	}