Cluster-settings APIs,
Below is a comprehensive list of cluster settings related APIs that serve various purposes such as configuration management, system preferences, user-defined settings, and environment-specific adjustments.
settings
POST
This lets you create a custom system key-value.
| Key | Type | Example |
|---|---|---|
| label | string |
"max_users_session" |
| value | string | number |
"5" |
| is_secure | boolean |
"false" |
| decription | string |
"Defines the value of the max users per session allowed." |
{
"label": "max_users_session",
"value": "5",
"is_secure": false,
"description": "Defines the value of the max users per session allowed."
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| ERROR_KEY | an error occured while creating a custom system key-value. |
settings
PUT
This lets you update a system setting within your cluster
| Key | Type | Example |
|---|---|---|
| label | string |
"max_users_session" |
| value | string | number |
"5" |
is_secure optional |
boolean |
"false" |
decription optional |
string |
"Defines the value of the max users per session allowed." |
{
"label": "max_users_session",
"value": "5",
"is_secure": false,
"description": "Defines the value of the max users per session allowed."
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| ERROR_KEY | an error occured while cupdating a custom system key-value. |
settings/:guid
DELETE
This lets you delete a system setting within your cluster
| Key | Type | Example |
|---|---|---|
| :guid | string |
"13b41ab3-f040-4a51-bdcc-153099d8411cs" |
{
"label": "max_users_session",
"value": "5",
"is_secure": false,
"description": "Defines the value of the max users per session allowed."
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| ERROR_KEY | an error occured while creating a custom system key-value. |
settings/search
GET
This lets you delete a system setting within your cluster
| Key | Type | Example |
|---|---|---|
| :guid | string |
"13b41ab3-f040-4a51-bdcc-153099d8411cs" |
{
"label": "datatable_infinite_scroll",
"simulating": false,
"value": "",
"_meta": {
"guid": "a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef",
"expiry": 1741000000,
"entity": 42,
"removed": 0,
"created": 1636891234,
"updated": 1636895678,
"ums": 1636895678123,
"cms": 1636891234123,
"update_hash": "9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0b"
}
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| ERROR_KEY | an error occured while creating a custom system key-value. |
settings/search
POST
This lets you delete a system setting within your cluster
| Key | Type | Example |
|---|---|---|
| :guid | string |
"a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef" |
{
"label": "datatable_infinite_scroll",
"simulating": false,
"value": "",
"_meta": {
"guid": "a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef",
"expiry": 1741000000,
"entity": 42,
"removed": 0,
"created": 1636891234,
"updated": 1636895678,
"ums": 1636895678123,
"cms": 1636891234123,
"update_hash": "9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0b"
}
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| ERROR_KEY | an error occured while retrieving all system settings. |