Relay uses conventional HTTP response codes to indicate the success or failure of an API request.
HTTP Status Codes
In general, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Relay's servers.
Status Code
Description
400 Bad Request
The request was unacceptable, often due to missing a required parameter. Validation failures will include an issues array detailing the exact fields.
401 Unauthorized
No valid API key provided, or invalid session token.
403 Forbidden
The API key doesn't have permissions to perform the request (e.g. requires admin or owner role).
404 Not Found
The requested resource doesn't exist, or you lack permissions to view it.
409 Conflict
The request conflicts with another resource (e.g. API with this slug already exists in the workspace).
429 Too Many Requests
Too many requests hit the API too quickly.
500, 502, 503, 504
Server Errors — Something went wrong on Relay's end.