Palo Alto Networks · Schema

Filter

A filter criterion for querying XSIAM resources.

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
field string Field name to filter on.
operator string
value object Filter value (string, integer, or array for the "in" operator).
View JSON Schema on GitHub

JSON Schema

cortex-xsiam-api-filter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Filter",
  "description": "A filter criterion for querying XSIAM resources.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/cortex-xsiam-api-filter-schema.json",
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "Field name to filter on."
    },
    "operator": {
      "type": "string",
      "enum": [
        "in",
        "contains",
        "gte",
        "lte",
        "eq",
        "neq"
      ]
    },
    "value": {
      "description": "Filter value (string, integer, or array for the \"in\" operator).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              }
            ]
          }
        }
      ]
    }
  },
  "required": [
    "field",
    "operator",
    "value"
  ]
}