toc
Relay Error Codes
Quickly resolve Relay errors.
Reference
If you received a failed response from Relay that included an X-Evervault-Error-Code header or if you received a JSON response with an evervault-error-code field in the case of programmatic access, you can use this Relay error code reference to help resolve the issue.
subdomain-not-found
Cause
This error indicates you are sending a request to a Relay (e.g my-api-com.relay.evervault.com) which doesn't exist.
Resolution
First, ensure you have entered the Relay subdomain correctly. Also, ensure you have configured your Relay correctly by following our Relay documentation.
If you are still having issues, please contact support.
request-timeout
Cause
This error indicates that the target timed out as it took too long to respond. The error can have a multitude of causes ranging from network issues to malformed client requests.
Resolution
Ensure the target domain URL is correct, wait a few moments and try again. If the error persists, reach out to the owner of the target domain through any support channels they have in place.
service-unavailable
Cause
This error indicates that the target refused the connection and could not be reached.
Resolution
Ensure the target host is healthy. One way you can check this is by pinging the target, e.g.
bashping api.acme.com
If you can confirm that the target host is unhealthy, follow the support channels that the owner of that host has in place. Otherwise, wait a few minutes and try again.
We recommend that you implement retry behaviour to mitigate the impact of brief issues with the network or target host.internal-server-error
Cause
This error code indicates that there was an issue with Relay itself.
Resolution
Try again in a few moments. If the issue persists, reach out to support.
relay-not-found
Cause
This error indicates there was an issue finding a Relay for the provided domain.
Resolution
Make sure you are using the correct domain. If your domain is correct but you are still seeing this issue, ensure you have Relay configured correctly by following our Relay documentation.
If your Relay is configured correctly and you are still having issues, please contact support.
unsupported-content-type-in-response
Cause
This error occurs when Relay is configured to perform response encryption and receives an unsupported content type as a response from the endpoint. Currently, Relay only can only encrypt JSON and XML structured data.
Resolution
Determine whether is possible to get a response from the endpoint in a format supported by Relay. If so, perform the necessary changes.
If not, one way to get around this limitation is to move your request logic into a Cage in which you parse the plaintext into a suitable form, encrypt it and return it to the client.
proxy-auth-failed
Cause
This error indicates that there was an issue authenticating with the provided API key.
Resolution
We recommend that you follow our guide on how to authenticate with Relay. Also, ensure you are using the correct API key. If you have followed these steps and the issue still persists, please reach out to support.
encrypted-data-in-field
Cause
This error indicates that there was encrypted data where it wasn't expected. This can mean a number of things:
An inbound request header value contained Evervault encrypted data.
An inbound request payload had Evervault encrypted data as the value of one of the fields which was not going to be encrypted.
The target URI for the inbound request had Evervault encrypted data as part of the path.
These checks are to avoid Relay behaving as a decryption oracle when an endpoint reflects some of the payload.Resolution
Ensure requests being made to the inbound Relay do not contain Evervault encrypted data in the URI path, payload, or headers.
If you have confirmed that the above three situations are not occurring with requests and the error persists, please reach out to support
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. Often, this error can arise from a malformed URL string. Please check that the URL is correct and doesn't contain backslashes or other invalid characters. This error can also arise if you are attempting to send a file that is too large for the target domain. In this case, compress the file and try again.
If the issue persists, please contact support.
forbidden-destination
Cause
This error indicates that your app has made an outbound request to a destination that isn't trusted by Relay.
Resolution
If the destination is trustworthy, add the domain to the list of Outbound Destinations in the Dashboard by going to Settings -> Outbound Destinations -> Configure Destinations.