Settings operations

2 operations named settings.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.

Updated10/26/2026

Operation	What it does	Permission	Confirmation
settings.read	settings.read with validated settings and revisioned undo.	site.read	none
settings.update	settings.update with validated settings and revisioned undo.	site.edit	none

settings.read

settings.read with validated settings and revisioned undo.

permission: site.readreads onlyclass: read

Example input

{}

Input

The input is a record; see the schema below.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output

Field	Type	Required	Notes
settings	record of any JSON	yes

Try it

yarn splash settings.read '{}' --dry-run

settings.update

settings.update with validated settings and revisioned undo.

permission: site.editwrites: settingsclass: transactionundo: yes

Example input

{
  "siteTitle": "Studio"
}

Input

The input is a record; see the schema below.

{
  "type": "object",
  "propertyNames": {
    "$ref": "#/$defs/__schema0"
  },
  "additionalProperties": {
    "$ref": "#/$defs/__schema1"
  },
  "$defs": {
    "__schema0": {
      "type": "string",
      "minLength": 1
    },
    "__schema1": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/__schema1"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/__schema1"
          }
        }
      ]
    }
  }
}

Output

Field	Type	Required	Notes
settings	record of any JSON	yes

Try it

yarn splash settings.update '{"siteTitle":"Studio"}' --dry-run

Generated from the operation registry and the MCP tool catalogue (source 11fbf347ad07d57d).

Something wrong on this page? Write to docs@librettocms.com.