Skip to main content
POST
Preview a forward rule-configuration rollback
Reconstructs a historical revision as a new forward atomic change. The request is guarded by the current expected_rule_configuration_version. Rule sets created after the target revision are retained empty and reported in warnings. Rules created after the target are archived. Stable resource IDs are preserved. Review the returned plan and inverse diff, then apply its preview_token and request_hash through the standard apply endpoint.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

programId
string<uuid>
required

Program ID

version
integer
required

Historical target configuration version

Body

application/json

Current revision guard and optional source metadata

expected_rule_configuration_version
integer
required

Current rule_configuration_version. A stale value rejects the request.

Required range: x >= 1
Example:

8

source
object

Optional caller category and correlation reference for audit history.

Response

OK

base_rule_configuration_version
integer

Configuration version the preview was planned from.

change_id
string<uuid>

Stable preview/change identifier.

diff
object

Resource-level changes between the base and proposed configurations.

expires_at
string<date-time>

Preview capability expiry time.

local_references
object

Mapping from each client_ref to its preview-allocated stable UUID.

preview_token
string

Short-lived actor-bound capability consumed by apply.

proposed_rule_configuration
object

Exact server-computed configuration that apply will commit.

request_hash
string

SHA-256 request hash that must accompany apply.

source
object

Audit source recorded with the preview.

warnings
object[]

Non-blocking advisories found while validating the proposed configuration.