Policy > Networking > Network Services

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

Create or update forwarding policy


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

List DPD profiles


Get paginated list of all DPD Profiles. 		GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles

Delete custom dead peer detection (DPD) profile


Delete custom dead peer detection (DPD) profile. Profile can not be deleted if profile has references to it. 		DELETE /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>

Get dead peer detection (DPD) profile


Get custom dead peer detection (DPD) profile, given the particular id. 		GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>

Create or patch a custom DPD Profile


Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. 		PATCH /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>

Create or fully replace a custom IPSec tunnel Profile


Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>

List IKE profiles


Get paginated list of all IKE Profiles. 		GET /policy/api/v1/infra/ipsec-vpn-ike-profiles

Delete custom IKE Profile


Delete custom IKE Profile. Profile can not be deleted if profile has references to it. 		DELETE /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>

Get IKE Profile


Get custom IKE Profile, given the particular id. 		GET /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>

Create or patch a custom internet key exchange (IKE) Profile


Create or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. 		PATCH /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>

Create or fully replace a custom internet key exchange (IKE) Profile


Create or fully replace custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>

List IPSec tunnel profiles


Get paginated list of all IPSec tunnel Profiles. 		GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles

Delete custom IPSec tunnel Profile


Delete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it. 		DELETE /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>

Get IPSec tunnel Profile


Get custom IPSec tunnel Profile, given the particular id. 		GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>

Create or patch a custom IPSec tunnel Profile


Create or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. 		PATCH /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>

Create or fully replace a custom IPSec tunnel Profile


Create or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>

List LBAppProfiles


Paginated list of all LBAppProfiles.
GET /policy/api/v1/infra/lb-app-profiles

Delete LBAppProfile and all the entities contained by this LBAppProfile


Delete the LBAppProfile along with all the entities contained
by this LBAppProfile.
DELETE /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Read LBAppProfile


Read a LBAppProfile.
GET /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Create or update a LBAppProfile


If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
PATCH /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Create or update a LBAppProfile


If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
PUT /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

List LBClientSslProfiles


Paginated list of all LBClientSslProfiles.
GET /policy/api/v1/infra/lb-client-ssl-profiles

Delete LBClientSslProfile and all the entities contained by this LBClientSslProfile


Delete the LBClientSslProfile along with all the entities contained
by this LBClientSslProfile.
DELETE /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Read LBClientSslProfile


Read a LBClientSslProfile.
GET /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Create or update a LBClientSslProfile


If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Create or update a LBClientSslProfile


If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

List LBMonitorProfiles for infra


Paginated list of all LBMonitorProfiles for infra.
GET /policy/api/v1/infra/lb-monitor-profiles

Delete LBMonitorProfile and all the entities contained by this LBMonitorProfile


Delete the LBMonitorProfile along with all the entities contained
by this LBMonitorProfile.
DELETE /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Read LBMonitorProfile


Read a LBMonitorProfile.
GET /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Create or update a LBMonitorProfile


If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Create or update a LBMonitorProfile


If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Read load balancer usage for the given node


API is used to retrieve node usage for load balancer which contains basic
information, LB entity usages and capacities for the given node.
Currently only edge node is supported.
The parameter ?node_path= is required. For example, ?node_path=
/infra/sites/default/enforcement-points/default/edge-clusters/
85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/
86e077c0-449f-11e9-87c8-02004eb37029.
GET /policy/api/v1/infra/lb-node-usage

Read load balancer node usage summary


The API is used to retrieve the load balancer node usage summary of all
nodes for every enforcement point.
- If the parameter ?include_usages=true exists, the property node_usages
are included in response. By default, the property node_usages is not
included in response.
- If parameter ?enforcement_point_path= exists,
only node usage summary from specific enforcement point is included
in response. If no enforcement point path is specified, information will
be aggregated from each enforcement point.
GET /policy/api/v1/infra/lb-node-usage-summary

List LBPersistenceProfiles for infra


Paginated list of all LBPersistenceProfiles for infra.
GET /policy/api/v1/infra/lb-persistence-profiles

Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfile


Delete the LBPersistenceProfile along with all the entities
contained by this LBPersistenceProfile.
DELETE /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Read LBPersistenceProfile


Read a LBPersistenceProfile.
GET /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

List LBPools


Paginated list of all LBPools.
GET /policy/api/v1/infra/lb-pools

Delete LBPool and all the entities contained by this LBPool


Delete the LBPool along with all the entities contained
by this LBPool.
DELETE /policy/api/v1/infra/lb-pools/<lb-pool-id>

Read LBPool


Read a LBPool.
GET /policy/api/v1/infra/lb-pools/<lb-pool-id>

Create or update a LBPool


If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
PATCH /policy/api/v1/infra/lb-pools/<lb-pool-id>

Create or update a LBPool


