How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Astronomer Deployment API

The `deployment` object represents an Astro Deployment, which is a hosted Airflow environment that is powered by all core Airflow components, including schedulers and workers. Make requests to the `deployment` object to create, update, or delete a Deployment or its computational resources. See [Deployment settings](https://astronomer.io/docs/astro/deployment-settings).

Astronomer Deployment API is one of 15 APIs that Astronomer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a getting-started guide, and authentication docs.

This API exposes 8 operations across 4 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1.0.

Requests are made against a single base URL, https://api.astronomer.io/v1.

8 operations 4 paths 35 schemas 2 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.0
Base URL
https://api.astronomer.io/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Astronomer Deployment API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT). By default, every request must be authenticated.

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Deployment 8

The deployment object represents an Astro Deployment, which is a hosted Airflow environment that is powered by all core Airflow components, including schedulers and workers. Make…

GET
/organizations/{organizationId}/deployments
List Deployments
ListDeployments 7 params → 200400401403500
POST
/organizations/{organizationId}/deployments
Create a Deployment
CreateDeployment 1 param body → 200400401403500
DELETE
/organizations/{organizationId}/deployments/{deploymentId}
Delete a Deployment
DeleteDeployment 2 params → 204400401403404500
GET
/organizations/{organizationId}/deployments/{deploymentId}
Get a Deployment
GetDeployment 2 params → 200400401403404500
POST
/organizations/{organizationId}/deployments/{deploymentId}
Update a Deployment
UpdateDeployment 2 params body → 200400401403404500
DELETE
/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override
Delete a hibernation override for a deployment
DeleteDeploymentHibernationOverride 2 params → 4XX5XX204
POST
/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override
Configure a hibernation override for a deployment
UpdateDeploymentHibernationOverride 2 params body → 4XX5XX200
GET
/organizations/{organizationId}/deployments/{deploymentId}/logs
Get Deployment logs
GetDeploymentLogs 11 params → 200400401403500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Deployment (61 properties), CreateStandardDeploymentRequest (25 properties), CreateDedicatedDeploymentRequest (23 properties), UpdateStandardDeploymentRequest (21 properties). Each schema is shown below with its type and property counts.

UpdateWorkerQueueRequest
object
9 properties 5 required
CreateStandardDeploymentRequest
object
25 properties 2 required
WorkerQueueRequest
object
8 properties 6 required
FieldValidationError
object
3 properties 3 required
DeploymentHibernationOverrideRequest
object
2 properties
Deployment
object
61 properties 27 required
WorkerQueue
object
11 properties 8 required
DeploymentHibernationOverride
object
3 properties
DeploymentHibernationSpecRequest
object
2 properties
DeploymentHibernationSchedule
object
4 properties 3 required
OverrideDeploymentHibernationBody
object
2 properties 1 required
Error
object
4 properties 3 required
DeploymentRemoteExecutionRequest
object
4 properties 1 required
DeploymentHibernationSpec
object
2 properties
UpdateDeploymentRequest
object
CreateDeploymentRequest
object
DeploymentScalingSpecRequest
object
1 property
DeploymentScalingSpec
object
1 property
HybridWorkerQueueRequest
object
7 properties 6 required
DeploymentHibernationStatus
object
4 properties 1 required
DeploymentEnvironmentVariable
object
4 properties 3 required
DeploymentsPaginated
object
4 properties 4 required
UpdateDedicatedDeploymentRequest
object
21 properties 9 required
CreateDeploymentInstanceSpecRequest
object
2 properties
BasicSubjectProfile
object
6 properties 1 required
DeploymentLog
object
6 properties 6 required
DeploymentScalingStatus
object
1 property
CreateHybridDeploymentRequest
object
16 properties 2 required
DeploymentEnvironmentVariableRequest
object
3 properties 2 required
CreateDedicatedDeploymentRequest
object
23 properties 2 required
UpdateHybridDeploymentRequest
object
14 properties 8 required
DeploymentLogEntry
object
3 properties 3 required
UpdateDeploymentInstanceSpecRequest
object
2 properties 2 required
DeploymentRemoteExecution
object
5 properties 3 required
UpdateStandardDeploymentRequest
object
21 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

astronomer-deployment-api-openapi.yml Raw ↑

Other APIs Astronomer publishes across the network.

Astronomer AgentToken API
Astronomer AllowedIpAddressRange API
Astronomer ApiToken API
Astronomer Authorization API
Astronomer Cluster API
Astronomer Deploy API
Astronomer Environment API
Astronomer Invite API
Astronomer Options API
Astronomer Organization API
Astronomer Role API
Astronomer Team API
Where this information came from

This is an independent, third-party profile of Astronomer Deployment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.