Agent readiness check
An API catalog lists the site's APIs
/.well-known/api-catalog answers with an application/linkset+json document whose linkset names each API and its description.
low severityagents.api-catalog
Run this check on your site
Runs just this check in quick mode. The report opens with the evidence and the fix.
Why it matters
The API catalog (RFC 9727) is the one well-known place where an agent finds every API of a site, with its OpenAPI description, documentation and status endpoint.
How to fix it
Serve /.well-known/api-catalog as application/linkset+json: `{"linkset":[{"anchor":"https://example.com/api","service-desc":[{"href":"https://example.com/openapi.json","type":"application/vnd.oai.openapi+json"}],"service-doc":[{"href":"https://example.com/docs/api"}]}]}`.
The details
- Category
- Agent readiness
- Severity of a failure
- low
- Confidence
- high
- Needs a browser
- No
- Check id
- agents.api-catalog