Aicscan Documentation
FrançaisEnglish

Rules

Delete a rule

DELETE/v1/rules/{id}

Soft delete: the rule stops matching and disappears from the API, its alert history stays available in /v1/matches. Deleting an active critical rule is deferred by one hour (202 with pending_change), like in the dashboard.

Authentication
API key (Authorization: Bearer)
Required scope
write

Path parameters#

  • idstring · uuidrequired

Responses#

202Deletion 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
204Deleted.
4xx · 5xxError.

Standard error format: see Errors.