Variables

Create a new variable

Create a new variable

post

/variables

Authorizations

Body

idstring · uuid

Unique identifier for the variable

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

namestring

Name of the variable

Example: API_KEY

valuestring | nullable

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/variables' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"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"}'

200

400

422

500

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"
}

Variable created successfully

List all variables

Retrieve a list of all variables

get

/variables

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/variables' \
  --header 'Authorization: Bearer JWT'

200

500

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"
  }
]

Successful operation

Update a variable by ID

Update a specific variable by ID

put

/variables/{id}

Authorizations

Path parameters

idstringrequired

Variable ID

Body

idstring · uuid

Unique identifier for the variable

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

namestring

Name of the variable

Example: API_KEY

valuestring | nullable

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/variables/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"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"}'

200

400

404

500

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"
}

Variable updated successfully

Delete a variable by ID

Delete a specific variable by ID

delete

/variables/{id}

Authorizations

Path parameters

idstringrequired

Variable ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/variables/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

No body

Variable deleted successfully