API v1.0 Docs

Response Codes

The API returns HTTP status codes in addition to JSON-based error messages.

HTTP Status Codes


The Up2Share API trys to return appropriate HTTP status codes for every request.

Code Text Description
200 OK Success!
201 Created The resource has been created.
304 Not Modified There was no new data to return.
400 Bad Request The request was invalid or cannot be otherwise served.
401 Unauthorized Missing or incorrect API Key.
403 Forbidden The request is understood, but it has been refused or access is not allowed.
404 Not Found The resource requested does not exist.
413 Payload Too Large The request body is too large. It may occure when sending a large file using basic upload for example.
422 Unprocessable Entity Returned when the data is unable to be processed (for example, if the JSON body of a request is mal-formed).
429 Too Many Requests The request as exceeded rate limit. Try again later.
500 Internal Server Error Something is broken. This is usually a temporary error.
502 Bad Gateway The API is down, or being upgraded.
503 Service Unavailable The API is up, but overloaded with requests or being upgraded. Try again later.
504 Gateway timeout The API is up, but something is wrong with the internal server stack. Try again later.

Error Messages


The API error messages are returned in a JSON format. Here is an example:

{
    "message": "You have exceeded your rate limit.",
    "status_code": 429
}