Environment operations
2 operations named environment.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| environment.read | environment.read with validated settings and revisioned undo. | site.read | none |
| environment.update | environment.update with validated settings and revisioned undo. | site.admin | none |
environment.read
environment.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 |
|---|---|---|---|
| variables | record of null | yes |
Try it
yarn splash environment.read '{}' --dry-runenvironment.update
environment.update with validated settings and revisioned undo.
permission: site.adminwrites: environmentclass: transactionundo: yes
Example input
{
"variables": {
"NEWSLETTER_LIST_ID": "list-42"
}
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| variables | record of string | null | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| variables | record of null | yes |
Try it
yarn splash environment.update '{"variables":{"NEWSLETTER_LIST_ID":"list-42"}}' --dry-runGenerated from the operation registry and the MCP tool catalogue (source b38d9d6038764f38).
Something wrong on this page? Write to docs@librettocms.com.