Get environment object

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

{
  "objectKey": "prod_db_connection",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "scopeEntityId": "workspace-1234abcd5678efgh",
  "airflowVariable": {
    "isSecret": true,
    "value": ""
  },
  "autoLinkDeployments": true,
  "connection": {
    "type": "Postgres",
    "connectionAuthType": {
      "airflowType": "basic",
      "authMethodName": "Basic Authentication",
      "description": "Standard HTTP Basic Authentication",
      "id": "auth-basic-001",
      "name": "Basic Auth",
      "parameters": [
        {
          "airflowParamName": "username",
          "dataType": "string",
          "description": "The username for authentication",
          "friendlyName": "Username",
          "isInExtra": false,
          "isRequired": true,
          "isSecret": false,
          "example": "admin_user",
          "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": {
      "timeout": 30,
      "retries": 3
    },
    "host": "db.example.com",
    "login": "dbadmin",
    "password": "securePass123!",
    "port": 5432,
    "schema": "public"
  },
  "createdAt": "2024-05-20T10:15:30Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deployment-service-token",
    "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "jane.doe@astronomer.io"
  },
  "excludeLinks": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "dep-1234567890abcdef"
    }
  ],
  "id": "envobj-9876543210abcdef",
  "links": [
    {
      "scope": "DEPLOYMENT",
      "scopeEntityId": "dep-abcdef1234567890",
      "airflowVariableOverrides": {
        "value": "override_value_123"
      },
      "connectionOverrides": {
        "extra": {
          "sslmode": "require"
        },
        "host": "override-db.example.com",
        "login": "override_user",
        "password": "OverridePass!2024",
        "port": 5433,
        "schema": "override_schema",
        "type": "Postgres"
      },
      "metricsExportOverrides": {
        "authType": "BASIC",
        "basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
        "endpoint": "https://metrics.example.com/api/v1/metrics",
        "exporterType": "PROMETHEUS",
        "headers": {
          "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
        },
        "labels": {
          "env": "staging",
          "team": "data-engineering"
        },
        "password": "metricsPass2024",
        "username": "metricsUser"
      }
    }
  ],
  "metricsExport": {
    "endpoint": "https://metrics.astronomer.io/prometheus",
    "exporterType": "PROMETHEUS",
    "authType": "BASIC",
    "basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "labels": {
      "environment": "production",
      "service": "airflow"
    },
    "password": "prodMetricsPass!",
    "username": "metricsAdmin"
  },
  "sourceScope": "WORKSPACE",
  "sourceScopeEntityId": "workspace-1234abcd5678efgh",
  "updatedAt": "2024-06-01T08:45:00Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7l",
    "apiTokenName": "update-service-token",
    "avatarUrl": "https://avatars.astronomer.io/users/johndoe.png",
    "fullName": "John Doe",
    "subjectType": "USER",
    "username": "john.doe@astronomer.io"
  }
}

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

Authentication

Path parameters

Response

Errors

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

1	{
2	"objectKey": "prod_db_connection",
3	"objectType": "CONNECTION",
4	"scope": "WORKSPACE",
5	"scopeEntityId": "workspace-1234abcd5678efgh",
6	"airflowVariable": {
7	"isSecret": true,
8	"value": ""
9	},
10	"autoLinkDeployments": true,
11	"connection": {
12	"type": "Postgres",
13	"connectionAuthType": {
14	"airflowType": "basic",
15	"authMethodName": "Basic Authentication",
16	"description": "Standard HTTP Basic Authentication",
17	"id": "auth-basic-001",
18	"name": "Basic Auth",
19	"parameters": [
20	{
21	"airflowParamName": "username",
22	"dataType": "string",
23	"description": "The username for authentication",
24	"friendlyName": "Username",
25	"isInExtra": false,
26	"isRequired": true,
27	"isSecret": false,
28	"example": "admin_user",
29	"pattern": "^[a-zA-Z0-9_]+$"
30	},
31	{
32	"airflowParamName": "password",
33	"dataType": "string",
34	"description": "The password for authentication",
35	"friendlyName": "Password",
36	"isInExtra": false,
37	"isRequired": true,
38	"isSecret": true,
39	"example": "P@ssw0rd!",
40	"pattern": "^.{8,}$"
41	}
42	],
43	"providerPackageName": "apache-airflow-providers-http",
44	"guidePath": "https://docs.astronomer.io/auth/basic-auth",
45	"providerLogo": "https://assets.astronomer.io/logos/basic-auth.png"
46	},
47	"extra": {
48	"timeout": 30,
49	"retries": 3
50	},
51	"host": "db.example.com",
52	"login": "dbadmin",
53	"password": "securePass123!",
54	"port": 5432,
55	"schema": "public"
56	},
57	"createdAt": "2024-05-20T10:15:30Z",
58	"createdBy": {
59	"id": "clm8qv74h000008mlf08scq7k",
60	"apiTokenName": "deployment-service-token",
61	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
62	"fullName": "Jane Doe",
63	"subjectType": "USER",
64	"username": "jane.doe@astronomer.io"
65	},
66	"excludeLinks": [
67	{
68	"scope": "DEPLOYMENT",
69	"scopeEntityId": "dep-1234567890abcdef"
70	}
71	],
72	"id": "envobj-9876543210abcdef",
73	"links": [
74	{
75	"scope": "DEPLOYMENT",
76	"scopeEntityId": "dep-abcdef1234567890",
77	"airflowVariableOverrides": {
78	"value": "override_value_123"
79	},
80	"connectionOverrides": {
81	"extra": {
82	"sslmode": "require"
83	},
84	"host": "override-db.example.com",
85	"login": "override_user",
86	"password": "OverridePass!2024",
87	"port": 5433,
88	"schema": "override_schema",
89	"type": "Postgres"
90	},
91	"metricsExportOverrides": {
92	"authType": "BASIC",
93	"basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
94	"endpoint": "https://metrics.example.com/api/v1/metrics",
95	"exporterType": "PROMETHEUS",
96	"headers": {
97	"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
98	},
99	"labels": {
100	"env": "staging",
101	"team": "data-engineering"
102	},
103	"password": "metricsPass2024",
104	"username": "metricsUser"
105	}
106	}
107	],
108	"metricsExport": {
109	"endpoint": "https://metrics.astronomer.io/prometheus",
110	"exporterType": "PROMETHEUS",
111	"authType": "BASIC",
112	"basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
113	"headers": {
114	"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
115	},
116	"labels": {
117	"environment": "production",
118	"service": "airflow"
119	},
120	"password": "prodMetricsPass!",
121	"username": "metricsAdmin"
122	},
123	"sourceScope": "WORKSPACE",
124	"sourceScopeEntityId": "workspace-1234abcd5678efgh",
125	"updatedAt": "2024-06-01T08:45:00Z",
126	"updatedBy": {
127	"id": "clm8qv74h000008mlf08scq7l",
128	"apiTokenName": "update-service-token",
129	"avatarUrl": "https://avatars.astronomer.io/users/johndoe.png",
130	"fullName": "John Doe",
131	"subjectType": "USER",
132	"username": "john.doe@astronomer.io"
133	}
134	}