Policy > Networking > Network Services > Forwarding Policies

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/infra/domains/<domain-id>/forwarding-policies
GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies

Delete forwarding policy


Delete forwarding policy. 		DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>

Read forwarding policy


Read forwarding policy.
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
GET /policy/api/v1/global-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/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/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

Delete ForwardingRule


Delete ForwardingRule 		DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>

Read rule


Read rule 		GET /policy/api/v1/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>

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//forwarding-policies/
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//forwarding-policies/
PUT /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>