| API Description | API Path |
|---|---|
Get L2VPN sessions list result under Tier-0Get 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-0Delete 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-0Get 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-0Create 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 CodesCreate 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-0Create 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 Tier-0 L2VPN session configuration for the peer siteGet 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 sessions list result under Tier-0Get 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-0Delete 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-0Get 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-0Create 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 CodesCreate 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-0Create 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 Tier-0 L2VPN session configuration for the peer siteGet 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 sessions list result under Tier-1Get 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-1Delete 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-1Get 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-1Create 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 CodesCreate 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-1Create 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 Tier-1 L2VPN session configuration for the peer siteGet 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 sessions list result under Tier-1Get 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-1Delete 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-1Get 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-1Create 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 CodesCreate 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-1Create 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 Tier-1 L2VPN session configuration for the peer siteGet 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)
|