If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
PUT /policy/api/v1/infra/lb-pools/<lb-pool-id>

List LBServerSslProfiles


Paginated list of all LBServerSslProfiles.
GET /policy/api/v1/infra/lb-server-ssl-profiles

Delete LBServerSslProfile and all the entities contained by this LBServerSslProfile


Delete the LBServerSslProfile along with all the entities contained
by this LBServerSslProfile.
DELETE /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Read LBServerSslProfile


Read a LBServerSslProfile.
GET /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Create or update a LBServerSslProfile


If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Create or update a LBServerSslProfile


If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Read load balancer service usage summary


API is used to retrieve the load balancer usage summary for
all load balancer services.
If the parameter ?include_usages=true exists, the property service-usages
is included in the response. By default, service-usages is not included
in the response.
GET /policy/api/v1/infra/lb-service-usage-summary

List LBService


Paginated list of all LBService.
GET /policy/api/v1/infra/lb-services

Delete LBService and all the entities contained by this LBService


Delete the LBService along with all the entities contained by
this LBService.
DELETE /policy/api/v1/infra/lb-services/<lb-service-id>

Read LBService


Read an LBService.
GET /policy/api/v1/infra/lb-services/<lb-service-id>

Create or update a LBVirtualServer


If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
PATCH /policy/api/v1/infra/lb-services/<lb-service-id>

Create or update a LBService


If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
PUT /policy/api/v1/infra/lb-services/<lb-service-id>

Get LBService status information


Get LBService detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/detailed-status

Get LBPool status information


Get LBPool detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/detailed-status

Get LBPool statistics information


Get LBPoolStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/statistics

Get LBVirtualServer status information


Get LBVirtualServer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/detailed-status

Get LBVirtualServer statistics information


Get LBVirtualServerStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/statistics

Get LBService usage information


Get LBServiceUsage information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/service-usage

Get LBService statistics information


Get LBServiceStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/statistics

Retrieve a list of supported SSL ciphers and protocols


Retrieve a list of supported SSL ciphers and protocols.
GET /policy/api/v1/infra/lb-ssl-ciphers-and-protocols

List LBVirtualServers


Paginated list of all LBVirtualServers.
GET /policy/api/v1/infra/lb-virtual-servers

Delete LBVirtualServer and all the entities contained by this LBVirtualServer


Delete the LBVirtualServer along with all the entities contained by
this LBVirtualServer.
DELETE /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Read LBVirtualServer


Read a LBVirtualServer.
GET /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Create or update a LBVirtualServer


If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
PATCH /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Create or update a LBVirtualServer


If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
PUT /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

List Metadata Proxy Configurations


List all L2 Metadata Proxy Configurations 		GET /policy/api/v1/infra/metadata-proxies

Delete Metadata Proxy Config


API will delete Metadata Proxy Config with ID profile-id 		DELETE /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>

Get Metadata Proxy Config


API will read Metadata Proxy Config with ID profile-id 		GET /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>

Create or update Metadata Proxy Config


API will create or update Metadata Proxy Config with ID profile-id 		PATCH /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>

Create or update Metadata Proxy Config


API will create or update Metadata Proxy Config with ID profile-id 		PUT /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>

Get IPSec VPN service list result


Get paginated list of all IPSec VPN services
for given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services

Delete IPSec VPN service


Delete IPSec VPN service for given locale
service under Tier-0.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Get IPSec VPN service


Get IPSec VPN service for given locale
service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Create or patch IPSec VPN service


Create or patch IPSec VPN service for given locale
service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Create or fully replace IPSec VPN service


Create or fully replace IPSec VPN service for given
locale service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Get IPSec VPN local endpoint list result


Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints

Delete IPSec VPN local endpoint


Delete IPSec VPN local endpoint for a given locale
service under Tier-0.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a given locale
service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Create or patch a custom IPSec VPN local endpoint


Create or patch a custom IPSec VPN local endpoint
for a given locale service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Create or fully replace IPSec VPN local endpoint


Create or fully replace IPSec VPN local endpoint
for a given locale service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions
for a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions

Delete IPSec VPN session


Delete IPSec VPN session for a given locale
service under Tier-0.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data

Get IPSec VPN Session


Get IPSec VPN session without sensitive data
for a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for
a given locale service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a given
locale service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Get IPSec VPN session detailed status under Tier-0


- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status

Get IPSec VPN configuration for the peer site


Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config

Get IPSec VPN session statistics under Tier-0


- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Reset the statistics of the given VPN session


Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Get L2VPN service list result under Tier-0


Get paginated list of all L2VPN services under Tier-0. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services

Delete L2VPN service under Tier-0


Delete L2VPN service for given Tier-0 locale service. 		DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Get L2VPN service under Tier-0


Get L2VPN service for given Tier-0 locale service. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Create or patch L2VPN service under Tier-0


