HTTP status codes

We have a number of status codes in use in our product. Below is an overview of the common ones with some basic explanations for each.

200/201

Success: the operation succeeded as intended

The operation failed because of invalid user input. The error message explains how the used input was different from what was expected

Unauthorised: these credentials are invalid.

Insufficient permissions: this user does not have the required permissions to access this endpoint

Not Found: this resource cannot be found in our DB

Method Not Allowed: this operation is not allowed for this endpoint

Conflict: This request causes a conflict on our end

Payload too large: this file exceeds our page limit of 200 pages or size of 100 Mb

Unsupported Media Type: we do not support processing files of this file type

Unprocessable entity: the payload is corrupt or unreadable; we cannot understand this request and therefore are unable to process it

Too many request: we temporarily need to limit requests due to high load

Internal Server Error: this category contains various errors that might occur in the application on our end

Gateway timeout: this error will occur when the operation is taking longer than a fixed timeout threshold (default is 300 seconds)

Full list from API Reference (slate)