Errors

Edgemesh® 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 originated from the request. Codes in the 5xx range indicate an error with Edgemesh® servers (these are rare).

Some errors include an error code and/or description that briefly explains the error.

Attributes

boolean

Whether or not the request resulted in success.

code

number

The error code

type

string

The type of the error returned.

message

string

A brief description of the error.

errors

any[]

OPTIONAL

Any additional context for the error.

errors.

type

string

Type of the specific error.

errors.

message

string

Brief description of the error.

errors.

field

string

The field this error is associated with.

HTTP Status Code Summary

200	OK	Everything worked as expected.
400	Bad Request	The request was unacceptable, often due to missing a required header.
401	Unauthorized	No valid authentication was provided.
403	Forbidden	The Authentication provided doesn't have sufficient permissions to perform the request.
404	Not Found	The requested resource doesn't exist.
422	Unprocessable Entity	The request was unacceptable, often due to missing or malformed parameters.
429	Too Many Requests	Known as rate limiting, too many requests hit the API too quickly.
5XX	Server Errors	Something went wrong internally with Edgemesh. These errors are rare and are usually accompanied by a status update (incident).

Error Types

BAD_REQUEST	There was a problem with the request.
REQUIRED	A required parameter is missing.
VALIDATION_ERROR	Invalid parameters were supplied to the request. Details on the invalid parameters can be found in the `context` field.
UNAUTHORIZED	The request failed to provide a valid Authentication method.
FORBIDDEN	The supplied Authentication method does not have permission to access the requested resource.
BILLING	There was a problem with your account's payment. Visit the portal to resolve.
INTERNAL	An internal error occurred. Check https://status.edgemesh.com for known incidents and/or contact support.

Example Error

1{
2  "ok": false,
3  "code": 422,
4  "type": 'VALIDATION_ERROR',
5  "message": 'Parameter validation error.',
6  "errors": [{
7    "type": "REQUIRED",
8    "message": "The 'hostname' field is required.",
9    "field": "hostname"
10  }]
11}