Variables

List workspace variables

get
Authorizations
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
get
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": "2025-07-03T10:41:38.612Z",
      "_updated_at": "2025-07-03T10:41:38.612Z",
      "name": "text",
      "value": "text"
    }
  ]
}

Create workspace variable

post
Authorizations
Path parameters
workspace_idstring · uuidRequired
Body
_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
namestring · max: 255Required
valuestring · max: 1000Required
Responses
201Success
application/json
post
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": "2025-07-03T10:41:38.612Z",
  "_updated_at": "2025-07-03T10:41:38.612Z",
  "name": "text",
  "value": "text"
}

Retrieve workspace variable

get
Authorizations
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Responses
200Success
application/json
get
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": "2025-07-03T10:41:38.612Z",
  "_updated_at": "2025-07-03T10:41:38.612Z",
  "name": "text",
  "value": "text"
}

Edit workspace variable

put
Authorizations
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Body
_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
valuestring · max: 1000Required
Responses
200Success
application/json
put
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": "2025-07-03T10:41:38.612Z",
  "_updated_at": "2025-07-03T10:41:38.612Z",
  "value": "text"
}

Delete workspace variable

delete
Authorizations
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Responses
204
No response body
delete
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
PreviousSecretsNextWorkspaces

Last updated