Troubleshooting the APIs

This page explains how to decode and recover from errors when using the Device Management APIs.

Status codes and errors

If something unexpected happens when you're using the APIs, the most useful information is the HTTP status code. There are codes for successful operations as well.

The server returns success or failure information for a request using status codes, which are grouped by type:

• 200 range: Success.
• 300 range: Further action is required by the caller (you or the device).
• 400 range: Errors due to request input.
• 500 range: Errors on the Device Management servers.

Typical status and error code model

Status and error codes look like:

{
    "object": "error",
    "code": "<error_code>",  // HTTP status code, for example, 400.
    "type": "<error_type>",  // For example, "validation_error".
    "message": "A human-readable message with detailed info",
    "fields": [
        {
            "name": "<field_name>",
            "message": "A human-readable validation error"
        }
    ],
    "request_id": "<request_id>" // As assigned for the incoming request.
}

General error codes and types

The following is a description of some general HTTP error codes, along with what they mean in the context of Device Management. Most APIs also provide a list of specific error codes for each interface in the documentation.