Response Codes and Messages

This document includes an overview of the response status codes you might experience when using our APIs and what they mean in our ecosystem.

2xx Status Codes [Success]

200 – OK
204 – Success: is used in the authentication endpoints, depending on the URL endpoint the status means a successful operation. Here is a description of the 204 for each endpoint:
- /v1/create-user User Created.
- /v1/confirm-user User Confirmed.
- /v1/forgot-password Confirmation code sent successfully.
- /v1/forgot-password-confirm Password reset successfully.
- /v1/change-password Successful password change.
- /v1/token-revoke Token was successfully revoked.
- /v1/forgot-password Confirmation code sent successfully.

307 – Temporary Redirect: Used to redirect the request to an object storage URL for large files: snapshots and chunks. It’s the success status code for those endpoints (snapshots/download, chunks/download).

401 – Unauthorized: The server couldn’t verify your credentials. This usually means your user credentials are invalid or missing, or access_token is invalid or expired. Make sure you’re sending the correct credentials with your request.
403 – Forbidden: You’ve been authenticated, but your permissions aren’t sufficient to complete this operation.
404 – Not Found: The server can’t locate the resource you’re requesting. This could be due to a typo in the endpoint path.
422 – Unprocessable Entity: The server understood your request, but there’s a semantic issue with the data you’ve provided. This often happens if required fields are missing, or the data format doesn’t match what the API expects. Review the request payload for any inconsistencies.

500 – Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request. Retry request.