Requests to the REST API use the common HTTP/1.1 methods. The methods allow users to read (GET), update (PUT), create (POST) and delete (DELETE) resources.
Responses also use the HTTP/1.1 status codes. Important status codes are as follows:
- 200 OK – The request has succeeded.
- 201 Created – The request has been fulfilled and the resource created.
- 202 Accepted – The request has been accepted but the processing is not complete. The response normally includes an ID for a Job which can be queried to get information about the progress of the requested task.
- 400 Bad Request – The request could not be understood the client should not repeat the request without modifications.
- 401 Unauthorized – The request requires authentication.
- 404 Not Found – The requested handler or resource was not found.
- 500 Internal Server Error – The server encountered an unexpected condition which has prevented it from fulfilling the request.
Further information regarding HTTP/1.1 and its supported methods and status codes can be found in the Hypertext Transfer Protocol specification https://tools.ietf.org/html/rfc2616.