EnvironmentVariables
Enter your bearer token in the format Bearer <token>
Current page number. Default value is 1.
Maximum page size is 200. Default page size is 30.
Name of the Environment Variable(s)
OK
GET /api/v1/environment-variables HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"data": [
{
"id": 1,
"name": "text",
"type": "String",
"values": [
{
"value": [
"[Circular Reference]"
],
"modifiedUtc": "2025-11-28T00:31:05.478Z",
"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"
}
}Enter your bearer token in the format Bearer <token>
Successful request
POST /api/v1/environment-variables HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}Successful request
1Enter your bearer token in the format Bearer <token>
Id of the Environment Variable
Successful request
Environment Variable not found
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-11-28T00:31:05.478Z",
"modifier": "text",
"version": 1,
"environment": {
"id": 1,
"displayName": "text"
}
}
],
"description": null,
"childSchemas": [
{
"id": 1,
"name": "text",
"type": "String",
"values": [
{
"value": "[Circular Reference]",
"modifiedUtc": "2025-11-28T00:31:05.478Z",
"modifier": "text",
"version": 1,
"environment": {
"id": 1,
"displayName": "text"
}
}
]
}
]
}
}Enter your bearer token in the format Bearer <token>
Id of the parent Environment Variable schema.
Child Environment Variable created successfully.
The provided schema id was not for a root Environment Variable schema.
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"
}1Enter your bearer token in the format Bearer <token>
Environment Variable deleted successfully.
Environment Variable not found.
Can not delete Environment Variable in use.
DELETE /api/v1/environment-variables/{schemaId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Enter your bearer token in the format Bearer <token>
Identifier of the Environment Variable being updated.
New description.
Environment Variable description updated successfully.
The provided description was not valid.
Environment Variable not found.
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
Enter your bearer token in the format Bearer <token>
Identifier of the Environment Variable being updated.
Identifier of the Environment being updated.
Environment Variable updated successfully.
The provided value was not valid.
Environment or Environment Variable not found.
Conflict in the requested change.
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
Was this helpful?