toc
Cages Error Codes
Quickly resolve Cages errors.
Reference
If you received a failed response from the Cage Run API that included an X-Evervault-Error-Code header or if you received a JSON response with an evervaultErrorCode field in the case of programmatic access, you can use this error code reference to help resolve the issue.
request-timeout
Cause
This error indicates that the cage run timed out as it took too long to complete.
Resolution
Ensure all paths in your cage complete within the timeout specified in the Cages reference.
decryption-error
Cause
This error indicates that there was an issue decrypting the data passed to the cage.
Resolution
Ensure that the data being passed to the cage was encrypted by the same team that owns the cage.
unauthorized
Cause
This error indicates that you are not authorized to access the resource you are requesting.
Resolution
Ensure that you have included the correct api key in your request.
bad-request
Cause
This error indicates that the server is unable (or refuses) to process the request sent by the client, due to an issue that is perceived by the server to be a client problem.
Resolution
A bad-request error is quite a vague error that doesn't indicate the exact issue but it is usually a client-side problem. Start by double checking that your cage name and version are correct.
If the issue persists, please contact support.
resource-not-found
Cause
This indicates that the API is unable to find the resource you have requested.
Resolution
The first step here would be to confirm that your cage name is correct. If that doesn't resolve your issue, please contact support.
internal-error
Cause
This error indicates that there was an issue with Cages itself.
Resolution
Try again in a few moments. If the issue persists, reach out to support.
forbidden-ip-error
Cause
This error indicates that the IP address of the client which invoked the Cage is not present in the IP whitelist.
Resolution
Ensure that your Cage’s IP whitelist is correctly defined and includes any tenants that you expect to invoke the Cage.
run-token-validation-error
Cause
This error indicates that the run token used in the run request is failing to verify.
Resolution
Ensure that the run token being returned from the SDK has not been altered in any way.
run-token-expired
Cause
This error indicates that the run token used in the run request has expired. Run tokens have a time to live of five minutes.
Resolution
Ensure that the run token is used within 5 minutes of creation.
payload-verification-error
Cause
This error indicates that the payload in the run request does not match that used to create the run token.
Resolution
Ensure that the same payload is used when creating the run token and running the cage.
run-token-used-error
Cause
This error indicates that the run token has already been used. Run tokens are single use only.
Resolution
Generate a new run token to be able to run the cage again.