{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"sitemap","kind":"endpoint","group":"share","title":"Read the sitemap","method":"GET","path":"/sitemap.xml","paths":["/sitemaps/pages.xml","/sitemaps/{file}"],"summary":"The public pages and cards a search engine may list, each card at its canonical address.","response":"A sitemaps.org urlset: the landing page, /verify, /canary, every page of /docs and every public card with lastmod from its current version. Past 50,000 addresses it is a sitemap index of /sitemaps/pages.xml and /sitemaps/cards-<k>.xml.","parameters":[],"sample":"/sitemap.xml","access":"public","base":"directory","notes":["Suspended, removed, closed and name-hidden cards are never listed. Each file is rebuilt at most every 10 minutes; reads count against a budget of 30 a minute per IP."],"errors":["401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","404 not_found","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/sitemap.xml'"}],"live":false,"responses":[{"status":200,"contentType":"application/xml","description":"A sitemaps.org urlset: the landing page, /verify, /canary, every page of /docs and every public card with lastmod from its current version. Past 50,000 addresses it is a sitemap index of /sitemaps/pages.xml and /sitemaps/cards-<k>.xml.","fields":[]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"status":403,"code":"developer_suspended","description":"The owner’s API account is suspended or the owner card is unavailable.","action":"Check the owner account and any staff restriction. Creating another key does not bypass suspension.","scope":"optional-api-key"},{"status":404,"code":"not_found","description":"The requested card, key, alias, code or resource was not found.","action":"Check the identifier. Temporary codes and previews may already have expired or been used.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"application/xml","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Cache-Control","value":"public, max-age=600","description":"A sitemap may be cached for ten minutes, as long as the server keeps it."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/sitemap","supportsBrowserFetch":false,"browserMode":"local-or-server"}}