For the complete documentation index, see llms.txt. This page is also available as Markdown.
Cortex XSOAR 8 (SaaS)

Changes in this release

New Paths

POST /public_api/v1/system_diagnostics/data/papi/

Note: This endpoint is supported in XSOAR 8.13 On-prem and later.

Property
Value

Operation ID

getSystemHealthMetrics

Tag

System Management

Summary

Get System Health Metrics

Request body

None

Auth

authorization (api_key) + x-xdr-auth-id (api_key_id) headers

Availability

Cortex XSOAR 8.13 On-prem and later

Description: Retrieves system health metrics snapshots for the tenant. Each snapshot contains node metrics, component statuses, storage usage, queue depths, and external connectivity information. By default, returns data from the last 24 hours. Snapshots are ordered by timestamp descending (most recent first).

Response codes:

Code
Description

200

Successful response → SystemDiagnosticsResponse

400

Bad Request — invalid JSON

401

Unauthorized — authentication failure

402

Unauthorized — insufficient license

403

Forbidden — insufficient RBAC permissions

500

Internal server error


New Schemas

Schema
Type
Description

SystemDiagnosticsResponse

object

Top-level response wrapper with reply → SystemDiagnosticsResults

SystemDiagnosticsResults

object

Contains results array of snapshots

SystemDiagnosticsSnapshot

object

Point-in-time snapshot: timestamp, nodes, cluster_disk_usage, components, storage, queues, connectivity

NodeMetrics

object

Per-node health: name, cpu_usage, memory_usage, os_disk_usage, connected

ConnectivityStatus

object

External connectivity: connected, since, error

Note: The ErrorResponse schema (used by 400/401/402/403/500 responses) already existed in the baseline spec.

Last updated

Was this helpful?