API Documentation

Error Responses

Search our documentation:

Toggle Documentation Menu

API: Error Responses

Jump to...
  • Authentication - The error that is returned when authentication fails
  • Validation - The error that is returned when the request is not valid
  • Timeout - The error that is returned when the request times out before completing
  • Server Problem - The error that is returned when the Ghost Inspector service is encountering problems

Authentication

The error that is returned when authentication fails.

Response
{
  "code": "ERROR",
  "errorType": "AUTHENTICATION_ERROR",
  "message": "User ID is invalid"
}

Validation

The error that is returned when the request is not valid.

Response
{
  "code": "ERROR",
  "errorType": "VALIDATION_ERROR",
  "message": "Test not found"
}

Timeout

The error that is returned when the connection exceeds our time limit.

Response
{
  "code": "ERROR",
  "errorType": "TIMEOUT_ERROR",
  "message": "Your execution is still in progress. Our API reached its timeout."
}

Server Issues

The error that is returned when the Ghost Inspector service is having issues.

Response
{
  "code": "ERROR",
  "errorType": "SERVER_ERROR",
  "message": "The Ghost Inspector service is encountering issues."
}