Variables

Create a new variable

Create a new variable

POST/variables

Authorization

bearerAuth

Body

application/json

idstring (uuid)

Unique identifier for the variable

Example: "cfd531e0-82fc-11e9-bc42-526af7764f64"

namestring

Name of the variable

Example: "API_KEY"

valuenullable string

Value of the variable

Example: "my-secret-key"

typestring

Type of the variable (e.g., string, number)

Example: "string"

createdDatestring (date-time)

Date and time when the variable was created

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Date and time when the variable was last updated

Example: "2024-08-24T14:15:22Z"

Response

200400422500

Variable created successfully

Body

application/json

idstring (uuid)

Unique identifier for the variable

Example: "cfd531e0-82fc-11e9-bc42-526af7764f64"

namestring

Name of the variable

Example: "API_KEY"

valuenullable string

Value of the variable

Example: "my-secret-key"

typestring

Type of the variable (e.g., string, number)

Example: "string"

createdDatestring (date-time)

Date and time when the variable was created

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Date and time when the variable was last updated

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/variables', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

List all variables

Retrieve a list of all variables

GET/variables

Authorization

bearerAuth

Response

200500

Successful operation

Body

application/json

idstring (uuid)

Unique identifier for the variable

Example: "cfd531e0-82fc-11e9-bc42-526af7764f64"

namestring

Name of the variable

Example: "API_KEY"

valuenullable string

Value of the variable

Example: "my-secret-key"

typestring

Type of the variable (e.g., string, number)

Example: "string"

createdDatestring (date-time)

Date and time when the variable was created

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Date and time when the variable was last updated

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/variables', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "API_KEY",
    "value": "my-secret-key",
    "type": "string",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Update a variable by ID

Update a specific variable by ID

PUT/variables/{id}

Authorization

bearerAuth

Path parameters

id*string

Variable ID

Body

application/json

idstring (uuid)

Unique identifier for the variable

Example: "cfd531e0-82fc-11e9-bc42-526af7764f64"

namestring

Name of the variable

Example: "API_KEY"

valuenullable string

Value of the variable

Example: "my-secret-key"

typestring

Type of the variable (e.g., string, number)

Example: "string"

createdDatestring (date-time)

Date and time when the variable was created

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Date and time when the variable was last updated

Example: "2024-08-24T14:15:22Z"

Response

200400404500

Variable updated successfully

Body

application/json

idstring (uuid)

Unique identifier for the variable

Example: "cfd531e0-82fc-11e9-bc42-526af7764f64"

namestring

Name of the variable

Example: "API_KEY"

valuenullable string

Value of the variable

Example: "my-secret-key"

typestring

Type of the variable (e.g., string, number)

Example: "string"

createdDatestring (date-time)

Date and time when the variable was created

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Date and time when the variable was last updated

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/variables/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Delete a variable by ID

Delete a specific variable by ID

DELETE/variables/{id}

Authorization

bearerAuth

Path parameters

id*string

Variable ID

Response

200400404500

Variable deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/variables/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();