Says what a change would destroy, without making it.
Errors
400 for a key or value this instance will not accept, the same answers
[update] gives, so a client cannot get a clean preview for a change that
would then be refused.
sessiontessera_session<token>Set by POST /auth/login. A browser sends it automatically; it is HttpOnly, so page scripts cannot read or set it.
application/json- body
Body of PUT /admin/settings.
changes*The changes to apply, by dotted key.
null clears a setting, so it falls back to whichever layer comes next:
the environment, or the default. That is the only way back to a value
the panel did not choose, and why clearing is a value and not a second
endpoint.
confirm?booleanGo ahead even though the change destroys something.
Without it, a change that would remove things is refused and the answer says what and how many. Two round trips by design: an empty "are you sure?" is a button everyone clicks, and a number gives pause.
What the change would destroy
application/json- response
What POST /admin/settings/preview answers.
consequences*array<>What the change would destroy. Empty when it destroys nothing.
curl -X POST 'https://example.com/api/v1/admin/settings/preview' \ -H 'Content-Type: application/json' \ -d '{ "changes": {}}'{ "consequences": [ { "bytes": 0, "count": 0, "key": "string", "kind": "shares", "subject": "string" } ]}