Create or patch L2VPN service for given Tier-0 locale service. 		PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Create or fully replace L2VPN service under Tier-0


Create or fully replace L2VPN service for given Tier-0 locale service. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Get L2VPN sessions list result under Tier-0


Get paginated list of all L2VPN sessions under Tier-0. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions

Delete L2VPN session under Tier-0


Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. 		DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Get L2VPN Session under Tier-0


Get L2VPN session under Tier-0. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Create or patch an L2VPN session under Tier-0


Create or patch an L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Create or patch an L2VPN session under Tier-0 from Peer Codes


Create or patch an L2VPN session under Tier-0 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code

Create or fully replace L2VPN session under Tier-0


Create or fully replace L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Get L2VPN session detailed status under Tier-0


- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status

Get Tier-0 L2VPN session configuration for the peer site


Get peer config for the Tier-0 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config

Get L2Vpn session remote mac for logical switch


Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac

Get L2VPN session statistics under Tier-0


- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics

List NAT Rules


List NAT Rules from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules

Delete NAT Rule


Delete NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule


Get NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section
denoted by <nat-id>.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Create or update a NAT Rule on tier-0


If a NAT Rule is not already present on Tier-0 denoted by Tier-0 ID,
under NAT section denoted by <nat-id>, create a new NAT Rule.
If it already exists, update the NAT Rule.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Update NAT Rule


Update NAT Rule on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule Statistics


Get NAT Rule Statistics from Tier-0 denoted by Tier-0 ID, under NAT section
denoted by <nat-id>.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics

List NAT Rules Statistics


List NAT Rules Statistics from Tier-0 denoted by Tier-0 ID. 		GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/statistics

Get IPSec VPN service list result


Get paginated list of all IPSec VPN services
for a given locale service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services

Delete IPSec VPN service


Delete IPSec VPN service for a given locale service under Tier-1. 		DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Get IPSec VPN service


Get IPSec VPN service for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Create or patch IPSec VPN service


Create or patch IPSec VPN service for a given locale
service under Tier-1.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Create or fully replace IPSec VPN service


Create or fully replace IPSec VPN service
for a given locale service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>

Get IPSec VPN local endpoint list result


Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints

Delete IPSec VPN local endpoint


Delete IPSec VPN local endpoint for a given locale
service under Tier-1.
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Create or patch a custom IPSec VPN local endpoint


Create or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1. 		PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Create or fully replace IPSec VPN local endpoint


Create or fully replace IPSec VPN local endpoint
for a given locale service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions

Delete IPSec VPN session


Delete IPSec VPN session for a given locale service under Tier-1. 		DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Get IPSec VPN Session


Get IPSec VPN session with senstive data for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data

Get IPSec VPN Session


Get IPSec VPN session without sensitive data for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for a given locale
service under Tier-1.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a given locale
service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Get IPSec VPN session detailed status under Tier-1


- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status

Get IPSec VPN configuration for the peer site


Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config

Get IPSec VPN session statistics under Tier-1


- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Reset the statistics of the given VPN session


Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Get L2VPN service list result under Tier-1


Get paginated list of all L2VPN services under Tier-1. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services

Delete L2VPN service under Tier-1


Delete L2VPN service for given Tier-1 locale service. 		DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Get L2VPN service under Tier-1


Get L2VPN service for given Tier-1 locale service. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Create or patch L2VPN service under Tier-1


Create or patch L2VPN service for given Tier-1 locale service. 		PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Create or fully replace L2VPN service under Tier-1


Create or fully replace L2VPN service for given Tier-1 locale service. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>

Get L2VPN sessions list result under Tier-1


Get paginated list of all L2VPN sessions under Tier-1. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions

Delete L2VPN session under Tier-1


Delete L2VPN session under Tier-1. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. 		DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Get L2VPN Session under Tier-1


Get L2VPN session under Tier-1. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Create or patch an L2VPN session under Tier-1


Create or patch an L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Create or patch an L2VPN session under Tier-1 from Peer Codes


Create or patch an L2VPN session under Tier-1 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code

Create or fully replace L2VPN session under Tier-1


Create or fully replace L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>

Get L2VPN session detailed status under Tier-1


- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status

Get Tier-1 L2VPN session configuration for the peer site


Get peer config for the Tier-1 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config

Get L2Vpn session remote mac for logical switch


Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac

Get L2VPN session statistics under Tier-1


- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics

List NAT Rules


List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules

Delete NAT Rule


Delete NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule


Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by <nat-id>.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Create or update a Nat Rule


If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID,
under NAT section denoted by <nat-id>, create a new NAT Rule.
If it already exists, update the NAT Rule.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Update NAT Rule


Update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. 		PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule Statistics


Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by <nat-id>.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics

List NAT Rules Statistics


List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID. 		GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/statistics