Skip to Content

Settings

The server's settings.

OperationKindHTTP
settings.listcallGET /v1/settings
settings.setcallPUT /v1/settings/{key}

settings.list

The server's settings.

Needs the role admin.

Result

Setting[]

Request
{
  "id": 1,
  "op": "settings.list"
}
Reply
{
  "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

NameWhereRequiredDescription
keypathyesThe setting

Input

The value

FieldTypeDescription
valuestringEmpty to go back to the default.

Result

FieldTypeDescription
okboolean

Errors

StatusWhen
403This one is set on the server itself
Request
{
  "id": 1,
  "op": "settings.set",
  "args": {
    "key": "layout"
  },
  "data": {
    "value": "text"
  }
}
Reply
{
  "id": 1,
  "result": {
    "ok": true
  }
}

Types

The named types used on this page.

Setting

FieldTypeDescription
keystring
meaningstring
openbooleanWhether settings.set takes it.
valuestringEmpty when it is not set, and for a token.

On this page