Every check / api-docs-exposed
Is a full description of your site's API published for anyone to read?
On a domain you have proved is yours, we ask for /swagger.json, /openapi.json and /api-docs.
How it decides
The check speaks up only when what comes back is a real Swagger or OpenAPI document.
Why it matters
The document lists every address your software answers, what each one accepts and what it returns.
In more detail
Developers use it to build against your system, and so does anyone else who finds it. Partners who need it can be given it directly.
Who fixes it, and where it runs
- Who usually fixes it
- Whoever built your site
- Which plan runs it
- The Business plan
- Proof you own the site
- Needed. It asks your server for things an ordinary visitor never requests, so it waits until you prove the domain is yours.
More about this check
- Who it is about
- An intruder
- Listed under
- Things that should not be public
- The standards
- Its name in a report
api-docs-exposed
See what the free scan finds
The free scan runs 62 checks on any address, and this is not one of them: it runs on the Business plan, once you prove the domain is yours.