The API uses the default HTTP codes to indicate both the success of a request and the failure:
| Código | Descrição |
|---|---|
| 200 | The request was processed successfully. |
| 201 | The request was successfully processed and a new record was created (POST requests). |
| 400 | Some mandatory parameter was not sent, or the parameters sent are not correct. |
| 401 | You are not authorized to access the endpoint. Check if the Authorization header has been sent. |
| 403 | You are not authorized to access the endpoint. Check if the Authorization header is correct. |
| 404 | Endpoint or resource not found. Review the URL. |
| 409 | Conflict to perform the operation (eg. record already exists in a POST). Inspect the error for more details. |
| 429 | Too many requests. Check the following headers: - X-RateLimit-Limit - X-RateLimit-Remaining - X-RateLimit-Reset |
| 500 | Gupy internal error. Retry your request and, in case the error persists, contact our support. |
In addition to HTTP codes, the API returns information about the error in the response body. For example:
GET /api/v1/jobs?page=1&perPage=_val_
Host: api.gupy.io
Authorization: Bearer 1c3ce6b8251d91c1112aa11d1ef2daa1
{
"title": "Validation Error",
"detail": "Invalid perPage param: _val_ must be integer",
"status": 400
}