Variables

PreviousSecrets NextWorkspaces

Last updated 4 months ago

Retrieve workspace variable

get

Authorizations

Path parameters

_idstring · uuidrequired

workspace_idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/' \
  --header 'Authorization: YOUR_API_KEY'

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:56:46.271Z",
  "_updated_at": "2025-04-03T06:56:46.271Z",
  "name": "text",
  "value": "text"
}

Delete workspace variable

delete

Authorizations

Path parameters

_idstring · uuidrequired

workspace_idstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/' \
  --header 'Authorization: YOUR_API_KEY'

204

No body

No response body

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/variables/' \
  --header 'Authorization: YOUR_API_KEY'

200

{
  "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-04-03T06:56:46.271Z",
      "_updated_at": "2025-04-03T06:56:46.271Z",
      "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/variables/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "value": "text"
  }'

201

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:56:46.271Z",
  "_updated_at": "2025-04-03T06:56:46.271Z",
  "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text"
  }'

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:56:46.271Z",
  "_updated_at": "2025-04-03T06:56:46.271Z",
  "value": "text"
}