Aicscan Documentation
FrançaisEnglish

Rules

Pause, resume or rename a rule

PATCH/v1/rules/{id}

Pausing an active critical rule is deferred by one hour (security delay): the response is 202 with pending_change, the rule keeps running meanwhile, and a workspace owner can cancel or confirm the request from the dashboard. Owners and active channels are notified. 409 change_already_pending if a change is already waiting.

Authentication
API key (Authorization: Bearer)
Required scope
write

Path parameters#

  • idstring · uuidrequired

Request body#

  • statestring
    Values active paused
  • namestring
    1 to 120 characters

Responses#

200Updated rule.
Object fields
  • idstring · uuid
  • namestring
  • kindstring

    Rules created through the API are large_transfer, new_counterparty or burst; the other kinds are created from the dashboard and are returned read-only.

    Values large_transfer new_counterparty burst admin_change contract_upgrade low_balance balance_drop
  • chain_idsarray of integer
  • paramsobject

    Normalised rule parameters (amounts in raw units).

  • severitystring
    Values critical warning info
  • statestring
    Values active paused
  • immediate_alertbooleannullable

    Alert before confirmations. null = default by severity (yes for critical).

  • channel_idsarray of string · uuid
  • pending_changeobjectnullable

    Deferred pause or deletion of a critical rule, effective at effective_at.

    Object fields
    • idstring · uuid
    • actionstring
      Values pause delete
    • requested_atstring · date-time
    • effective_atstring · date-time
  • created_atstring · date-time
202Pause of a critical rule scheduled in one hour (see pending_change).
Object fields
  • idstring · uuid
  • namestring
  • kindstring

    Rules created through the API are large_transfer, new_counterparty or burst; the other kinds are created from the dashboard and are returned read-only.

    Values large_transfer new_counterparty burst admin_change contract_upgrade low_balance balance_drop
  • chain_idsarray of integer
  • paramsobject

    Normalised rule parameters (amounts in raw units).

  • severitystring
    Values critical warning info
  • statestring
    Values active paused
  • immediate_alertbooleannullable

    Alert before confirmations. null = default by severity (yes for critical).

  • channel_idsarray of string · uuid
  • pending_changeobjectnullable

    Deferred pause or deletion of a critical rule, effective at effective_at.

    Object fields
    • idstring · uuid
    • actionstring
      Values pause delete
    • requested_atstring · date-time
    • effective_atstring · date-time
  • created_atstring · date-time
4xx · 5xxError.

Standard error format: see Errors.