NSX-T Data Center REST API

List IDS PCAP file metadata

List IDS PCAP file metadata.
This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps
/policy/api/v1/global-infra/settings/firewall/security/intrusion-services/pcaps
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps
Request Headers:
n/a
Query Parameters:
IdsPcapFileMetadataListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IdsPcapFileMetadataListResult+

Example Response:

{ "results": [ { "file_name": "ids_lm_pcap_1707899883864.tar.gz", "pcap_ids": [ "0006d06e-fb7c-fb0d-0006-1153673ad22f" ], "signature_ids": [ "2025638" ], "status": "READY", "file_size": 1192, "exported_on": "1707899884004", "available_until": "1707986284004", "node_id": "f7a20142-f794-20da-148f-a58f74491a1f", "resource_type": "IdsPcapFileMetadata", "id": "ids_lm_pcap_1707899883864", "display_name": "ids_lm_pcap_1707899883864", "path": "/infra/settings/firewall/security/intrusion-services/pcaps/ids_lm_pcap_1707899883864/site-id", "relative_path": "ids_lm_pcap_1707899883864", "parent_path": "/infra", "remote_path": "", "unique_id": "3c89dbd2-ecce-4f79-be46-278c1173a455", "realization_id": "3c89dbd2-ecce-4f79-be46-278c1173a455", "owner_id": "0d9b7345-f567-4fc8-a59d-4a5131e9d449", "marked_for_delete": false, "overridden": false, "_create_time": 1707899883949, "_create_user": "admin", "_last_modified_time": 1707899884048, "_last_modified_user": "system", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }, { "file_name": "ids_lm_pcap_1707971075146.tar.gz", "pcap_ids": [ "0002cebf-7b86-d82a-0006-115367d345c6" ], "signature_ids": [ "2025638" ], "status": "READY", "file_size": 1595, "exported_on": "1707971075191", "available_until": "1708057475191", "node_id": "f7a20142-f794-20da-148f-a58f74491a1f", "resource_type": "IdsPcapFileMetadata", "id": "ids_lm_pcap_1707971075146", "display_name": "ids_lm_pcap_1707971075146", "path": "/infra/settings/firewall/security/intrusion-services/pcaps/ids_lm_pcap_1707971075146/site-id", "relative_path": "ids_lm_pcap_1707971075146", "parent_path": "/infra", "remote_path": "", "unique_id": "e76b457e-a970-41fd-8e85-51140854b067", "realization_id": "e76b457e-a970-41fd-8e85-51140854b067", "owner_id": "0d9b7345-f567-4fc8-a59d-4a5131e9d449", "marked_for_delete": false, "overridden": false, "_create_time": 1707971075153, "_create_user": "admin", "_last_modified_time": 1707971075208, "_last_modified_user": "system", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } ], "result_count": 2, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_common_ids

Additional Errors: