API · problem · HTTP 401
That path needs a key
This page is what the type field of the error points at. Every answer this API refuses carries one, and it is a stable address rather than a version of the docs.
The refusal
key-required- When it happens
- An account path was called with no credential. Unlike /v1, these have no open tier: they answer about one subscription and cannot do that without knowing which.
- What to do
- Send Authorization: Bearer <key>. Sign in at /account/ and the key is there: checkout returns you to that page, and the key is attached to the account rather than to a URL you have to keep.
The shape of the answer
RFC 9457Problem details: type, title, status and detail, plus whatever the individual failure can usefully add. The detail is written for the person reading the log, and names the parameter or the id that caused it.
| type | This page’s address. Stable. |
|---|---|
| title | That path needs a key |
| status | 401 |
| detail | What went wrong, in this request. |
The full list of failures, with the schema, is in the API documentation.
Where a key comes from
HTTP 401A key is attached to an account rather than handed over once, so losing it is not an incident: sign in and it is there.
Every refusal this API can return
12 types- 404No such resource
- 400Malformed request
- 402The open tier runs twelve months behind
- 404Nothing in force on that date
- 404There is no national figure
- 400That regime belongs to another domain
- 401That key is not valid
- 405That path does not answer this method
- 503Ceiling reached
- 503This deployment is not fully configured
- 500This request failed on our side