NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List forwarding policies for the given domain List all forwarding policies for the given domain ordered by precedence.	GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies GET /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies
Delete forwarding policy Delete forwarding policy.	DELETE /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Read forwarding policy Read forwarding policy.	GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> GET /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Create or update forwarding policy Create or update the forwarding policy. Performance Note: If you want to edit several rules in a forwarding 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/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> PATCH /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Create or update forwarding policy Create or update the forwarding policy. Performance Note: If you want to edit several rules in a forwarding 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/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> PUT /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
List rules List rules	GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules GET /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
Get forwarding rule statistics. Get aggregated statistics of Forwarding Policy Rule. Stats include total number of packets and total number of bytes for the 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 /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<forwarding-rule-id>/statistics
Delete ForwardingRule Delete ForwardingRule	DELETE /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id> DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Read rule Read rule	GET /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id> GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id> GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Update forwarding rule Create a rule with the rule-id is not already present, otherwise update the rule. Performance Note: If you want to edit several rules in a forwarding 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>/forwarding-policies/<forwarding-policy-id>	PATCH /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id> PATCH /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Update forwarding rule Create a rule with the rule-id is not already present, otherwise update the rule. Performance Note: If you want to edit several rules in a forwarding 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>/forwarding-policies/<forwarding-policy-id>	PUT /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id> PUT /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Get forwarding policy statistics. Get aggregated stattistics of Forwarding Policy. Stats include total number of packets and total number of bytes for all Forwarding rules in a given Forwarding 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 /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/statistics
Reset Forwarding rule statistics Sets Forwarding Policy 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 /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/stats?action=reset