NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
List gateway policies List all gateway policies for specified Domain.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies
Delete GatewayPolicy Delete GatewayPolicy	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
Read gateway policy Read gateway policy for a domain.	GET /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
Update gateway policy Update the gateway policy for a domain. This is a full replace. All the rules are replaced. Performance Note: If you want to edit several rules in a gateway policy use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
Revise the positioning of gateway policy This is used to set a precedence of a gateway policy w.r.t others.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}?action=revise
Update gateway policy Update the gateway policy for a domain. This is a full replace. All the rules are replaced. Performance Note: If you want to edit several rules in a gateway policy, use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
List rules List rules	GET /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules
Delete rule Delete rule	DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Read rule Read rule	GET /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Update gateway rule Update the gateway rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a gateway policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains/<domain-id>/gateway-policies/<gateway-policy-id> Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.	PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Revise the positioning of gateway rule This is used to re-order a gateway rule within a gateway policy.	POST /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}?action=revise
Update gateway rule Update the gateway rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a gateway policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains/<domain-id>/gateway-policies/<gateway-policy-id> Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.	PUT /global-manager/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Get gateway rule statistics Get statistics of a 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}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics
Get gateway policy statistics Get statistics of a gateay 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}/gateway-policies/{gateway-policy-id}/statistics
Get Geo IP Setting Configuration API to retrieve the current Geo IP Setting Configuration.	GET /global-manager/api/v1/global-infra/geo-ip/setting
Patch Geo IP Setting Configuration This API can be used to activate or deactivate auto-download of Geo IP Bundle. Once auto-download is activated, Geo IP Bundle will be downloaded at regular intervals of 720 minutes (12 hrs).	PATCH /global-manager/api/v1/global-infra/geo-ip/setting
Update Geo IP Setting Configuration This API can be used to activate or deactivate auto-download of Geo IP Bundle. Once auto-download is activated, Geo IP Bundle will be downloaded at regular intervals of 720 minutes (12 hrs).	PUT /global-manager/api/v1/global-infra/geo-ip/setting
Get the list of gateway firewall dependent services Get the list of gateway firewall dependent services	GET /global-manager/api/v1/global-infra/settings/firewall/gateway/dependent-services
Get list of gateway policies with rules that belong to the specific Tier-0 logical router. Get filtered view of gateway rules associated with the Tier-0. The gateay policies are returned in the order of category and precedence.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/gateway-firewall
Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices. Get filtered view of Gateway Firewall rules associated with the Tier-0 Locale Services. The gateway policies are returned in the order of category and sequence number.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/gateway-firewall
Delete security config API has been deprecated as the delete of Tier0SecurityConfig is linked with the deletion of T0. To remove a particular feature from T0SecurityConfig please use PUT/PATCH.	DELETE /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/security-config (Deprecated)
Read Security Feature Read Security Feature.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/security-config
Create or Update security configuration Create a T0 security configuration if it is not already present, otherwise update the security configuration.	PATCH /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/security-config
Create or Update security configuration Create or update security configuration.	PUT /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/security-config
Get list of gateway policies with rules that belong to the specific Tier-1. Get filtered view of Gateway Firewall rules associated with the Tier-1. The gateway policies are returned in the order of category and sequence number.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/gateway-firewall
Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices. Get filtered view of Gateway Firewall rules associated with the Tier-1 Locale Services. The gateway policies are returned in the order of category and sequence number.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/gateway-firewall
Read Security Feature Read Security Feature.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/security-config
Create or Update security configuration Create a security configuration if it is not already present, otherwise update the security configuration.	PATCH /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/security-config
Create or Update security configuration Create or update security configuration.	PUT /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/security-config