API Description | API Path |
---|---|
List DPD profilesGet paginated list of all DPD Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles
|
Delete custom dead peer detection (DPD) profileDelete 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) profileGet 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 ProfileCreate 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 ProfileCreate 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 profilesGet paginated list of all IKE Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles
|
Delete custom IKE ProfileDelete 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 ProfileGet 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) ProfileCreate 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) ProfileCreate 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 profilesGet paginated list of all IPSec tunnel Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles
|
Delete custom IPSec tunnel ProfileDelete 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 ProfileGet 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 ProfileCreate 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 ProfileCreate 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 resultGet paginated list of all IPSec VPN services for given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services
|
Delete IPSec VPN serviceDelete IPSec VPN service for given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Get IPSec VPN serviceGet IPSec VPN service for given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service for given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service for given locale service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint for a given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given locale service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a given locale service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Get IPSec VPN session detailed status under Tier-0- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status
|
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config
|
Get IPSec VPN session statistics under Tier-0- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
|
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
|
Get IPSec VPN Session SummarySummarized view of all tier-0 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary
|
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services
|
Delete IPSec VPN serviceDelete IPSec VPN service for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Get IPSec VPN serviceGet IPSec VPN service for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
|
Get IPSec VPN session detailed status under Tier-1- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status
|
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config
|
Get IPSec VPN session statistics under Tier-1- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
|
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
|
Get IPSec VPN Session SummarySummarized view of all tier-1 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary
|