Platform API ReferenceDeploy

Create a Deploy

Create a new Deploy. A Deploy represents an intent to deploy new DAG code to an Astro Deployment.

Path parameters

organizationIdstringRequired
The ID of the Organization in which to create the Deployment.
deploymentIdstringRequired
The Deployment's ID.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
typeenumRequired
The type of deploy.
Allowed values:
bundleMountPathstringOptional
The path where Astro mounts the bundle on the Airflow component pods. Required if deploy type is BUNDLE.
bundleTypestringOptional
The type of bundle deployed. Required if deploy type is BUNDLE.
descriptionstringOptional<=500 characters
The deploy's description.

Response

OK
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
The status of the deploy.
Allowed values:
typeenum
The type of deploy.
Allowed values:
airflowVersionstring or null
The deploy's Airflow version.
astroRuntimeVersionstring or null
The deploy's Astro Runtime version.
bundleMountPathstring or null
The path where Astro mounts the bundle on the Airflow component pods.
bundleUploadUrlstring or null
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 objects or null
The bundles included in a specific Deployment.
createdBySubjectobject or null
dagTarballVersionstring or null
The deploy's DAG tarball version, also known as the Bundle Version in the Astro UI.
dagsUploadUrlstring or null
The deploy's upload URL to upload DAG bundles. Appears only if dag deploys are enabled on the Deployment.
descriptionstring or null
The deploy's description.
rollbackFromIdstring or null
The ID of the deploy that you completed a rollback on. Appears only if a rollback has been performed.
updatedAtdatetime or null

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

updatedBySubjectobject or null

Errors