NSX-T Data Center REST API

Associated URIs:

API Description API Path

List IDS PCAP file metadata


List IDS PCAP file metadata.
Currently this is a node specific API and it will return the list
of PCAP metadata for a specific node.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps

Download exported pcap file


Download the exported pcap file generated from the export IdsPcapFile api. The request
should have proper headers set to download the file. Please add the below
two headers, if it is not already present
Accept application/json, text/plain, */*
Accept-Encoding gzip, deflate, br

Currently this is a node specific API and it will download the PCAP
file from the specific node only. If PCAP file is not present on the specific
node, validation error will be thrown.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/{file-name}/download
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps/{file-name}/download

Delete the IDS Pcap File


Delete IDS Pcap file entry from corfu and from file system.
Currently this is a node specific API and it will delete the PCAP
metadata and file for the specific node only. If PCAP file is not
present on the specific node, validation error will be thrown.
DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/{id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps/{id}

Request the IDS Pcap File Download


Trigger the process to collect all pcap files of all the pcap_ids mentioned in request payload.
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/export (Experimental)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps/export (Experimental)

List IDS profiles


List intrusion detection profiles.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles

Delete IDS profile


Delete intrusion detection profile.
DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}

Get IDS profile.


Read intrusion detection profile
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}

Patch IDS profile


Patch intrusion detection system profile.
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}

create or update IDS profile


Update intrusion detection profile.
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}

Get IDS profile signatures.


Get all the IDS signatures attached to the Profile.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}/effective-signatures (Experimental)

List Malware Prevention profiles


List Malware Prevention profiles.
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles

Delete Malware Prevention profile


Delete Malware Prevention profile.
DELETE /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/{profile-id}

Get Malware Prevention profile.


Read Malware Prevention profile
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/{profile-id}

Patch Malware Prevention profile


Patch Malware Prevention profile.
PATCH /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/{profile-id}

Create or Update Malware Prevention profile


Update Malware Prevention profile.
PUT /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/{profile-id}

List Malware Prevention signatures


List Malware Prevention signatures.
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/signatures