Documentation / Guides
Errors
Every error code, what it means and what to do.An error answers with its HTTP status and one shape:
{"error": {"code": "upgrade_required", "message": "...", "plan": "archive", "docs": "https://icehockeyapi.com/documentation/errors#upgrade_required"}}| Code | HTTP | What it means | What to do |
|---|---|---|---|
bad_request | 400 | A parameter is missing or has the wrong form. The message names it. | Fix the value and send it again. |
unauthorized | 401 | No key was sent, or it is not one we know (or it was revoked). | Send an active key from your account in X-API-Key or Authorization: Bearer. |
upgrade_required | 403 | Your plan does not read this endpoint or these seasons. The answer names the plan that does in plan. | Move up from Billing in your account, or ask for what your plan covers. |
not_found | 404 | No such endpoint, or no record with that id. | Check the path, and take ids from a list call. |
unknown_parameter | 422 | A parameter this endpoint does not take. The message lists the ones it does. | Take the parameter out, or use one from the list. |
rate_limited | 429 | More calls this minute than your plan allows. | Wait for the seconds in Retry-After, then go on, a little slower. |
quota_exceeded | 429 | Your calls for the day (free key) or month (paid plans) are used up. resets_at says when they come back. | Wait for the reset, or move up a plan. |
server_error | 500 | Something went wrong on our side. It is logged and we look at every one. | Try again in a minute. If it keeps happening, open a ticket with the time and path. |
A 4xx comes back the same way however often it is sent, so fix the request before trying again.