Rules

Move a rule

Move one ACTIVE or SUSPENDED rule to the first or last position, or before or after another rule, in the same or another rule set.

post/v1/rules/{rule_id}/move

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/rules/{rule_id}/move
Auth: HTTP bearer

Path parameters

rule_idstring uuid required

The rule's id.

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Request body

expected_rule_configuration_versioninteger required

Current rule_configuration_version from the configuration read endpoint. A stale value rejects the request.

rule_set_idstring uuid required

Destination rule-set ID. It may be the rule's current set.

Example request

{
  "expected_rule_configuration_version": 3,
  "position": {
    "placement": "before",
    "reference_id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b04"
  },
  "rule_set_id": "d4735e3a-265e-4f16-b1a5-4c8e9d6f0a04"
}

Response

The moved rule, both rule sets in their new order, and the new rule_configuration_version

rule_configuration_versioninteger

Resulting program rule-configuration version.

source_rule_set_idstring uuid

Rule set that contained the rule before the move.

Example response

{
  "destination_rules": [
    {
      "id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03",
      "rule_set_id": "d4735e3a-265e-4f16-b1a5-4c8e9d6f0a04"
    }
  ],
  "rule": {
    "id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03",
    "rule_set_id": "d4735e3a-265e-4f16-b1a5-4c8e9d6f0a04"
  },
  "rule_configuration_version": 4,
  "source_rules": [
    {
      "id": "c9f0f895-fb98-4b39-9f86-1e5a0d3e2b03",
      "rule_set_id": "d4735e3a-265e-4f16-b1a5-4c8e9d6f0a04"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.