The Sivo API is based on the RESTful pattern, which in turn relies on standard HTTP status codes. Your application can use the status code in the response to determine the result of the operation. In general, 2xx status codes indicate success. A 4xx status code indicates an issue with the request (unexpected arguments or invalid operation). A 5xx status code indicates that there was an error in the Sivo application (hopefully you will not see these, but if you do you can report to us and we'll work to resolve as soon as possible).

See the tables below for common status codes.

2xx Success

Status CodeDescription
200 - OKThe request succeeded
201 - CreatedThe request succeeded and a new resource was created
202 - AcceptedThe request has been accepted for processing, but processing has not completed.

4xx Request Errors

Status CodeDescription
401 UnauthorizedThe API token is invalid
403 ForbiddenThe account does not have permissions to execute the requested operation
404 Not FoundThe resource requested does not exists
409 ConflictThe request conflicts with another request. This could be related to the use of the same idempotent key in separate requests.
413 Payload Too LargeThe request exceeds the maximum supported size. For larger payloads it is recommended to use compression.
429 Too Many RequestsToo many requests have been issued over a short period of time.

5xx Server Errors

Status CodeDescription
500 Internal Server ErrorAn internal error occurred on the Sivo servers. Please contact support.
502 Bad GatewaySivo server received an unexpected response internally. Please contact support.
503 Service UnavailableThe server was unable to handle the request due to overload or maintenance. This is typically a temporary state. Please contact support if it persists.
504 Gateway TimeoutThe server did not receive an internal response in a timely manner. This is typically a temporary state. Please contact support if it persists.