Errors
MineOS API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a value was invalid, etc.). Codes in the 5xx range indicate an error with Mine's servers (these are rare).
Some 4xx errors include an error description that briefly explains the problem.
| Status Code | Description |
|---|---|
| 200 OK | Everything worked as expected. |
| 400 Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 Unauthorized | No valid API key was provided. |
| 404 Not Found | The requested resource doesn't exist. |
| 429 Too Many Requests | Reserved for future use. Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 503 Server Error | Something went wrong on Mine's end. (These are rare.) |
Updated 12 months ago