This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Errors

Learn about the Endor Labs REST API error codes and how to handle them

This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Learn about the Endor Labs REST API error codes and how to handle them

Endor Labs uses conventional gRPC and HTTP response codes to indicate the success or failure of an API request.

Note
When making API requests, always implement proper error handling to gracefully manage these response codes.
Value Code Name Description
0 OK Not an error; returned on success.
1 CANCELLED The caller typically cancelled the operation.
2 UNKNOWN Unknown error; typically indicates an unexpected error.
3 INVALID_ARGUMENT The client specified an invalid argument.
4 DEADLINE_EXCEEDED The deadline expired before the operation could complete.
5 NOT_FOUND The API did not find the requested entity, such as a file or directory.
6 ALREADY_EXISTS The entity that a client attempted to create already exists.
7 PERMISSION_DENIED The caller does not have permission to execute the specified operation.
8 RESOURCE_EXHAUSTED Some resource no longer has capacity, perhaps a per-user quota, or the entire file system is out of space.
9 FAILED_PRECONDITION The system is not in a state required for the operation’s execution.
10 ABORTED A concurrency issue like a sequencer check failure typically aborted the operation.
11 OUT_OF_RANGE The client attempted the operation beyond the valid range, such as seeking past the end of a file.
12 UNIMPLEMENTED The operation is not implemented or is not supported or enabled in this service.
13 INTERNAL Internal errors; the underlying system broke invariants it expected to hold.
14 UNAVAILABLE The service is currently unavailable. This is most likely a transient condition; retry with a backoff to recover.
15 DATA_LOSS Unrecoverable data loss or corruption.
16 UNAUTHENTICATED The request does not have valid authentication credentials for the operation.

Refer to the gRPC status code documentation for more information.

Value Code Name Description
200 OK Everything worked as expected.
400 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid API key provided.
402 Request Failed The parameters were valid but the request failed.
403 Forbidden The API key doesn’t have permissions to perform the request.
404 Not Found The requested resource doesn’t exist.
409 Conflict The request conflicts with another request, possibly due to using the same key.
429 Too Many Requests You sent too many API requests to Endor Labs in a short time. We recommend using an exponential backoff strategy for your requests.
“500, 502, 503, 504” Server Errors Something went wrong on the Endor Labs side (these are rare).
Note
When receiving a 429 status code, implement an exponential backoff strategy to avoid overwhelming the API.