Palo Alto Networks · JSON Structure

Cortex Xsoar Api Incident Structure

A Cortex XSOAR incident representing a security event under investigation.

Type: object Properties: 20
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Incident is a JSON Structure definition published by Palo Alto Networks, describing 20 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name type status severity owner created modified occurred closed closeReason closeNotes labels details investigationId playbookId sourceInstance sourceBrand rawJson CustomFields

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/cortex-xsoar-api-incident-structure.json",
  "name": "Incident",
  "description": "A Cortex XSOAR incident representing a security event under investigation.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique incident identifier."
    },
    "name": {
      "type": "string",
      "description": "Incident name or title."
    },
    "type": {
      "type": "string",
      "description": "Incident type (maps to an incident type definition)."
    },
    "status": {
      "type": "int32",
      "description": "Incident status code: 0 (Pending), 1 (Active), 2 (Done), 3 (Archive).",
      "enum": [
        0,
        1,
        2,
        3
      ]
    },
    "severity": {
      "type": "int32",
      "description": "Severity level: 0 (Unknown), 1 (Informational), 2 (Low), 3 (Medium), 4 (High), 5 (Critical).",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5
      ]
    },
    "owner": {
      "type": "string",
      "description": "Username of the analyst assigned to this incident."
    },
    "created": {
      "type": "datetime",
      "description": "Incident creation timestamp."
    },
    "modified": {
      "type": "datetime",
      "description": "Last modification timestamp."
    },
    "occurred": {
      "type": "datetime",
      "description": "Timestamp when the security event occurred."
    },
    "closed": {
      "type": "datetime",
      "description": "Incident closure timestamp."
    },
    "closeReason": {
      "type": "string",
      "description": "Reason for closing the incident."
    },
    "closeNotes": {
      "type": "string",
      "description": "Notes added when closing the incident."
    },
    "labels": {
      "type": "array",
      "description": "Key-value label pairs attached to the incident.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "details": {
      "type": "string",
      "description": "Incident details or description."
    },
    "investigationId": {
      "type": "string",
      "description": "Associated investigation ID."
    },
    "playbookId": {
      "type": "string",
      "description": "Playbook assigned to this incident."
    },
    "sourceInstance": {
      "type": "string",
      "description": "Integration instance that created this incident."
    },
    "sourceBrand": {
      "type": "string",
      "description": "Integration brand that created this incident."
    },
    "rawJson": {
      "type": "string",
      "description": "Raw JSON payload from the originating event."
    },
    "CustomFields": {
      "type": "object",
      "description": "Custom field values specific to the incident type.",
      "additionalProperties": true
    }
  }
}