Monitors

Queue an audit now with the monitor's scope frozen as the scheduler would freeze it

Admits and queues an immediate audit with the monitor's current scope, capture profile and change policy frozen into the run. It is admitted against audit.capture exactly as a site audit is, and a refusal is the shared billing answer. An Idempotency-Key replay returns the existing audit; archived monitors cannot run.

post/v1/monitors/{monitorId}/run

Request

  • Base URL: https://api.ironfang.com/audit
  • URL: https://api.ironfang.com/audit/v1/monitors/{monitorId}/run
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

Idempotency-Keystring

Makes queueing an audit safe to retry. Surrounding whitespace is ignored. A key is remembered per organisation, across both operations that queue an audit, for as long as the audit it queued exists. A request under a key already used returns that audit with 200 instead of queueing another. The request is not compared with the first, so there is no conflict response.

Response

Idempotent replay; the existing audit

Changes

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