Skip to main content
GET
Get the complete rule configuration
Returns one consistent program snapshot containing every rule set and its ACTIVE and SUSPENDED rules. Archived rules are excluded. Pass rule_configuration_version with move, reorder, preview, and rollback requests; a stale value rejects the write. This endpoint is safer for planning than combining separately timed list responses. See Read the current configuration.

Authorizations

X-API-Key
string
header
required

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

Path Parameters

programId
string<uuid>
required

Program ID

Response

OK

program_id
string<uuid>

Program whose configuration was read.

rule_configuration_version
integer

Program rule-configuration version. Pass it to version-guarded writes to reject conflicting edits.

Example:

4

rule_sets
object[]

Rule sets in execution order, each with its ACTIVE and SUSPENDED rules in local order.