BPACheck

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BPACheck",
  "description": "BPACheck schema from Palo Alto Networks AIOps for NGFW BPA API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/aiops-ngfw-bpa-api-bpa-check-schema.json",
  "type": "object",
  "properties": {
    "check_id": {
      "type": "string",
      "description": "Unique identifier of the check."
    },
    "category": {
      "type": "string",
      "description": "Best practice category this check belongs to."
    },
    "name": {
      "type": "string",
      "description": "Name of the best practice check."
    },
    "description": {
      "type": "string",
      "description": "Description of what this check evaluates."
    },
    "status": {
      "type": "string",
      "enum": [
        "pass",
        "fail",
        "not_applicable"
      ],
      "description": "Result status of this check."
    },
    "severity": {
      "type": "string",
      "enum": [
        "informational",
        "low",
        "medium",
        "high",
        "critical"
      ],
      "description": "Severity if this check fails."
    },
    "current_value": {
      "type": "string",
      "description": "Current configuration value found on the device."
    },
    "recommended_value": {
      "type": "string",
      "description": "Recommended configuration value per best practices."
    },
    "remediation": {
      "type": "string",
      "description": "Step-by-step remediation guidance for failed checks."
    },
    "references": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Reference URLs with additional guidance."
    }
  }
}