Rules

List rules

GET/v1/rules
Authentication
API key (Authorization: Bearer)
Required scope
read

Query parameters#

  • statestring
    Values active paused
  • limitinteger
    Default 50
    1 to 100
  • cursorstring

    Opaque next_cursor of the previous page.

Responses#

200One page of rules.
Object fields
  • dataarray of objectrequired
    Fields of each item
    • 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
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.