profiles

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-profiles-schema.json",
  "title": "profiles",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-profiles-api-openapi.yml#/components/schemas/profiles",
  "additionalProperties": false,
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/profile"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "limit": {
      "default": 200,
      "description": "Maximum number of items returned",
      "format": "int32",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    },
    "offset": {
      "default": 0,
      "description": "Number of items skipped",
      "format": "int32",
      "minimum": 0,
      "type": "integer"
    },
    "total": {
      "description": "Total number of profile resources",
      "format": "int32",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "data",
    "offset",
    "total",
    "limit"
  ],
  "type": "object",
  "$defs": {
    "category-override": {
      "additionalProperties": false,
      "properties": {
        "action": {
          "description": "Action to take (allow, block, sinkhole, alert)",
          "enum": [
            "allow",
            "block",
            "sinkhole",
            "alert"
          ],
          "type": "string"
        },
        "category_id": {
          "description": "Category identifier",
          "type": "string"
        },
        "custom_sinkhole_id": {
          "description": "Custom sinkhole identifier",
          "type": "string"
        },
        "is_custom_sinkhole": {
          "description": "Whether a custom sinkhole is used",
          "type": "boolean"
        }
      },
      "required": [
        "category_id",
        "action"
      ],
      "type": "object"
    },
    "custom-fqdn-override": {
      "additionalProperties": false,
      "properties": {
        "action": {
          "description": "Action to take (allow, block, sinkhole, alert)",
          "enum": [
            "allow",
            "block",
            "sinkhole",
            "alert"
          ],
          "type": "string"
        },
        "custom_sinkhole_id": {
          "description": "Custom sinkhole identifier",
          "type": "string"
        },
        "id": {
          "description": "Unique identifier for the custom FQDN override",
          "type": "string"
        },
        "is_custom_sinkhole": {
          "description": "Whether a custom sinkhole is used",
          "type": "boolean"
        },
        "name": {
          "description": "Name of Custom FQDN Group",
          "type": "string"
        }
      },
      "required": [
        "name",
        "id",
        "action"
      ],
      "type": "object"
    },
    "edl-override": {
      "additionalProperties": false,
      "properties": {
        "action": {
          "description": "Action to take (allow, block, sinkhole, alert)",
          "enum": [
            "allow",
            "block",
            "sinkhole",
            "alert"
          ],
          "type": "string"
        },
        "custom_sinkhole_id": {
          "description": "Custom sinkhole identifier",
          "type": "string"
        },
        "id": {
          "description": "Unique identifier for the EDL override",
          "type": "string"
        },
        "is_custom_sinkhole": {
          "description": "Whether a custom sinkhole is used",
          "type": "boolean"
        },
        "name": {
          "description": "Name of EDL Override",
          "type": "string"
        }
      },
      "required": [
        "name",
        "id",
        "action"
      ],
      "type": "object"
    },
    "profile": {
      "additionalProperties": false,
      "properties": {
        "category_overrides": {
          "description": "List of category overrides applied to this profile",
          "items": {
            "$ref": "#/$defs/category-override"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "created_at": {
          "description": "Timestamp(UTC) when the profile was created",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "custom_fqdn_overrides": {
          "description": "List of custom FQDN overrides applied to this profile",
          "items": {
            "$ref": "#/$defs/custom-fqdn-override"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "description": {
          "description": "Description of the profile",
          "maxLength": 256,
          "type": "string"
        },
        "edl_overrides": {
          "description": "List of EDL overrides applied to this profile",
          "items": {
            "$ref": "#/$defs/edl-override"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier for the profile",
          "readOnly": true,
          "type": "string"
        },
        "last_updated_at": {
          "description": "Timestamp(UTC) when the profile was last updated",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "Profile name",
          "maxLength": 128,
          "type": "string"
        },
        "read_only": {
          "description": "Indicates if the profile is read-only",
          "readOnly": true,
          "type": "boolean"
        },
        "safesearch_enabled": {
          "description": "Enable SafeSearch filtering",
          "type": "boolean"
        },
        "youtube_restricted_mode": {
          "description": "YouTube restricted mode - 'moderate' or 'strict' when content filtering is enabled; absent when YouTube is unrestricted",
          "enum": [
            "moderate",
            "strict"
          ],
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "read_only",
        "created_at",
        "last_updated_at"
      ],
      "type": "object"
    }
  }
}