NSX-T Data Center REST API

Associated URIs:

API Description API Path

List IDS PCAP file metadata


List IDS PCAP file metadata.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps
GET /policy/api/v1/global-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
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/{file-name}/download
GET /policy/api/v1/global-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.
DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/{id}
DELETE /policy/api/v1/global-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/global-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)

This routine will list IDS profiles


This routine will list all IDS profiles present in system.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles
GET /policy/api/v1/global-infra/settings/firewall/security/intrusion-services/profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles

This routine will Delete existing IDS profile


This routine will delete IDS profile for provided profile id
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}

This routine will get existing IDS Profile .


This routine will read intrusion detection profile for provided profile id
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
GET /policy/api/v1/global-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}

This routine will create IDS profile.


User can provide Profile Severity, Criteria and Override the Signature in the request
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}

This routine will create or update IDS profile


This routine will create or update IDS profile. User can provide Profile Severity, Criteria and can also Override the Signature in the request
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)
GET /policy/api/v1/global-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