NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List gateway policies List all gateway policies for specified Domain.	GET /policy/api/v1/infra/domains/{domain-id}/gateway-policies GET /policy/api/v1/global-infra/domains/{domain-id}/gateway-policies GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies
Delete GatewayPolicy Delete GatewayPolicy	DELETE /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
Read gateway policy Read gateway policy for a domain.	GET /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id} GET /policy/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}?action=revise POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}
List rules List rules	GET /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules GET /policy/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules
Delete rule Delete rule	DELETE /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Read rule Read rule	GET /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id} GET /policy/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}?action=revise POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/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 /policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}