NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
List IDS gateway policies List all IDS gateway policies for specified Domain.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies
Delete IDS GatewayPolicy Delete IDS GatewayPolicy	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}
Read IDS gateway policy Read IDS gateway policy for a domain.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}
Update IDS gateway policy Update the IDS gateway policy for a domain.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}
Revise the positioning of IDS gateway policy This is used to set a precedence of a IDS gateway policy w.r.t others.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}?action=revise
Update IDS gateway policy Update the IDS gateway policy for a domain.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}
List IDS Gateway rules List IDS Gateway rules	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules
Delete IDS Gateway rule Delete IDS Gateway rule	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}
Read IDS rule Read IDS rule	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}
Update IDS gateway rule Update the gateway rule.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}
Revise the positioning of IDS gateway rule This is used to re-order a IDS gateway rule within a IDS gateway policy.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}?action=revise
Create or Update IDS gateway rule Create or Update the IDS gateway rule.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}
Get IDS gateway rule statistics Get statistics of a IDS gateway rule. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}/statistics
Get IDS gateway policy statistics Get statistics of a IDS gateway policy. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/statistics
List IDS security policies List intrusion detection system security policies.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies
Get IDS-IPS rule statistics Get statistics of a IDS-IPS rule. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/rules/{rule-id}/statistics
Get IDS security policy statistics Get statistics of a IDS security policy. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/statistics
Delete IDS security policy Delete intrusion detection system security policy.	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
Get IDS security policy. Read intrusion detection system security policy.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
Patch IDS security policy Patch intrusion detection system security policy for a domain.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
Revise the positioning of IDS security policies This is used to set a precedence of a security policy w.r.t others.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}?action=revise
create or update IDS security policy Update intrusion detection system security policy for a domain.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
List IDS rules List intrusion detection rules.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules
Delete IDS rule Delete intrusion detection rule.	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
Get IDS rule. Read intrusion detection rule	GET /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
Patch IDS rule Patch intrusion detection system rule.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
Revise the positioning of IDS rule This is used to re-order a rule within a security policy.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}?action=revise
create or update IDS rule Update intrusion detection system rule.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
Get the list of gateways where an intrusion event was detected Get the list of gateways where an intrusion event matching a signature was detected.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/affected-ips
Get the list of the users affected for that signature Get the list of the users affected pertaining to a specific signature.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/affected-users
Get the list of the VMs affected for that signature Get the list of the VMs affected pertaining to a specific signature.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/affected-vms
List IDS cluster configs List intrusion detection system cluster configs.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/cluster-configs
Read IDS cluster config. Read intrusion detection system cluster config	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/cluster-configs/{cluster-config-id}
List Global IDS signatures List global intrusion detection signatures.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/gsm/global-signatures
Delete Global IDS signature Delete global intrusion detection signature.	DELETE /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/gsm/global-signatures/{signature-id}
Get Global IDS signature. Read global intrusion detection signature	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/gsm/global-signatures/{signature-id}
Patch Global IDS Signature Patch global intrusion detection system signature.	PATCH /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/gsm/global-signatures/{signature-id}
create or update Global IDS Signature Update global intrusion detection signature.	PUT /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/gsm/global-signatures/{signature-id}
Get the list of the IDS events that are detected, grouped by signature id. Get the list of the IDS events that are detected with the total number of intrusions detected, their severity and the time they occurred, grouped by signature id.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/ids-events
Get the summary of the intrusions that were detected. Get the summary of all the intrusions that are detected grouped by signature with details including signature name, id, severity, attack type, protocol, first and recent occurence, and affected users and VMs. The following filter criteria are supported: attack target, attack type, gateway name, IP address, product affected, signature ID and VM name.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/ids-summary
List IDS PCAP file metadata List IDS PCAP file metadata.	GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/profiles/{profile-id}
Get IDS profile signatures. Get all the IDS signatures attached to the Profile.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/profiles/{profile-id}/effective-signatures (Experimental)
Get IDS signature versions Intrusion detection system signature versions.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signature-versions
Upload and replace IDS signatures bundle Upload and replace IDS signatures bundle	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signature-versions
Delete the IDS Signature Version along with signatures Delete the IDS Sgnature version along with signatures on GM .	DELETE /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signature-versions/{version-id}
List IDS signatures List intrusion detection system signatures.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signature-versions/{version-id}/signatures
Download and update IDS signatures Trigger the process to Download and update the IDS signatures manually.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signatures?action=update_signatures
Upload IDS signatures bundle Upload IDS signatures bundle	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signatures?action=upload_signatures
Get auto-update errors for airgapped sites. Get errors occurred during auto-update/update-now on airgapped sites.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signatures/airgapped-auto-update-errors
Get IDS signature status Intrusion detection system signatures status.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/signatures/status
List IDS signature version site mappings on GM List signature version site mappings on GM.	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings
List IDS signature version site mappings on GM List signature version site mappings on GM.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings
Delete IDS signature version site mapping on GM Delete IDS signature version site mapping on GM.	DELETE /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/{mapping-id}
Read IDS signature version site mapping on GM Read IDS signature version site mapping on GM	GET /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/{mapping-id}
Patch IDS signature version site mapping on GM Patch IDS signature version site mapping on GM	PATCH /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/{mapping-id}
Create or update IDS signature version site mapping on GM Create or update IDS signature version site mapping on GM	PUT /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/{mapping-id}
Reset IDS-IPS rule statistics Sets IDS-IPS rule statistics counter to zero. - no enforcement point path specified: Reset of stats will be executed for each enforcement point. - {enforcement_point_path}: Reset of stats will be executed only for the given enforcement point.	POST /global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/stats?action=reset