Get environment object | Astronomer Documentation

{
  "objectKey": "objectKey",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "scopeEntityId": "scopeEntityId",
  "setFields": [
    "setFields"
  ],
  "airflowVariable": {
    "isSecret": true,
    "value": "value"
  },
  "autoLinkDeployments": true,
  "connection": {
    "type": "type",
    "connectionAuthType": {
      "airflowType": "airflowType",
      "authMethodName": "authMethodName",
      "description": "description",
      "id": "id",
      "name": "name",
      "parameters": [
        {
          "airflowParamName": "airflowParamName",
          "dataType": "dataType",
          "description": "description",
          "friendlyName": "friendlyName",
          "isInExtra": true,
          "isRequired": true,
          "isSecret": true
        }
      ],
      "providerPackageName": "providerPackageName",
      "guidePath": "guidePath",
      "providerLogo": "providerLogo"
    },
    "extra": {
      "key": "value"
    },
    "host": "host",
    "login": "login",
    "password": "password",
    "port": 1,
    "schema": "schema"
  },
  "createdAt": "createdAt",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "description": "description",
  "environmentVariable": {
    "isSecret": true,
    "value": "value"
  },
  "excludeLinks": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "scopeEntityId"
    }
  ],
  "id": "id",
  "links": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "scopeEntityId",
      "setFields": [
        "setFields"
      ],
      "airflowVariableOverrides": {
        "value": "value"
      },
      "environmentVariableOverrides": {
        "value": "value"
      }
    }
  ],
  "metricsExport": {
    "endpoint": "endpoint",
    "exporterType": "PROMETHEUS",
    "authType": "BASIC",
    "basicToken": "basicToken",
    "headers": {
      "key": "value"
    },
    "labels": {
      "key": "value"
    },
    "password": "password",
    "sigV4AssumeArn": "sigV4AssumeArn",
    "sigV4StsRegion": "sigV4StsRegion",
    "username": "username"
  },
  "sourceScope": "WORKSPACE",
  "sourceScopeEntityId": "sourceScopeEntityId",
  "updatedAt": "updatedAt",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

Retrieve details about an environment object.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to which the environment object belongs.

environmentObjectIdstringRequired

The environment object's ID.

Response

objectKeystring

The key for the environment object

objectTypeenum

The type of environment object

scopeenum

The scope of the environment object

scopeEntityIdstring

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

setFieldslist of strings

Names of fields that have a value set on the environment object. Secret values are masked in responses, so this list lets clients tell a set secret from an unset field. Map members appear as dotted paths (for example “extra.aws_secret”)

airflowVariableobjectOptional

autoLinkDeploymentsbooleanOptional

Whether or not to automatically link Deployments to the environment object

connectionobjectOptional

createdAtstringOptional

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

createdByobjectOptional

descriptionstringOptional

The description of the environment object

environmentVariableobjectOptional

excludeLinkslist of objectsOptional

The excluded links for the environment object

idstringOptional

The ID of the environment object

linkslist of objectsOptional

The Deployments linked to the environment object

metricsExportobjectOptional

sourceScopeenumOptional

The source scope of the environment object, if it is resolved from a link

sourceScopeEntityIdstringOptional

The source scope entity ID of the environment object, if it is resolved from a link

updatedAtstringOptional

The time when the environment object was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

updatedByobjectOptional

Errors

401

Get Environment Object Request Unauthorized Error

403

Get Environment Object Request Forbidden Error

404

Get Environment Object Request Not Found Error

405

Get Environment Object Request Method Not Allowed Error

500

Get Environment Object Request Internal Server Error

$	curl https://api.astronomer.io/v1/organizations/organizationId/environment-objects/environmentObjectId \
>	-H "Authorization: Bearer <token>"