Get Troubleshooting Metrics Data Collection
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.
Site id in the query
The metrics data collection category for which to retrieve or update configured resource IDs. Only one category can be specified per request. Supported values include DISTRIBUTED_IDPS_HOST_TROUBLESHOOTING, DISTRIBUTED_IDPS_VM_TROUBLESHOOTING, and DISTRIBUTED_TLS_VM_STATS_COLLECTION. For DISTRIBUTED_IDPS_HOST_TROUBLESHOOTING and DISTRIBUTED_IDPS_VM_TROUBLESHOOTING, resource_ids must be of HostTransportNode resource type.
NSX resource ID for which troubleshooting metrics data collection is being queried. This 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'. Make sure the resource_id is associated with the correct category. If omitted, results are not filtered by resource ID.
Resource type for which troubleshooting metrics data collection is being queried. Supported resource type is HostTransportNode. If omitted, the resource type is inferred from the category.
Successfully retrieved the list of resource IDs that have troubleshooting metrics data collection enabled for the specified category. Returns an empty array if no resources match the filter criteria or if the specified resource_id is not found.
{
"_create_user": "string",
"_create_time": 0,
"_last_modified_user": "string",
"_last_modified_time": 0,
"_revision": 0,
"_resource_type": "string",
"_system_owned": false,
"id": "string",
"display_name": "string",
"description": "string",
"site_ids": [
"string"
],
"resource_ids": [
"string"
]
}Bad request. The request parameters are invalid or malformed.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Not found. The site or category was not found.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
An unexpected error occurred while processing the request.
"Error Object"HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/security-monitoring/sites/{site-id}/troubleshooting-metrics/{category}