Get environment object | Astronomer Documentation

{
  "objectKey": "primary_postgres_connection",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "scopeEntityId": "ws-1234567890abcdef",
  "setFields": [
    "connection.host",
    "connection.login",
    "connection.password"
  ],
  "airflowVariable": {
    "isSecret": true,
    "value": ""
  },
  "autoLinkDeployments": true,
  "connection": {
    "type": "postgres",
    "connectionAuthType": {
      "airflowType": "basic",
      "authMethodName": "BasicAuth",
      "description": "Basic authentication using username and password",
      "id": "auth-basic-001",
      "name": "Basic Authentication",
      "parameters": [
        {
          "airflowParamName": "username",
          "dataType": "string",
          "description": "The username for authentication",
          "friendlyName": "Username",
          "isInExtra": false,
          "isRequired": true,
          "isSecret": false,
          "example": "admin",
          "pattern": "^[a-zA-Z0-9_]+$"
        },
        {
          "airflowParamName": "password",
          "dataType": "string",
          "description": "The password for authentication",
          "friendlyName": "Password",
          "isInExtra": false,
          "isRequired": true,
          "isSecret": true,
          "example": "P@ssw0rd!",
          "pattern": "^.{8,}$"
        }
      ],
      "providerPackageName": "apache-airflow-providers-http",
      "guidePath": "https://docs.astronomer.io/auth/basic-auth",
      "providerLogo": "https://assets.astronomer.io/logos/basic-auth.png"
    },
    "extra": {
      "retries": 3,
      "timeout": 30
    },
    "host": "db.example.com",
    "login": "dbuser",
    "password": "********",
    "port": 5432,
    "schema": "public"
  },
  "createdAt": "2024-05-20T12:45:00Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deploy-token-01",
    "avatarUrl": "https://avatars.example.com/u/12345.png",
    "fullName": "Alice Johnson",
    "subjectType": "USER",
    "username": "alice.johnson@example.com"
  },
  "description": "Primary PostgreSQL connection for analytics database",
  "environmentVariable": {
    "isSecret": true,
    "value": ""
  },
  "excludeLinks": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "dep-987654321"
    }
  ],
  "id": "envobj-123e4567-e89b-12d3-a456-426614174000",
  "links": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "dep-123456789",
      "setFields": [
        "connectionOverrides.host",
        "environmentVariableOverrides.value"
      ],
      "airflowVariableOverrides": {
        "value": "override_value_123"
      },
      "connectionOverrides": {
        "extra": {
          "sslmode": "require"
        },
        "host": "db-override.example.com",
        "login": "override_user",
        "password": "********",
        "port": 5433,
        "schema": "analytics",
        "type": "postgres"
      },
      "environmentVariableOverrides": {
        "value": "OVERRIDE_SECRET"
      },
      "metricsExportOverrides": {
        "authType": "BASIC",
        "basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
        "endpoint": "https://metrics.example.com/prometheus",
        "exporterType": "PROMETHEUS",
        "headers": {
          "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
        },
        "labels": {
          "env": "staging",
          "team": "data-engineering"
        },
        "password": "********",
        "sigV4AssumeArn": "arn:aws:iam::123456789012:role/metrics-exporter",
        "sigV4StsRegion": "us-west-2",
        "username": "metrics_user"
      }
    }
  ],
  "metricsExport": {
    "endpoint": "https://metrics.example.com/prometheus",
    "exporterType": "PROMETHEUS",
    "authType": "BASIC",
    "basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "labels": {
      "env": "production",
      "team": "analytics"
    },
    "password": "********",
    "sigV4AssumeArn": "arn:aws:iam::123456789012:role/metrics-exporter",
    "sigV4StsRegion": "us-east-1",
    "username": "metrics_user"
  },
  "sourceScope": "WORKSPACE",
  "sourceScopeEntityId": "ws-1234567890abcdef",
  "updatedAt": "2024-06-01T08:30:00Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deploy-token-01",
    "avatarUrl": "https://avatars.example.com/u/12345.png",
    "fullName": "Alice Johnson",
    "subjectType": "USER",
    "username": "alice.johnson@example.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”)

airflowVariableobject

autoLinkDeploymentsboolean

Whether or not to automatically link Deployments to the environment object

connectionobject

createdAtstring

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

createdByobject

descriptionstring

The description of the environment object

environmentVariableobject

excludeLinkslist of objects

The excluded links for the environment object

idstring

The ID of the environment object

linkslist of objects

The Deployments linked to the environment object

metricsExportobject

sourceScopeenum

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

sourceScopeEntityIdstring

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

updatedAtstring

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

updatedByobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

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