Variables

List workspace variables

GEThttps://api.erathos.com/developers/workspaces/{workspace_id}/variables/

Authorization

ApiKeyAuth

Path parameters

workspace_id*string (uuid)

Query parameters

Response

200

Body

application/json

countinteger

Example: 50

next_pagenullable integer

Example: 3

previous_pagenullable integer

Example: 1

page_sizeinteger

Example: 10

total_pagesinteger

Example: 5

current_pageinteger

Example: 2

resultsarray of OrchestrationVariable (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/variables/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": "2024-12-04T19:07:55.968Z",
      "_updated_at": "2024-12-04T19:07:55.968Z",
      "name": "text",
      "value": "text"
    }
  ]
}

Create workspace variable

POSThttps://api.erathos.com/developers/workspaces/{workspace_id}/variables/

Authorization

ApiKeyAuth

Path parameters

workspace_id*string (uuid)

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

_id* id

_created_at* created at

_updated_at* updated at

name*string

value*string

Response

201

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

name*string

value*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/variables/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "_created_at": "2024-12-04T19:07:55.968Z",
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_updated_at": "2024-12-04T19:07:55.968Z",
      "name": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

201

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T19:07:55.968Z",
  "_updated_at": "2024-12-04T19:07:55.968Z",
  "name": "text",
  "value": "text"
}

Retrieve workspace variable

GEThttps://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Response

200

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

name*string

value*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T19:07:55.968Z",
  "_updated_at": "2024-12-04T19:07:55.968Z",
  "name": "text",
  "value": "text"
}

Edit workspace variable

PUThttps://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

_id* id

_created_at* created at

_updated_at* updated at

value*string

Response

200

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

value*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "_created_at": "2024-12-04T19:07:55.968Z",
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_updated_at": "2024-12-04T19:07:55.968Z",
      "value": "text"
    }),
});
const data = await response.json();

Response

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T19:07:55.968Z",
  "_updated_at": "2024-12-04T19:07:55.968Z",
  "value": "text"
}

Delete workspace variable

DELETEhttps://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Response

204

No response body

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/variables/{_id}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();