NSX-T Data Center Global Manager REST API

Associated URIs:

API Description API Path

List distributed firewall security policies


List all distributed firewall (DFW) security policies for a domain.
GET /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies

Delete a distributed firewall security policy


Delete a distributed firewall (DFW) security policy along with all its rules.
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}

Read a distributed firewall security policy


Read a distributed firewall (DFW) security policy for a domain.
GET /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}

Patch a distributed firewall security policy


Create or partially update a distributed firewall (DFW) security policy for a domain.
If a security policy for the given security-policy-id is not present, the object will
get created and if it is present it will be updated. This is a full replace.
Performance Note: If you want to edit several rules in a security 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}/security-policies/{security-policy-id}

Revise the positioning of a distributed firewall security policy


This is used to set a precedence of a distributed firewall (DFW) security policy w.r.t others.
POST /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}?action=revise

Create or update a distributed firewall security policy


Create or update a distributed firewall (DFW) security 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 security 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}/security-policies/{security-policy-id}

List distributed firewall rules in a security policy


Returns a paginated list of all distributed firewall rules within a specific security
policy.
GET /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules

Delete a distributed firewall rule


Delete a distributed firewall (DFW) rule from a security policy.
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}

Read a distributed firewall rule by ID


Returns the configuration of a specific distributed firewall rule within a security
policy.
GET /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}

Patch a distributed firewall rule


Create or partially update a distributed firewall (DFW) rule within a security policy.
If a rule with the given rule-id does not exist it will be created; otherwise only the
specified fields will be updated.
Performance Note: If you want to edit several rules in a security 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>/security-policies/<security-policy-id>
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}

Revise the positioning of a distributed firewall rule


This is used to re-order a distributed firewall (DFW) rule within a security policy.
NOTE: Default rule sequence numbers cannot be modified.
POST /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}?action=revise

Create or update a distributed firewall rule


Create or update a distributed firewall (DFW) rule within a security policy.
If a rule with the given rule-id does not exist it will be created; otherwise it will be
replaced in full.
Performance Note: If you wish to edit several rules in a security 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>/security-policies/<security-policy-id>
PUT /global-manager/api/v1/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}

Import K8s network policies to DFW Security Policies


This is used to import a set of K8s network policies into DFW security
policies
POST /global-manager/api/v1/global-infra/import-k8s-np-to-dfw