F5 Networks · Schema

ErrorResponse

Standard error response from the iControl REST API.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name Type Description
code integer HTTP status code.
message string Error message describing what went wrong.
errorStack array Stack trace for debugging (when available).
apiError integer API-specific error code.
View JSON Schema on GitHub

JSON Schema

bigip-icontrol-rest-error-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorResponse",
  "type": "object",
  "description": "Standard error response from the iControl REST API.",
  "properties": {
    "code": {
      "type": "integer",
      "description": "HTTP status code."
    },
    "message": {
      "type": "string",
      "description": "Error message describing what went wrong."
    },
    "errorStack": {
      "type": "array",
      "description": "Stack trace for debugging (when available)."
    },
    "apiError": {
      "type": "integer",
      "description": "API-specific error code."
    }
  }
}