Settings
The server's settings.
| Operation | Kind | HTTP |
|---|---|---|
settings.list | call | GET /v1/settings |
settings.set | call | PUT /v1/settings/{key} |
settings.list
The server's settings.
Needs the role admin.
Result
Setting[]
{
"id": 1,
"op": "settings.list"
}{
"id": 1,
"result": [
{
"key": "layout",
"meaning": "text",
"open": true,
"value": "text"
}
]
}settings.set
Change one of the settings that are open to callers, or any for the user the server runs as.
Needs the role admin.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
key | path | yes | The setting |
Input
The value
| Field | Type | Description |
|---|---|---|
value | string | Empty to go back to the default. |
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
Errors
| Status | When |
|---|---|
| 403 | This one is set on the server itself |
{
"id": 1,
"op": "settings.set",
"args": {
"key": "layout"
},
"data": {
"value": "text"
}
}{
"id": 1,
"result": {
"ok": true
}
}Types
The named types used on this page.
Setting
| Field | Type | Description |
|---|---|---|
key | string | |
meaning | string | |
open | boolean | Whether settings.set takes it. |
value | string | Empty when it is not set, and for a token. |