Create a new environment object | Astronomer Documentation

Create an environment object for a Deployment or Workspace. An environment object represents a connection, Airflow variable, or metrics export resource that is managed by the Astro Environment Manager.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization in which to create the environment object.

Request

The request body for creating a new environment object.

objectKeystringRequired

The key for the environment object

objectTypeenumRequired

The type of environment object

Allowed values:

scopeenumRequired

The scope of the environment object

Allowed values:

scopeEntityIdstringRequired

The ID of the scope entity where the environment object is created

airflowVariableobjectOptional

autoLinkDeploymentsbooleanOptional

Whether or not to automatically link Deployments to the environment object. Only applicable for WORKSPACE scope

connectionobjectOptional

excludeLinkslist of objectsOptional

The links to exclude from the environment object. Only applicable for WORKSPACE scope

linkslist of objectsOptional

The Deployments that Astro links to the environment object. Only applicable for WORKSPACE scope

metricsExportobjectOptional

Response

idstring

The ID of the environment object

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

500

Internal Server Error

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

The ID of the Organization in which to create the environment object.

The request body for creating a new environment object.

The key for the environment object

The type of environment object

The scope of the environment object

The ID of the scope entity where the environment object is created

Whether or not to automatically link Deployments to the environment object. Only applicable for WORKSPACE scope

The links to exclude from the environment object. Only applicable for WORKSPACE scope

The Deployments that Astro links to the environment object. Only applicable for WORKSPACE scope

The ID of the environment object

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/environment-objects \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"objectKey": "prod_postgres_db",
>	"objectType": "CONNECTION",
>	"scope": "WORKSPACE",
>	"scopeEntityId": "workspace_12345"
>	}'

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/environment-objects \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"objectKey": "prod_postgres_db",
>	"objectType": "CONNECTION",
>	"scope": "WORKSPACE",
>	"scopeEntityId": "workspace_12345"
>	}'