Update an environment object

Error

A valid request URL is required to generate request examples

{
  "objectKey": "<string>",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "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": {
        "authType": "BASIC",
        "basicToken": "<string>",
        "dataDogApiKey": "<string>",
        "dataDogSite": "datadoghq.com",
        "endpoint": "<string>",
        "exporterType": "PROMETHEUS",
        "headers": {},
        "labels": {},
        "password": "<string>",
        "sigV4AssumeArn": "<string>",
        "sigV4StsRegion": "<string>",
        "username": "<string>"
      }
    }
  ],
  "metricsExport": {
    "endpoint": "<string>",
    "exporterType": "PROMETHEUS",
    "authType": "BASIC",
    "basicToken": "<string>",
    "dataDogApiKey": "<string>",
    "dataDogSite": "datadoghq.com",
    "headers": {},
    "labels": {},
    "password": "<string>",
    "sigV4AssumeArn": "<string>",
    "sigV4StsRegion": "<string>",
    "username": "<string>"
  },
  "sourceScope": "WORKSPACE",
  "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>"
    }
  ]
}

POST

organizations

{organizationId}

environment-objects

{environmentObjectId}

Error

A valid request URL is required to generate request examples

{
  "objectKey": "<string>",
  "objectType": "CONNECTION",
  "scope": "WORKSPACE",
  "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": {
        "authType": "BASIC",
        "basicToken": "<string>",
        "dataDogApiKey": "<string>",
        "dataDogSite": "datadoghq.com",
        "endpoint": "<string>",
        "exporterType": "PROMETHEUS",
        "headers": {},
        "labels": {},
        "password": "<string>",
        "sigV4AssumeArn": "<string>",
        "sigV4StsRegion": "<string>",
        "username": "<string>"
      }
    }
  ],
  "metricsExport": {
    "endpoint": "<string>",
    "exporterType": "PROMETHEUS",
    "authType": "BASIC",
    "basicToken": "<string>",
    "dataDogApiKey": "<string>",
    "dataDogSite": "datadoghq.com",
    "headers": {},
    "labels": {},
    "password": "<string>",
    "sigV4AssumeArn": "<string>",
    "sigV4StsRegion": "<string>",
    "username": "<string>"
  },
  "sourceScope": "WORKSPACE",
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

The ID of the Organization to which the environment object belongs.

environmentObjectId

string

required

The environment object's ID.

Body

application/json

The request body for updating an environment object.

airflowVariable

object

Show child attributes

autoLinkDeployments

boolean

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

connection

object

Show child attributes

description

string

The description of the environment object

Maximum string length: 500

environmentVariable

object

Show child attributes

excludeLinks

object[]

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

Show child attributes

links

object[]

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

Show child attributes

metricsExport

object

Show child attributes

Response

objectKey

string

required

The key for the environment object

objectType

enum<string>

required

The type of environment object

Available options:

CONNECTION,

ENVIRONMENT_VARIABLE,

AIRFLOW_VARIABLE,

METRICS_EXPORT

scope

enum<string>

required

The scope of the environment object

Available options:

WORKSPACE,

DEPLOYMENT

scopeEntityId

string

required

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

setFields

string[]

required

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")

airflowVariable

object

Show child attributes

autoLinkDeployments

boolean

Whether or not to automatically link Deployments to the environment object

connection

object

Show child attributes

createdAt

string

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

createdBy

object

Show child attributes

description

string

The description of the environment object

environmentVariable

object

Show child attributes

excludeLinks

object[]

The excluded links for the environment object

Show child attributes

string

The ID of the environment object

links

object[]

The Deployments linked to the environment object

Show child attributes

metricsExport

object

Show child attributes

sourceScope

enum<string>

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

Available options:

WORKSPACE,

DEPLOYMENT

sourceScopeEntityId

string

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

updatedAt

string

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

updatedBy

object

Show child attributes

⌘I

Astro API v1labs

API Reference

Update an environment object

Authorizations

Path Parameters

Body

Response