Policy > Networking > Network Services > VPN > IPSEC > Sessions

Associated URIs:

API Description API Path

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 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 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 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 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 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 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 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 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 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 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 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)