Audit scopes API
The built-in scopes and the scopes you save, with their credits.
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
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
Scopes, built-in ones first
1 field
8 fields of data
`full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.
What one audit with this scope costs at each level.
2 fields of credits
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
At most 20 per account. 409 `name_taken` or `scope_limit`.
Request body
At least 1 characters · At most 60 characters
Check ids from `GET /rules`.
{}Responses
Saved
8 fields
`full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.
What one audit with this scope costs at each level.
2 fields of credits
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
Parameters
Responses
Scope
8 fields
`full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.
What one audit with this scope costs at each level.
2 fields of credits
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
Audits already started keep the checks they were started with.
Parameters
Request body AuditScopeWrite
At least 1 characters · At most 60 characters
Check ids from `GET /rules`.
{}Responses
Scope
8 fields
`full`, `area:<area>` or `scope_…`. Send it as `scope` to `startAudit`.
What one audit with this scope costs at each level.
2 fields of credits
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
Parameters
Responses
Removed
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.