Sites

Trigger an asynchronous audit

Admits and queues an audit for the organisation's site and returns its initial lifecycle state. Admission comes first: the most pages the audit can capture (page_bound: the site's page limit within the per-audit cap, or one page for single_page) are reserved against the audit.capture meter of the organisation's billing account. A refusal is answered now with the shared billing code and no audit exists. The audit then captures at most page_bound pages and is charged only for the page evidence it finalises. Reusing an Idempotency-Key returns the existing audit and reserves nothing more; single_page limits the scope to the site's primary URL.

post/v1/sites/{siteId}/audits

Request

  • Base URL: https://api.ironfang.com/audit
  • URL: https://api.ironfang.com/audit/v1/sites/{siteId}/audits
  • 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.

Request body

reasonstring
single_pageboolean

Capture only the primary URL without following links or creating a monitor.

trigger_typestring

Response

Idempotent replay; the existing audit

Changes

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