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

f5-networks-errorresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorResponse",
  "title": "ErrorResponse",
  "type": "object",
  "description": "Standard error response from the iControl REST API.",
  "properties": {
    "code": {
      "type": "integer",
      "description": "HTTP status code.",
      "example": 400
    },
    "message": {
      "type": "string",
      "description": "Error message describing what went wrong.",
      "example": "The requested Pool (/Common/my_pool) was not found."
    },
    "errorStack": {
      "type": "array",
      "description": "Stack trace for debugging (when available).",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "apiError": {
      "type": "integer",
      "description": "API-specific error code.",
      "example": 10
    }
  }
}