Update an environment object

POST

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

POST

/v1/organizations/:organizationId/environment-objects/:environmentObjectId

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

1 {
2   "objectKey": "my_database_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": "http",
15       "authMethodName": "BasicAuth",
16       "description": "Basic authentication using username and password",
17       "id": "auth-basic-001",
18       "name": "Basic Authentication",
19       "parameters": [
20         {
21           "airflowParamName": "login",
22           "dataType": "string",
23           "description": "Username for authentication",
24           "friendlyName": "Username",
25           "isInExtra": false,
26           "isRequired": true,
27           "isSecret": false,
28           "example": "user123",
29           "pattern": "^[a-zA-Z0-9_]+$"
30         },
31         {
32           "airflowParamName": "password",
33           "dataType": "string",
34           "description": "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": "/docs/connections/http#basicauth",
45       "providerLogo": "https://assets.astronomer.io/logos/http.svg"
46     },
47     "extra": {},
48     "host": "db.example.com",
49     "login": "dbuser",
50     "password": "securepassword123",
51     "port": 5432,
52     "schema": "public"
53   },
54   "createdAt": "2024-06-01T12:00:00Z",
55   "createdBy": {
56     "id": "clm8qv74h000008mlf08scq7k",
57     "apiTokenName": "deployment-token",
58     "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
59     "fullName": "Jane Doe",
60     "subjectType": "USER",
61     "username": "jane.doe@astronomer.io"
62   },
63   "excludeLinks": [
64     {
65       "scope": "DEPLOYMENT",
66       "scopeEntityId": "dep-1234567890abcdef"
67     }
68   ],
69   "id": "envobj-9876543210fedcba",
70   "links": [
71     {
72       "scope": "DEPLOYMENT",
73       "scopeEntityId": "dep-abcdef1234567890",
74       "airflowVariableOverrides": {
75         "value": "override_value_123"
76       },
77       "connectionOverrides": {
78         "extra": {},
79         "host": "override-db.example.com",
80         "login": "overrideuser",
81         "password": "overridepassword456",
82         "port": 5433,
83         "schema": "override_schema",
84         "type": "postgres"
85       },
86       "metricsExportOverrides": {
87         "authType": "BASIC",
88         "basicToken": "overrideBearerToken123",
89         "endpoint": "https://metrics.override.example.com/metrics",
90         "exporterType": "PROMETHEUS",
91         "headers": {},
92         "labels": {},
93         "password": "overridePass",
94         "username": "overrideUser"
95       }
96     }
97   ],
98   "metricsExport": {
99     "endpoint": "https://metrics.astronomer.io/metrics",
100     "exporterType": "PROMETHEUS",
101     "authType": "BASIC",
102     "basicToken": "BearerToken123456",
103     "headers": {},
104     "labels": {},
105     "password": "metricsPass123",
106     "username": "metricsUser"
107   },
108   "sourceScope": "WORKSPACE",
109   "sourceScopeEntityId": "workspace-1234abcd5678efgh",
110   "updatedAt": "2024-06-15T15:30:00Z",
111   "updatedBy": {
112     "id": "clm8qv74h000008mlf08scq7k",
113     "apiTokenName": "deployment-token",
114     "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
115     "fullName": "Jane Doe",
116     "subjectType": "USER",
117     "username": "jane.doe@astronomer.io"
118   }
119 }

Update an existing Deployment level or Workspace level 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.

Request

The request body for updating an environment object.

airflowVariableobjectOptional

autoLinkDeploymentsbooleanOptional

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

connectionobjectOptional

excludeLinkslist of objectsOptional

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

linkslist of objectsOptional

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

metricsExportobjectOptional

Response

objectKeystring

The key for the environment object

objectTypeenum

The type of environment object

Allowed values:

scopeenum

The scope of the environment object

Allowed values:

scopeEntityIdstring

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

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

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

Allowed values:

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

409

Conflict Error

500

Internal Server Error

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

1	{
2	"objectKey": "my_database_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": "http",
15	"authMethodName": "BasicAuth",
16	"description": "Basic authentication using username and password",
17	"id": "auth-basic-001",
18	"name": "Basic Authentication",
19	"parameters": [
20	{
21	"airflowParamName": "login",
22	"dataType": "string",
23	"description": "Username for authentication",
24	"friendlyName": "Username",
25	"isInExtra": false,
26	"isRequired": true,
27	"isSecret": false,
28	"example": "user123",
29	"pattern": "^[a-zA-Z0-9_]+$"
30	},
31	{
32	"airflowParamName": "password",
33	"dataType": "string",
34	"description": "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": "/docs/connections/http#basicauth",
45	"providerLogo": "https://assets.astronomer.io/logos/http.svg"
46	},
47	"extra": {},
48	"host": "db.example.com",
49	"login": "dbuser",
50	"password": "securepassword123",
51	"port": 5432,
52	"schema": "public"
53	},
54	"createdAt": "2024-06-01T12:00:00Z",
55	"createdBy": {
56	"id": "clm8qv74h000008mlf08scq7k",
57	"apiTokenName": "deployment-token",
58	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
59	"fullName": "Jane Doe",
60	"subjectType": "USER",
61	"username": "jane.doe@astronomer.io"
62	},
63	"excludeLinks": [
64	{
65	"scope": "DEPLOYMENT",
66	"scopeEntityId": "dep-1234567890abcdef"
67	}
68	],
69	"id": "envobj-9876543210fedcba",
70	"links": [
71	{
72	"scope": "DEPLOYMENT",
73	"scopeEntityId": "dep-abcdef1234567890",
74	"airflowVariableOverrides": {
75	"value": "override_value_123"
76	},
77	"connectionOverrides": {
78	"extra": {},
79	"host": "override-db.example.com",
80	"login": "overrideuser",
81	"password": "overridepassword456",
82	"port": 5433,
83	"schema": "override_schema",
84	"type": "postgres"
85	},
86	"metricsExportOverrides": {
87	"authType": "BASIC",
88	"basicToken": "overrideBearerToken123",
89	"endpoint": "https://metrics.override.example.com/metrics",
90	"exporterType": "PROMETHEUS",
91	"headers": {},
92	"labels": {},
93	"password": "overridePass",
94	"username": "overrideUser"
95	}
96	}
97	],
98	"metricsExport": {
99	"endpoint": "https://metrics.astronomer.io/metrics",
100	"exporterType": "PROMETHEUS",
101	"authType": "BASIC",
102	"basicToken": "BearerToken123456",
103	"headers": {},
104	"labels": {},
105	"password": "metricsPass123",
106	"username": "metricsUser"
107	},
108	"sourceScope": "WORKSPACE",
109	"sourceScopeEntityId": "workspace-1234abcd5678efgh",
110	"updatedAt": "2024-06-15T15:30:00Z",
111	"updatedBy": {
112	"id": "clm8qv74h000008mlf08scq7k",
113	"apiTokenName": "deployment-token",
114	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
115	"fullName": "Jane Doe",
116	"subjectType": "USER",
117	"username": "jane.doe@astronomer.io"
118	}
119	}