Type at least two letters.

    ↑ ↓ to moveEnter to open

    Audit scopes API

    The built-in scopes and the scopes you save, with their credits.

    Updated

    5 live operations. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.

    To try these with your own account, sign in and open Automation → Try the API in the app.

    Built-in and saved audit scopes

    GET/api/v1/audit-scopes
    Scope: audits:readoperationId: listAuditScopes

    A scope is the list of checks one audit runs. Built in: `full` and one per area (`area:security`). Saved scopes have an id that starts with `scope_`.

    Responses

    200object

    Scopes, built-in ones first

    1 field
    dataarray of AuditScope
    8 fields of data
    idstring

    `full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.

    namestring
    builtInboolean
    ruleIdsarray of string
    checksinteger
    creditsobject

    What one audit with this scope costs at each level.

    2 fields of credits
    passiveinteger
    deepinteger
    createdAtstring or null (date-time)
    updatedAtstring or null (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Save your own scope

    POST/api/v1/audit-scopes
    Scope: audits:writeoperationId: createAuditScope

    At most 20 per account. 409 `name_taken` or `scope_limit`.

    Request body

    namestring

    At least 1 characters · At most 60 characters

    ruleIdsarray of string

    Check ids from `GET /rules`.

    {}

    Responses

    201AuditScope

    Saved

    8 fields
    idstring

    `full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.

    namestring
    builtInboolean
    ruleIdsarray of string
    checksinteger
    creditsobject

    What one audit with this scope costs at each level.

    2 fields of credits
    passiveinteger
    deepinteger
    createdAtstring or null (date-time)
    updatedAtstring or null (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    One saved scope

    GET/api/v1/audit-scopes/{scopeId}
    Scope: audits:readoperationId: getAuditScope

    Parameters

    scopeIdstring · pathrequired

    Responses

    200AuditScope

    Scope

    8 fields
    idstring

    `full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.

    namestring
    builtInboolean
    ruleIdsarray of string
    checksinteger
    creditsobject

    What one audit with this scope costs at each level.

    2 fields of credits
    passiveinteger
    deepinteger
    createdAtstring or null (date-time)
    updatedAtstring or null (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Rename a saved scope or change its checks

    PATCH/api/v1/audit-scopes/{scopeId}
    Scope: audits:writeoperationId: updateAuditScope

    Audits already started keep the checks they were started with.

    Parameters

    scopeIdstring · pathrequired

    Request body AuditScopeWrite

    namestring

    At least 1 characters · At most 60 characters

    ruleIdsarray of string

    Check ids from `GET /rules`.

    {}

    Responses

    200AuditScope

    Scope

    8 fields
    idstring

    `full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.

    namestring
    builtInboolean
    ruleIdsarray of string
    checksinteger
    creditsobject

    What one audit with this scope costs at each level.

    2 fields of credits
    passiveinteger
    deepinteger
    createdAtstring or null (date-time)
    updatedAtstring or null (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Remove a saved scope

    DELETE/api/v1/audit-scopes/{scopeId}
    Scope: audits:writeoperationId: deleteAuditScope

    Parameters

    scopeIdstring · pathrequired

    Responses

    204

    Removed

    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.