ResponseStatus

Standard API response status envelope included in all responses.

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name	Type	Description
ErrorCode	integer	Error code. 0 indicates success.
Reason	string	Human-readable status message.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ResponseStatus",
  "description": "Standard API response status envelope included in all responses.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/cloud-ngfw-api-response-status-schema.json",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "type": "integer",
      "description": "Error code. 0 indicates success.",
      "example": 0
    },
    "Reason": {
      "type": "string",
      "description": "Human-readable status message.",
      "example": ""
    }
  }
}