Policy > Networking > Network Services > VPN

Associated URIs:

API Description API Path

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>

Get IPSec VPN service list result


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

Delete IPSec VPN service


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

Get IPSec VPN service


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

Create or patch IPSec VPN service


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

Create or fully replace IPSec VPN service


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

Delete IPSec VPN local endpoint


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

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a given ipsec vpn
service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-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
under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-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 ipsec vpn service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-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 ipsec vpn service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions

Delete IPSec VPN session


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

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given ipsec vpn service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-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 ipsec vpn service under Tier-0.
GET /policy/api/v1/infra/tier-0s/<tier-0-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 ipsec vpn service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-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
ipsec vpn service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/<tier-0-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>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)

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>/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>/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/global-infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Get IPSec VPN Session Summary


Summarized view of all tier-0 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/summary

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>/l2vpn-services

Delete L2VPN service under Tier-0


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

Get L2VPN service under Tier-0


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

Create or patch L2VPN service under Tier-0


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

Create or fully replace L2VPN service under Tier-0


Create or fully replace L2VPN service for given Tier-0. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/tier-0s/<tier-0-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>/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>/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>/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>/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>/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>/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>/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>/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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
GET /policy/api/v1/infra/tier-0s/<tier-0-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>/l2vpn-services/<service-id>/sessions/<session-id>/statistics

Get IPSec VPN service list result


Get paginated list of all IPSec VPN services
for given locale service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services (Deprecated)

Delete IPSec VPN service


Delete IPSec VPN service for given locale
service under Tier-0.
This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Get IPSec VPN service


Get IPSec VPN service for given locale
service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Create or patch IPSec VPN service


Create or patch IPSec VPN service for given locale
service under Tier-0.
This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/
ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Get IPSec VPN local endpoint list result


Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints (Deprecated)

Delete IPSec VPN local endpoint


Delete IPSec VPN local endpoint for a given locale
service under Tier-0.
This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a given locale
service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
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> (Deprecated)

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.
This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions
for a given locale service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions (Deprecated)

Delete IPSec VPN session


Delete IPSec VPN session for a given locale
service under Tier-0.
This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given locale service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
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 (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session without sensitive data
for a given locale service under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for
a given locale service under Tier-0.
This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
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 (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config instead.
Note:
Please note that request is validated and any error messages returned from validation may include
the new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
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 (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statisticsinstead.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)

Get IPSec VPN Session Summary


Summarized view of all tier-0 IPSec VPN sessions for a specified service.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/summary
instead.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary (Deprecated)

Get L2VPN service list result under Tier-0


Get paginated list of all L2VPN services under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services (Deprecated)

Delete L2VPN service under Tier-0


Delete L2VPN service for given Tier-0 locale service.
This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Get L2VPN service under Tier-0


Get L2VPN service for given Tier-0 locale service.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Create or patch L2VPN service under Tier-0


Create or patch L2VPN service for given Tier-0 locale service.
This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Get L2VPN sessions list result under Tier-0


Get paginated list of all L2VPN sessions under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions (Deprecated)

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.
This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Get L2VPN Session under Tier-0


Get L2VPN session under Tier-0.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use POST /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>?action=create_with_peer_code instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
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 (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/peer-config instead.
Note:
The "transport_tunnel_path" returned in the payload wil be a new vpn path instead of the deprecated API path.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)

Get L2Vpn session remote mac for logical switch


Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/remote-mac instead.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)

Get IPSec VPN service list result


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

Delete IPSec VPN service


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

Get IPSec VPN service


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

Create or patch IPSec VPN service


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

Create or fully replace IPSec VPN service


Create or fully replace IPSec VPN service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-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 ipsec vpn service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints

Delete IPSec VPN local endpoint


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

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a ipsec vpn
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-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 ipsec vpn service under Tier-1. 		PATCH /policy/api/v1/infra/tier-1s/<tier-1-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 ipsec vpn service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-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 ipsec vpn
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions

Delete IPSec VPN session


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

Get IPSec VPN Session


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

Get IPSec VPN Session


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

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for a ipsec vpn
service under Tier-1.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-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 ipsec vpn
service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/<tier-1-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>/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>/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>/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/global-infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Get IPSec VPN Session Summary


Summarized view of all tier-1 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/summary

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>/l2vpn-services

Delete L2VPN service under Tier-1


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

Get L2VPN service under Tier-1


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

Create or patch L2VPN service under Tier-1


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

Create or fully replace L2VPN service under Tier-1


Create or fully replace L2VPN service for given Tier-1. Revision is optional for creation and required for update. 		PUT /policy/api/v1/infra/tier-1s/<tier-1-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>/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>/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>/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>/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>/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>/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>/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>/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>/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>/l2vpn-services/<service-id>/sessions/<session-id>/statistics

Get IPSec VPN service list result


Get paginated list of all IPSec VPN services
for a given locale service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services (Deprecated)

Delete IPSec VPN service


Delete IPSec VPN service for a given locale service under Tier-1.
This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/psec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Get IPSec VPN service


Get IPSec VPN service for a given locale
service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Create or patch IPSec VPN service


Create or patch IPSec VPN service for a given locale
service under Tier-1.
This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)

Get IPSec VPN local endpoint list result


Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints (Deprecated)

Delete IPSec VPN local endpoint


Delete IPSec VPN local endpoint for a given locale
service under Tier-1.
This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

Get IPSec VPN local endpoint


Get IPSec VPN local endpoint for a given locale
service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
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> (Deprecated)

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.
This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
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> (Deprecated)

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions for a given locale
service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions (Deprecated)

Delete IPSec VPN session


Delete IPSec VPN session for a given locale service under Tier-1.
This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session with senstive data for a given locale
service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
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 (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session without sensitive data for a given locale
service under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for a given locale
service under Tier-1.
This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
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 (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
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 (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)

Get IPSec VPN Session Summary


Summarized view of all tier-1 IPSec VPN sessions for a specified service.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/summary
instead.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary (Deprecated)

Get L2VPN service list result under Tier-1


Get paginated list of all L2VPN services under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services (Deprecated)

Delete L2VPN service under Tier-1


Delete L2VPN service for given Tier-1 locale service.
This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Get L2VPN service under Tier-1


Get L2VPN service for given Tier-1 locale service.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Create or patch L2VPN service under Tier-1


Create or patch L2VPN service for given Tier-1 locale service.
This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)

Get L2VPN sessions list result under Tier-1


Get paginated list of all L2VPN sessions under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions (Deprecated)

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.
This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

Get L2VPN Session under Tier-1


Get L2VPN session under Tier-1.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use POST /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
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 (Deprecated)

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.
This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)

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.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id>/peer-config instead.
Note:
The API will return a new VPN path for "transport_tunnel_path" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)

Get L2Vpn session remote mac for logical switch


Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac
instead.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac (Deprecated)

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.
This API is deprecated. Please use GET //infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)