Skip to main content

Errors

This document outlines the errors returned by our APIs, formatted as ProblemDetails or ValidationProblemDetails.

ProblemDetails Format​

The ProblemDetails object contains the following properties:

  • type (string): A URI reference that identifies the problem type. This URI should provide human-readable documentation for the problem when dereferenced.
  • title (string): A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for localization purposes.
  • status (integer): The HTTP status code generated by the origin server for this occurrence of the problem.
  • instance (string): A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  • extensions (object): A dictionary of additional details about the error.

ValidationProblemDetails Format​

The ValidationProblemDetails object extends ProblemDetails and contains the following additional properties:

  • errors (object): A dictionary where the keys are the names of the invalid parameters, and the values are arrays of error messages associated with those parameters.

Common API Errors​

400 Bad Request​

Validation Errors​

{
  "type": "https://httpstatuses.io/400",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "projects/:projectId/providers/Aruba.Container/kaas",
  "errors": [ {
            "field": "Name",
            "message": "Location Value: string not found."
  }]
}

General Bad Request​

{
  "type": "https://httpstatuses.io/400",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be understood or was missing required parameters.",
  "instance": "projects/:projectId/providers/Aruba.Container/kaas"
}

500 Internal Server Error​

{
  "type": "https://httpstatuses.io/500",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred on the server.",
  "instance": "projects/:projectId/providers/Aruba.Container/kaas"
}