List environment objects

GET

https://api.astronomer.io/v1/organizations/:organizationId/environment-objects

GET

/v1/organizations/:organizationId/environment-objects

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

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

List environment objects in a Workspace or Deployment.

List environment objects

Authentication

Path parameters

Query parameters

Response

Errors

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

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