Palo Alto Networks · JSON Structure

Threat Vault Api Api Stats Structure

API usage statistics for the authenticated API key.

Type: object Properties: 2
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

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

Properties

success data

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/threat-vault-api-api-stats-structure.json",
  "name": "ApiStats",
  "description": "API usage statistics for the authenticated API key.",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "api_key": {
          "type": "string",
          "description": "Redacted API key identifier."
        },
        "quota": {
          "type": "int32",
          "description": "Daily request quota."
        },
        "remaining": {
          "type": "int32",
          "description": "Remaining requests in the current day."
        },
        "used": {
          "type": "int32",
          "description": "Number of requests used today."
        },
        "reset_time": {
          "type": "datetime",
          "description": "Timestamp when the quota resets."
        },
        "endpoint_usage": {
          "type": "object",
          "description": "Request counts broken down by endpoint.",
          "additionalProperties": {
            "type": "int32"
          }
        }
      }
    }
  }
}