Get environment object

1 curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/environment-objects/environmentObjectId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "airflowVariable": { 3 "isSecret": false, 4 "value": "value" 5 }, 6 "autoLinkDeployments": false, 7 "connection": { 8 "connectionAuthType": { 9 "airflowType": "airflowType", 10 "authMethodName": "authMethodName", 11 "description": "description", 12 "guidePath": "guidePath", 13 "id": "id", 14 "name": "name", 15 "parameters": [ 16 { 17 "airflowParamName": "airflowParamName", 18 "dataType": "dataType", 19 "description": "description", 20 "example": "example", 21 "friendlyName": "friendlyName", 22 "isInExtra": false, 23 "isRequired": false, 24 "isSecret": false 25 } 26 ], 27 "providerLogo": "providerLogo", 28 "providerPackageName": "providerPackageName" 29 }, 30 "extra": {}, 31 "host": "host", 32 "login": "login", 33 "password": "password", 34 "port": 0, 35 "schema": "schema", 36 "type": "type" 37 }, 38 "createdAt": "createdAt", 39 "createdBy": { 40 "apiTokenName": "my-token", 41 "avatarUrl": "https://avatar.url", 42 "fullName": "Jane Doe", 43 "id": "clm8qv74h000008mlf08scq7k", 44 "subjectType": "USER", 45 "username": "user1@company.com" 46 }, 47 "excludeLinks": [ 48 { 49 "scope": "DEPLOYMENT", 50 "scopeEntityId": "scopeEntityId" 51 } 52 ], 53 "id": "id", 54 "links": [ 55 { 56 "airflowVariableOverrides": { 57 "value": "value" 58 }, 59 "connectionOverrides": { 60 "extra": {}, 61 "host": "host", 62 "login": "login", 63 "password": "password", 64 "port": 0, 65 "schema": "schema", 66 "type": "type" 67 }, 68 "metricsExportOverrides": { 69 "basicToken": "basicToken", 70 "endpoint": "endpoint", 71 "exporterType": "PROMETHEUS", 72 "headers": {}, 73 "labels": {}, 74 "password": "password", 75 "username": "username" 76 }, 77 "scope": "DEPLOYMENT", 78 "scopeEntityId": "scopeEntityId" 79 } 80 ], 81 "metricsExport": { 82 "basicToken": "basicToken", 83 "endpoint": "endpoint", 84 "exporterType": "PROMETHEUS", 85 "headers": {}, 86 "labels": {}, 87 "password": "password", 88 "username": "username" 89 }, 90 "objectKey": "objectKey", 91 "objectType": "CONNECTION", 92 "scope": "WORKSPACE", 93 "scopeEntityId": "scopeEntityId", 94 "sourceScope": "WORKSPACE", 95 "sourceScopeEntityId": "sourceScopeEntityId", 96 "updatedAt": "updatedAt", 97 "updatedBy": { 98 "apiTokenName": "my-token", 99 "avatarUrl": "https://avatar.url", 100 "fullName": "Jane Doe", 101 "id": "clm8qv74h000008mlf08scq7k", 102 "subjectType": "USER", 103 "username": "user1@company.com" 104 } 105 }

Retrieve details about an environment object.

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

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 or null

autoLinkDeploymentsboolean or null

Whether or not to automatically link Deployments to the environment object

connectionobject or null

createdAtstring or null

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

createdByobject or null

excludeLinkslist of objects or null

The excluded links for the environment object

idstring or null

The ID of the environment object

linkslist of objects or null

The Deployments linked to the environment object

metricsExportobject or null

sourceScopeenum or null

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

Allowed values:

sourceScopeEntityIdstring or null

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

updatedAtstring or null

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

updatedByobject or null

Path parameters

Headers

Response

Errors