API Error Handling

API Error Status

When the Intersight Web service cannot process a request, the HTTP response is returned with an HTTP status code, as specified in RFC 7231.

In addition to the HTTP error status code, the HTTP response body contains a JSON document that provides more details about the error. The JSON document contains a human readable message which is translated based on the value of the "accept-language" HTTP header.

For example, the Intersight Web service would return a 404 NotFound for the following GET request, because there is no compute.RackUnit with Moid "123".

GET https://www.us-east-1.intersight.com/api/v1/compute/RackUnits/123

The message body contains the following JSON document:

{
  "code": "NotFound",
  "message": "Object '123' does not exist",
  "messageId": "barcelona_request_object_does_not_exist",
  "messageParams": { "1": "123" },
  "traceId":"NBafa51f751fba4bb57d3696a8f610d681"
}

API Rate Limiting

To prevent abuse of the APIs, the Intersight APIs are rate limited. When too many requests are received, the client may receive an HTTP status code 429 Too Many Requests.