Table of contents


The HTTP Status Code in the response will indicate whether the request was successful or not. Any 2xx request is considered successful.

If a request is unsuccessful, the status code will reflect what went wrong. The most common failures are:

  • 404 - Not found: The resource you are attempting to retrieve was not found
  • 401 - Unauthorized: You do not have permission to access the resource
  • 400 - Bad Request: The request you made is bad and must be changed before it is retried
  • 500 - Internal Server Error: Something went wrong internally, you should wait and try again before reporting the issue

Error details

In most cases, the body for non 2xx responses will contain a JSON object describing the error in the following format:

	"error": "{error-message}"
  • {error-message} - (string) A human readable description of the error

Error messages are safe to present to users.

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.