EnvironmentVariables

List Environment Variables

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 30.

environmentVariableNamestringOptional

Name of the Environment Variable(s)

Responses

200

OK

application/json

get

/api/v1/environment-variables

HTTPcURLJavaScriptPython

GET /api/v1/environment-variables HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "type": "String",
      "values": [
        {
          "value": [
            "[Circular Reference]"
          ],
          "modifiedUtc": "2025-12-18T15:30:00.066Z",
          "modifier": "text",
          "version": 1,
          "environment": {
            "id": 1,
            "displayName": "text"
          }
        }
      ],
      "description": null,
      "childSchemas": [
        {
          "id": 1,
          "name": "text",
          "type": "String",
          "values": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Add Environment Variable

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

namestringOptional

Responses

201

Successful request

text/plainapplication/jsontext/json

post

/api/v1/environment-variables

HTTPcURLJavaScriptPython

POST /api/v1/environment-variables HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

201

Successful request

1

Get an Environment Variable

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Id of the Environment Variable

Responses

200

Successful request

application/json

404

Environment Variable not found

application/problem+json

get

/api/v1/environment-variables/{id}

HTTPcURLJavaScriptPython

GET /api/v1/environment-variables/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "String",
    "values": [
      {
        "value": [
          [
            "[Circular Reference]"
          ]
        ],
        "modifiedUtc": "2025-12-18T15:30:00.066Z",
        "modifier": "text",
        "version": 1,
        "environment": {
          "id": 1,
          "displayName": "text"
        }
      }
    ],
    "description": null,
    "childSchemas": [
      {
        "id": 1,
        "name": "text",
        "type": "String",
        "values": [
          {
            "value": "[Circular Reference]",
            "modifiedUtc": "2025-12-18T15:30:00.066Z",
            "modifier": "text",
            "version": 1,
            "environment": {
              "id": 1,
              "displayName": "text"
            }
          }
        ]
      }
    ]
  }
}

Create child Environment Variable

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

rootSchemaIdinteger · int64Required

Id of the parent Environment Variable schema.

Body

application/json

namestringOptional

typestring · enumOptionalPossible values:

Responses

201

Child Environment Variable created successfully.

text/plain

400

The provided schema id was not for a root Environment Variable schema.

application/problem+json

post

/api/v1/environment-variables/{rootSchemaId}

HTTPcURLJavaScriptPython

POST /api/v1/environment-variables/{rootSchemaId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "type": "String"
}

1

Delete Environment Variable

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

schemaIdinteger · int64Required

Responses

204

Environment Variable deleted successfully.

404

Environment Variable not found.

application/problem+json

409

Can not delete Environment Variable in use.

application/problem+json

delete

/api/v1/environment-variables/{schemaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/environment-variables/{schemaId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update the description of an Environment Variable.

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

schemaIdinteger · int64Required

Identifier of the Environment Variable being updated.

Body

application/json

New description.

descriptionstring · min: 1Optional

Responses

204

Environment Variable description updated successfully.

400

The provided description was not valid.

application/problem+json

404

Environment Variable not found.

application/problem+json

patch

/api/v1/environment-variables/{schemaId}

HTTPcURLJavaScriptPython

PATCH /api/v1/environment-variables/{schemaId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "description": "text"
}

No content

Update Environment Variable

put

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

schemaIdinteger · int64Required

Identifier of the Environment Variable being updated.

environmentIdinteger · int64Required

Identifier of the Environment being updated.

Bodyobject[]

application/json

object[]Optional

Responses

204

Environment Variable updated successfully.

400

The provided value was not valid.

application/problem+json

404

Environment or Environment Variable not found.

409

Conflict in the requested change.

application/problem+json

put

/api/v1/environment-variables/{schemaId}/values/{environmentId}

HTTPcURLJavaScriptPython

PUT /api/v1/environment-variables/{schemaId}/values/{environmentId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

No content