Palo Alto Networks · Schema

ApiStats

API usage statistics for the authenticated API key.

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
success boolean
data object
View JSON Schema on GitHub

JSON Schema

threat-vault-api-api-stats-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiStats",
  "description": "API usage statistics for the authenticated API key.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/threat-vault-api-api-stats-schema.json",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "api_key": {
          "type": "string",
          "description": "Redacted API key identifier."
        },
        "quota": {
          "type": "integer",
          "description": "Daily request quota."
        },
        "remaining": {
          "type": "integer",
          "description": "Remaining requests in the current day."
        },
        "used": {
          "type": "integer",
          "description": "Number of requests used today."
        },
        "reset_time": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the quota resets."
        },
        "endpoint_usage": {
          "type": "object",
          "description": "Request counts broken down by endpoint.",
          "additionalProperties": {
            "type": "integer"
          }
        }
      }
    }
  }
}