List environment objects

GET

organizations

{organizationId}

environment-objects

Error

A valid request URL is required to generate request examples

{
  "environmentObjects": [
    {
      "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"
      }
    }
  ],
  "limit": 123,
  "offset": 123,
  "totalCount": 123
}

{
  "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.

Query Parameters

offset

integer

default:0

The number of results to skip before returning values.

Required range: x >= 0

limit

integer

default:20

The maximum number of results to return.

Required range: x >= 0

sorts

enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:

objectType:asc,

objectType:desc,

objectKey:asc,

objectKey:desc,

createdAt:asc,

createdAt:desc,

updatedAt:asc,

updatedAt:desc

workspaceId

string

The Workspace ID to filter for. The API returns details for all environment objects belonging only to this specified Workspace.

deploymentId

string

The Deployment ID to filter for. The API returns details for all environment objects belonging only to this specified Deployment.

objectType

enum<string>

The environment object type to filter for. The API returns details for all environment objects belonging only to this specified object type.

Available options:

CONNECTION,

ENVIRONMENT_VARIABLE,

AIRFLOW_VARIABLE,

METRICS_EXPORT

objectKey

string

The environment object key to filter for. The API returns details for all environment objects belonging only to the specified object key.

showSecrets

boolean

If true, returns the actual values of fields of type secret in the API response.

resolveLinked

boolean

Resolve and return the environment objects linked to the specified Deployment or Workspace in the API response.

Response

environmentObjects

object[]

required

The list of environment objects

Show child attributes

limit

integer

required

The maximum number of environment objects in current page

offset

integer

required

The offset of the current page of environment objects

totalCount

integer

required

The total number of environment objects

⌘I

Error

A valid request URL is required to generate request examples

{
  "environmentObjects": [
    {
      "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"
      }
    }
  ],
  "limit": 123,
  "offset": 123,
  "totalCount": 123
}

{
  "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>"
    }
  ]
}