Errors
Every error code, and what to do about it.
On this pageThe shapeEvery code
The shape
{"error": {"code": "unknown_parameter", "message": "...", "docs": "https://oilapi.net/documentation/errors"}}The code is fixed forever and meant for your code; the message is for people.
Every code
| Code | Status | What to do |
|---|---|---|
bad_request | 400 | A value is wrong or missing. The message says which and what is expected. |
unknown_parameter | 422 | A parameter this endpoint does not take. The message lists the ones it does. |
unauthorized | 401 | No key, or a key that is not valid. Send it in X-API-Key. |
upgrade_required | 403 | Your plan does not include this. The error names the plan that does. |
not_found | 404 | No record by that id or name, or no such endpoint. An empty list is a 200, never a 404. |
rate_limited | 429 | Too many calls this minute. Wait for Retry-After seconds. |
quota_exceeded | 429 | Today's calls are used up. They reset at 00:00 UTC. |
server_error | 500 | Our side went wrong. It is logged; try again shortly. |