variables
POST /variables.delete_global_vars
Description
Delete global vars
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| keys required | The keys of the variables to delete | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| deleted optional | The number of the deleted vars | integer |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /variables.get_global_vars
Description
Get global vars
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| keys required | The keys of the variables to retrieve | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| vars optional | Retrieved variables | < vars > array |
vars
| Name | Description | Schema |
|---|---|---|
| key optional | Vauriable key | string |
| value optional | Variable value | string |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /variables.increment_global_vars
Description
Increment global vars
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| commands required | commands | < variables.increment_command > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| vars optional | Updated variables | < vars > array |
vars
| Name | Description | Schema |
|---|---|---|
| increment optional | The value by which the variable was incremented. 0 if no increment was done | integer |
| key optional | Vauriable key | string |
| value optional | The new variable value after the increment | integer |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |
POST /variables.set_global_vars
Description
Set global vars
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| vars required | vars | < variables.variable > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| updated optional | The number of variables set | integer |
Security
| Type | Name | Scopes |
|---|---|---|
| Bearer | clearml | all |