Variables

List workspace variables

get

Authorizations

AuthorizationstringRequired

Path parameters

workspace_idstring · uuidRequired

Query parameters

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses

200Success

application/json

countintegerOptionalExample: 50

next_pageinteger · nullableOptionalExample: 3

previous_pageinteger · nullableOptionalExample: 1

page_sizeintegerOptionalExample: 10

total_pagesintegerOptionalExample: 5

current_pageintegerOptionalExample: 2

get/developers/workspaces/{workspace_id}/variables/

GET /developers/workspaces/{workspace_id}/variables/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 50,
  "next_page": 3,
  "previous_page": 1,
  "page_size": 10,
  "total_pages": 5,
  "current_page": 2,
  "results": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_created_at": "2026-01-01T00:00:00.000Z",
      "_updated_at": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "value": "text"
    }
  ]
}

Create workspace variable

post

Authorizations

AuthorizationstringRequired

Path parameters

workspace_idstring · uuidRequired

Body

_idstring · uuidRead-onlyRequired

_created_atstring · date-timeRead-onlyRequired

_updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

Letters, digits and underscores, not starting with a digit. Unique in the workspace, ignoring case.

Pattern: ^[A-Za-z_][A-Za-z0-9_]*$

valuestring · max: 10000Required

Responses

201Success

application/json

_idstring · uuidRead-onlyRequired

_created_atstring · date-timeRead-onlyRequired

_updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

Letters, digits and underscores, not starting with a digit. Unique in the workspace, ignoring case.

Pattern: ^[A-Za-z_][A-Za-z0-9_]*$

valuestring · max: 10000Required

post/developers/workspaces/{workspace_id}/variables/

POST /developers/workspaces/{workspace_id}/variables/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "value": "text"
}

201Success

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "value": "text"
}

Retrieve workspace variable

get

Authorizations

AuthorizationstringRequired

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Responses

200Success

application/json

_idstring · uuidRead-onlyRequired

_created_atstring · date-timeRead-onlyRequired

_updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

Letters, digits and underscores, not starting with a digit. Unique in the workspace, ignoring case.

Pattern: ^[A-Za-z_][A-Za-z0-9_]*$

valuestring · max: 10000Required

get/developers/workspaces/{workspace_id}/variables/{_id}/

GET /developers/workspaces/{workspace_id}/variables/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "value": "text"
}

Edit workspace variable

put

Authorizations

AuthorizationstringRequired

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Body

_idstring · uuidRead-onlyRequired

_created_atstring · date-timeRead-onlyRequired

_updated_atstring · date-timeRead-onlyRequired

valuestring · max: 10000Required

Responses

200Success

application/json

_idstring · uuidRead-onlyRequired

_created_atstring · date-timeRead-onlyRequired

_updated_atstring · date-timeRead-onlyRequired

valuestring · max: 10000Required

put/developers/workspaces/{workspace_id}/variables/{_id}/

PUT /developers/workspaces/{workspace_id}/variables/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}

200Success

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "value": "text"
}

Delete workspace variable

delete

Authorizations

AuthorizationstringRequired

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Responses

204

No response body

No content

delete/developers/workspaces/{workspace_id}/variables/{_id}/

DELETE /developers/workspaces/{workspace_id}/variables/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content