Skip to content
Equnix Metal
show

Errors copied!

Equinix Metal 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 charge failed, etc.). Codes in the 5xx range indicate an error with Equinix Metal's servers (these are rare).

Code Summary
200 OK Everything worked as expected.
201 Create Everything worked as expected, the resource was created.
422 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid API key provided.
404 Not Found The requested resource doesn't exist.
500, 502, 503, 504 - Server Errors Something went wrong on Equinix Metal's end. (These are rare.)

Errors (4xx, 5xx) reported by the API will include a JSON error response. This response will be structured as one of the following:

{"error": "the error message"}

or

{"errors": ["one error", "another error"}

The JSON response is not guaranteed so check the HTTP status message. JSON may not be included if the error is reported by an API intermediary, like a loadbalancer service.