Update an environment object
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"airflowVariable": {
"value": "<string>"
},
"autoLinkDeployments": true,
"description": "<string>",
"environmentVariable": {
"value": "<string>"
},
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"overrides": {
"airflowVariable": {
"value": "<string>"
},
"connection": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariable": {
"value": "<string>"
},
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"unsetFields": [
"<string>"
]
}
}
],
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}"
payload = {
"airflowVariable": { "value": "<string>" },
"autoLinkDeployments": True,
"description": "<string>",
"environmentVariable": { "value": "<string>" },
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"overrides": {
"airflowVariable": { "value": "<string>" },
"connection": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariable": { "value": "<string>" },
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"unsetFields": ["<string>"]
}
}
],
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
airflowVariable: {value: '<string>'},
autoLinkDeployments: true,
description: '<string>',
environmentVariable: {value: '<string>'},
excludeLinks: [{scope: 'DEPLOYMENT', scopeEntityId: '<string>'}],
links: [
{
scope: 'DEPLOYMENT',
scopeEntityId: '<string>',
overrides: {
airflowVariable: {value: '<string>'},
connection: {
extra: {},
host: '<string>',
login: '<string>',
password: '<string>',
port: 123,
schema: '<string>',
type: '<string>'
},
environmentVariable: {value: '<string>'},
metricsExport: {
basicToken: '<string>',
endpoint: '<string>',
exporterType: 'PROMETHEUS',
headers: {},
labels: {},
password: '<string>',
sigV4AssumeArn: '<string>',
sigV4StsRegion: '<string>',
username: '<string>'
},
unsetFields: ['<string>']
}
}
],
metricsExport: {
basicToken: '<string>',
endpoint: '<string>',
exporterType: 'PROMETHEUS',
headers: {},
labels: {},
password: '<string>',
sigV4AssumeArn: '<string>',
sigV4StsRegion: '<string>',
username: '<string>'
}
})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'airflowVariable' => [
'value' => '<string>'
],
'autoLinkDeployments' => true,
'description' => '<string>',
'environmentVariable' => [
'value' => '<string>'
],
'excludeLinks' => [
[
'scope' => 'DEPLOYMENT',
'scopeEntityId' => '<string>'
]
],
'links' => [
[
'scope' => 'DEPLOYMENT',
'scopeEntityId' => '<string>',
'overrides' => [
'airflowVariable' => [
'value' => '<string>'
],
'connection' => [
'extra' => [
],
'host' => '<string>',
'login' => '<string>',
'password' => '<string>',
'port' => 123,
'schema' => '<string>',
'type' => '<string>'
],
'environmentVariable' => [
'value' => '<string>'
],
'metricsExport' => [
'basicToken' => '<string>',
'endpoint' => '<string>',
'exporterType' => 'PROMETHEUS',
'headers' => [
],
'labels' => [
],
'password' => '<string>',
'sigV4AssumeArn' => '<string>',
'sigV4StsRegion' => '<string>',
'username' => '<string>'
],
'unsetFields' => [
'<string>'
]
]
]
],
'metricsExport' => [
'basicToken' => '<string>',
'endpoint' => '<string>',
'exporterType' => 'PROMETHEUS',
'headers' => [
],
'labels' => [
],
'password' => '<string>',
'sigV4AssumeArn' => '<string>',
'sigV4StsRegion' => '<string>',
'username' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}"
payload := strings.NewReader("{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"objectKey": "<string>",
"scopeEntityId": "<string>",
"setFields": [
"<string>"
],
"airflowVariable": {
"isSecret": true,
"value": "<string>"
},
"autoLinkDeployments": true,
"connection": {
"type": "<string>",
"connectionAuthType": {
"airflowType": "<string>",
"authMethodName": "<string>",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"parameters": [
{
"airflowParamName": "<string>",
"dataType": "<string>",
"description": "<string>",
"friendlyName": "<string>",
"isInExtra": true,
"isRequired": true,
"isSecret": true,
"example": "<string>",
"pattern": "<string>"
}
],
"providerPackageName": "<string>",
"guidePath": "<string>",
"providerLogo": "<string>"
},
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>"
},
"createdAt": "<string>",
"createdBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"description": "<string>",
"environmentVariable": {
"isSecret": true,
"value": "<string>"
},
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"id": "<string>",
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"setFields": [
"<string>"
],
"airflowVariableOverrides": {
"value": "<string>"
},
"connectionOverrides": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariableOverrides": {
"value": "<string>"
},
"metricsExportOverrides": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
],
"metricsExport": {
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"basicToken": "<string>",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"sourceScopeEntityId": "<string>",
"updatedAt": "<string>",
"updatedBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
}
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Environment
Update an environment object
Update an existing Deployment level or Workspace level environment object.
POST
/
organizations
/
{organizationId}
/
environment-objects
/
{environmentObjectId}
Update an environment object
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"airflowVariable": {
"value": "<string>"
},
"autoLinkDeployments": true,
"description": "<string>",
"environmentVariable": {
"value": "<string>"
},
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"overrides": {
"airflowVariable": {
"value": "<string>"
},
"connection": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariable": {
"value": "<string>"
},
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"unsetFields": [
"<string>"
]
}
}
],
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}"
payload = {
"airflowVariable": { "value": "<string>" },
"autoLinkDeployments": True,
"description": "<string>",
"environmentVariable": { "value": "<string>" },
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"overrides": {
"airflowVariable": { "value": "<string>" },
"connection": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariable": { "value": "<string>" },
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"unsetFields": ["<string>"]
}
}
],
"metricsExport": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
airflowVariable: {value: '<string>'},
autoLinkDeployments: true,
description: '<string>',
environmentVariable: {value: '<string>'},
excludeLinks: [{scope: 'DEPLOYMENT', scopeEntityId: '<string>'}],
links: [
{
scope: 'DEPLOYMENT',
scopeEntityId: '<string>',
overrides: {
airflowVariable: {value: '<string>'},
connection: {
extra: {},
host: '<string>',
login: '<string>',
password: '<string>',
port: 123,
schema: '<string>',
type: '<string>'
},
environmentVariable: {value: '<string>'},
metricsExport: {
basicToken: '<string>',
endpoint: '<string>',
exporterType: 'PROMETHEUS',
headers: {},
labels: {},
password: '<string>',
sigV4AssumeArn: '<string>',
sigV4StsRegion: '<string>',
username: '<string>'
},
unsetFields: ['<string>']
}
}
],
metricsExport: {
basicToken: '<string>',
endpoint: '<string>',
exporterType: 'PROMETHEUS',
headers: {},
labels: {},
password: '<string>',
sigV4AssumeArn: '<string>',
sigV4StsRegion: '<string>',
username: '<string>'
}
})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'airflowVariable' => [
'value' => '<string>'
],
'autoLinkDeployments' => true,
'description' => '<string>',
'environmentVariable' => [
'value' => '<string>'
],
'excludeLinks' => [
[
'scope' => 'DEPLOYMENT',
'scopeEntityId' => '<string>'
]
],
'links' => [
[
'scope' => 'DEPLOYMENT',
'scopeEntityId' => '<string>',
'overrides' => [
'airflowVariable' => [
'value' => '<string>'
],
'connection' => [
'extra' => [
],
'host' => '<string>',
'login' => '<string>',
'password' => '<string>',
'port' => 123,
'schema' => '<string>',
'type' => '<string>'
],
'environmentVariable' => [
'value' => '<string>'
],
'metricsExport' => [
'basicToken' => '<string>',
'endpoint' => '<string>',
'exporterType' => 'PROMETHEUS',
'headers' => [
],
'labels' => [
],
'password' => '<string>',
'sigV4AssumeArn' => '<string>',
'sigV4StsRegion' => '<string>',
'username' => '<string>'
],
'unsetFields' => [
'<string>'
]
]
]
],
'metricsExport' => [
'basicToken' => '<string>',
'endpoint' => '<string>',
'exporterType' => 'PROMETHEUS',
'headers' => [
],
'labels' => [
],
'password' => '<string>',
'sigV4AssumeArn' => '<string>',
'sigV4StsRegion' => '<string>',
'username' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}"
payload := strings.NewReader("{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/environment-objects/{environmentObjectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"autoLinkDeployments\": true,\n \"description\": \"<string>\",\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"excludeLinks\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"scope\": \"DEPLOYMENT\",\n \"scopeEntityId\": \"<string>\",\n \"overrides\": {\n \"airflowVariable\": {\n \"value\": \"<string>\"\n },\n \"connection\": {\n \"extra\": {},\n \"host\": \"<string>\",\n \"login\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 123,\n \"schema\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"environmentVariable\": {\n \"value\": \"<string>\"\n },\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"unsetFields\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metricsExport\": {\n \"basicToken\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"exporterType\": \"PROMETHEUS\",\n \"headers\": {},\n \"labels\": {},\n \"password\": \"<string>\",\n \"sigV4AssumeArn\": \"<string>\",\n \"sigV4StsRegion\": \"<string>\",\n \"username\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"objectKey": "<string>",
"scopeEntityId": "<string>",
"setFields": [
"<string>"
],
"airflowVariable": {
"isSecret": true,
"value": "<string>"
},
"autoLinkDeployments": true,
"connection": {
"type": "<string>",
"connectionAuthType": {
"airflowType": "<string>",
"authMethodName": "<string>",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"parameters": [
{
"airflowParamName": "<string>",
"dataType": "<string>",
"description": "<string>",
"friendlyName": "<string>",
"isInExtra": true,
"isRequired": true,
"isSecret": true,
"example": "<string>",
"pattern": "<string>"
}
],
"providerPackageName": "<string>",
"guidePath": "<string>",
"providerLogo": "<string>"
},
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>"
},
"createdAt": "<string>",
"createdBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"description": "<string>",
"environmentVariable": {
"isSecret": true,
"value": "<string>"
},
"excludeLinks": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>"
}
],
"id": "<string>",
"links": [
{
"scope": "DEPLOYMENT",
"scopeEntityId": "<string>",
"setFields": [
"<string>"
],
"airflowVariableOverrides": {
"value": "<string>"
},
"connectionOverrides": {
"extra": {},
"host": "<string>",
"login": "<string>",
"password": "<string>",
"port": 123,
"schema": "<string>",
"type": "<string>"
},
"environmentVariableOverrides": {
"value": "<string>"
},
"metricsExportOverrides": {
"basicToken": "<string>",
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
}
}
],
"metricsExport": {
"endpoint": "<string>",
"exporterType": "PROMETHEUS",
"basicToken": "<string>",
"headers": {},
"labels": {},
"password": "<string>",
"sigV4AssumeArn": "<string>",
"sigV4StsRegion": "<string>",
"username": "<string>"
},
"sourceScopeEntityId": "<string>",
"updatedAt": "<string>",
"updatedBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
}
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to which the environment object belongs.
The environment object's ID.
Body
application/json
The request body for updating an environment object.
Show child attributes
Show child attributes
Whether or not to automatically link Deployments to the environment object. Only applicable for WORKSPACE scope
Show child attributes
Show child attributes
The description of the environment object
Maximum string length:
500Show child attributes
Show child attributes
The links to exclude from the environment object. Only applicable for WORKSPACE scope
Show child attributes
Show child attributes
The Deployments that Astro links to the environment object. Only applicable for WORKSPACE scope
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
The key for the environment object
The type of environment object
Available options:
CONNECTION, ENVIRONMENT_VARIABLE, AIRFLOW_VARIABLE, METRICS_EXPORT The scope of the environment object
Available options:
WORKSPACE, DEPLOYMENT The ID of the scope entity where the environment object is created
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")
Show child attributes
Show child attributes
Whether or not to automatically link Deployments to the environment object
Show child attributes
Show child attributes
The time when the environment object was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
Show child attributes
Show child attributes
The description of the environment object
Show child attributes
Show child attributes
The excluded links for the environment object
Show child attributes
Show child attributes
The ID of the environment object
The Deployments linked to the environment object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The source scope of the environment object, if it is resolved from a link
Available options:
WORKSPACE, DEPLOYMENT The source scope entity ID of the environment object, if it is resolved from a link
The time when the environment object was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
Show child attributes
Show child attributes
Was this page helpful?
⌘I