Deploy rollback of a deployment

Path parameters

organizationIdstringRequired

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

deploymentIdstringRequired

The Deployment’s ID.

deployIdstringRequired

The Deploy’s ID.

Request

This endpoint expects an object.

descriptionstringOptional<=500 characters

Response

createdAtdatetime

The time when the deploy was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

deploymentIdstring

The Deployment’s ID.

idstring

The deploy’s ID.

imageRepositorystring

The URL of the deploy’s image repository.

imageTagstring

The deploy’s image tag. Appears only if specified in the most recent deploy.

isDagDeployEnabledboolean

Whether the deploy was triggered on a Deployment with DAG deploys enabled.

statusenum

Allowed values: INITIALIZEDDEPLOYEDFAILED

The status of the deploy.

typeenum

Allowed values: IMAGE_AND_DAGIMAGE_ONLYDAG_ONLY

The type of deploy.

airflowVersionstringOptional

The deploy’s Airflow version.

astroRuntimeVersionstringOptional

The deploy’s Astro Runtime version.

bundleMountPathstringOptional

The path where Astro mounts the bundle on the Airflow component pods.

bundleUploadUrlstringOptional

The URL where the deploy uploads the bundle. Appears only if DAG deploys are enabled on the Deployment and deploy type is BUNDLE.

bundleslist of objectsOptional

The bundles included in a specific Deployment.

createdBySubjectobjectOptional

dagTarballVersionstringOptional

The deploy’s DAG tarball version, also known as the Bundle Version in the Astro UI.

dagsUploadUrlstringOptional

The deploy’s upload URL to upload DAG bundles. Appears only if dag deploys are enabled on the Deployment.

descriptionstringOptional

The deploy’s description.

rollbackFromIdstringOptional

The ID of the deploy that you completed a rollback on. Appears only if a rollback has been performed.

updatedAtdatetimeOptional

The time when the deploy was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedBySubjectobjectOptional

1 curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId/rollback \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

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

1	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId/rollback \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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