Sites API
Add, read, change and remove sites.
12 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.
List sites in the workspace
Parameters
Responses
Sites
2 fields
12 fields of data
The address an audit reads.
Status and per-area counts of the latest audit.
4 fields of lastRun
One of: queued, running, succeeded, partial, failed
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Add a site. The URL policy runs before anything is stored.
Parameters
Request body SiteCreate
At most 120 characters
Recurring audit. The first run of a new schedule is one period from now.
1 field of schedule
One of: none, weekly, monthly
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
{
"url": "https://www.example.com",
"name": "Example"
}Responses
Created
12 fields
The address an audit reads.
2 fields of schedule
One of: none, weekly, monthly
Status and per-area counts of the latest audit.
4 fields of lastRun
One of: queued, running, succeeded, partial, failed
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
4 fields of verification
`failed`: the last check did not find the proof.
One of: unverified, verified, failed
One of: dns_txt, file, null
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Get one site with its latest audit
Parameters
Responses
Site
12 fields
The address an audit reads.
2 fields of schedule
One of: none, weekly, monthly
Status and per-area counts of the latest audit.
4 fields of lastRun
One of: queued, running, succeeded, partial, failed
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
4 fields of verification
`failed`: the last check did not find the proof.
One of: unverified, verified, failed
One of: dns_txt, file, null
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
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 site or change its recurring audit schedule
Parameters
Request body
At most 120 characters
Recurring audit. The first run of a new schedule is one period from now.
1 field of schedule
One of: none, weekly, monthly
{
"schedule": {
"frequency": "weekly"
}
}Responses
Site
12 fields
The address an audit reads.
2 fields of schedule
One of: none, weekly, monthly
Status and per-area counts of the latest audit.
4 fields of lastRun
One of: queued, running, succeeded, partial, failed
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
4 fields of verification
`failed`: the last check did not find the proof.
One of: unverified, verified, failed
One of: dns_txt, file, null
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
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 site with its runs and observations
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.
Who gets the audit report of this site by email
When an audit of the site finishes, the report can be mailed to the account's own address and, on a verified site, to up to five other recipients. At most one report mail per site per hour. The mail holds counts and the titles of the failed checks, nothing read from the audited page.
Parameters
Responses
Report email settings
5 fields
The report goes to the address of the account.
3 fields of recipients
True on a verified site. While false, no recipient can be added and the listed ones get no mail.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Turn the report mail to the account's own address on or off
Parameters
Request body
{
"owner": true
}Responses
Report email settings
5 fields
The report goes to the address of the account.
3 fields of recipients
True on a verified site. While false, no recipient can be added and the listed ones get no mail.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Add another recipient of the report (verified sites only)
Needs a verified site (403 `verification_required`) and `confirmed: true`: with it you state that the person agreed to get the reports; who is added is your responsibility. 409 `recipient_limit` (five per site), `recipient_exists`, or `recipient_opted_out` when the address stopped the reports of this account. Every mail tells the recipient who added them and has a link that stops it.
Parameters
Request body
{
"email": "string",
"confirmed": true
}Responses
Report email settings with the new recipient
5 fields
The report goes to the address of the account.
3 fields of recipients
True on a verified site. While false, no recipient can be added and the listed ones get no mail.
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 recipient
Parameters
Responses
Report email settings without the recipient
5 fields
The report goes to the address of the account.
3 fields of recipients
True on a verified site. While false, no recipient can be added and the listed ones get no mail.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Stop the report mails to an address (the link in the mail)
No key: the token from the mail is the only credential. Stops every report from that account to that address; the account cannot add it again. Always answers 200, whether or not the token was known.
Request body
{
"token": "string"
}Responses
Done
1 field
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Ownership state of a site, and what to publish to prove it
A passive audit runs on any public site. A deep audit needs a verified site. Publish the value as a DNS TXT record or as a file, then call `verifySite`. The proof must stay in place: it is checked again before every deep audit.
Parameters
Responses
Verification state and instructions
6 fields
`failed`: the last check did not find the proof.
One of: unverified, verified, failed
One of: dns_txt, file, null
Audit levels a verified site can run.
2 fields of instructions
3 fields of dns_txt
2 fields of file
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Look for the DNS TXT record or the file that proves ownership
Answers 200 whether or not the proof was found (`found`). At most one check per site every ten seconds (429 `verification_cooldown`).
Parameters
Request body
One of: dns_txt, file
{
"method": "dns_txt"
}Responses
Verification state after the check
7 fields
`failed`: the last check did not find the proof.
One of: unverified, verified, failed
One of: dns_txt, file, null
Audit levels a verified site can run.
2 fields of instructions
3 fields of dns_txt
2 fields of file
RFC 9457 problem
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.