Metrics Data Collection and Security Monitoring APIs Operations Index
All available Metrics Data Collection and Security Monitoring APIs Operations
Retrieves metadata about all configured health assessments, including the possible detail keys that each assessment produces.
Retrieves pre-computed health assessment results for specified resources. Supports complex filtering by assessment ID, resource type, specific resource IDs, related resource ID, health levels, and detail key-value pairs. Results are paginated for large datasets.
Gets information like description, unit, value_type, metric_type about the metric keys available for a resource type.
Gets time-series metrics data for a given resource_type and resource_id. Use the /key-info API to check which keys have 'is_time_series' set to 'true'. It can be used to fetch raw metrics and aggregated metrics for metrics keys. A distinct metric is defined by a combination of resource_type, site_id, node_id, resource_id, obj_id, and metric_key. Only a few metric keys support query time aggregation. Use the /key-info API to check which keys have aggregate_by_resource_ids set to 'true'.
Requests an export of time-series metrics data for a given resource_type and resource_ids.
Gets the last reported metric data for a given resource_type and resource_id. This can be a raw value or lifetime counter value. Use the /key-info API to check which keys have 'is_point_in_time' set to 'true'. A distinct metric is defined by a combination of resource_type, site_id, node_id, resource_id, obj_id, and metric_key.
Requests an export of point-in-time metrics data.
Gets information about reported objects corresponding to a resource_type, resource_ids and metric keys. Use this to filter out the data points on time-series or point-in-time APIs as needed.
Retrieves the current status of a previously initiated metrics export request.
Retrieves a list of resource IDs that have troubleshooting metrics data collection enabled for the specified category. Troubleshooting data collection enables enhanced metrics gathering for security monitoring and diagnostics. This endpoint supports optional filtering by resource IDs to check if specific resources are configured.
This endpoint supports filtering using query parameters:
resource_id: Filter by a single resource identifier (intent path).
The filter parameter is optional. If no filter is provided, all configured resource IDs for the category are returned. If resource_id is provided, only matching configured resource IDs are returned. If no match is found, an empty array is returned.
Updates the list of resource IDs that have troubleshooting metrics data collection enabled for the specified category. Troubleshooting data collection enables enhanced metrics gathering for security monitoring and diagnostics. This operation replaces the existing configuration with the provided resource IDs.
The request body must include the resource_ids array. The array can be empty to clear all configured resources for the category, or contain up to a maximum of 10 resource IDs. Each resource ID must be an intent path (the 'path' field on the NSX API output). For example, '/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1'.
Retrieve security monitoring summary for a site, including DFW and IDPS clusters status breakdowns with mode and category details.
Retrieve paginated list of cluster configurations for a site, including cluster details, health status, DFW/IDPS status, and remediation messages.