Create a new environment object

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.

POST /organizations/{organizationId}/environment-objects

Create a new environment object

cURL

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}/environment-objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "objectKey": "<string>",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "scopeEntityId": "<string>",
  "airflowVariable": {
    "isSecret": true,
    "value": "<string>"
  },
  "autoLinkDeployments": true,
  "excludeLinks": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "<string>"
    }
  ],
  "links": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "<string>",
      "overrides": {
        "airflowVariable": {
          "value": "<string>"
        },
        "connection": {
          "extra": {},
          "host": "<string>",
          "login": "<string>",
          "password": "<string>",
          "port": 123,
          "schema": "<string>",
          "type": "<string>"
        },
        "metricsExport": {
          "authType": "BASIC",
          "basicToken": "<string>",
          "endpoint": "<string>",
          "exporterType": "PROMETHEUS",
          "headers": {},
          "labels": {},
          "password": "<string>",
          "username": "<string>"
        }
      }
    }
  ]
}
'

200

{
  "id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

organizationId · string · required

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

Body

application/json

The request body for creating a new environment object.

objectKey · string · required

The key for the environment object

objectType · enum<string> · required

The type of environment object

Available options: CONNECTION, AIRFLOW_VARIABLE, METRICS_EXPORT

scope · enum<string> · required

The scope of the environment object

Available options: WORKSPACE, DEPLOYMENT

scopeEntityId · string · required

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

airflowVariable · object

Show child attributes

autoLinkDeployments · boolean

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

connection · object

Show child attributes

excludeLinks · object[]

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

Show child attributes

links · object[]

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

Show child attributes

metricsExport · object

Show child attributes

Response

200

application/json

OK

id · string · required

The ID of the environment object