Browse the API reference
Getting started
OpenAPI 3.1 spec
Machine-readable specification of every endpoint — import it into Postman, Insomnia or a codegen tool.
GET
https://chaos.thescope.top/api/v1/openapi.jsonscope: readExample response
200 application/json
{ "openapi": "3.1.0", "info": { "title": "Chaos Subdomain Monitor API", "version": "1.0.0" } }Errors
400
invalid_bodyA POST body was missing or was not valid JSON.400
invalid_domainThe supplied domain is not a valid root domain.400
invalid_queryA required query parameter was missing or too short.400
invalid_idA path id was not a UUID.401
missing_tokenNo Authorization or X-API-Key header was sent.401
invalid_tokenThe token is malformed or unknown.401
revoked_tokenThe token was revoked by its owner.404
not_foundThe domain, platform, scan or endpoint does not exist.405
method_not_allowedThe HTTP verb is not supported on that path.500
query_failedA database query failed while serving the request.500
server_errorAn unexpected error occurred.Full catalogue with fixes on the errors page.
GETTry it
Kept in this browser tab only and sent straight to this API.
https://chaos.thescope.top/api/v1/openapi.json
curl "https://chaos.thescope.top/api/v1/openapi.json" \ -H "Authorization: Bearer chs_live_xxxxxxxxxxxx"