API Description | API Path |
---|---|
Get IPSec dead peer detection (DPD) profile list resultGet paginated list of all dead peer detection (DPD) profiles. |
GET /api/v1/vpn/ipsec/dpd-profiles
|
Create dead peer detection (DPD) profileCreate dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. |
POST /api/v1/vpn/ipsec/dpd-profiles
|
Delete dead peer detection (DPD) profileDelete dead peer detection (DPD) profile. |
DELETE /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
|
Get IPSec dead peer detection (DPD) profileGet IPSec dead peer detection (DPD) profile. |
GET /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
|
Edit IPSec dead peer detection (DPD) profileEdit IPSec dead peer detection (DPD) profile. |
PUT /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
|
List IKE profilesGet paginated list of all IKE Profiles. |
GET /api/v1/vpn/ipsec/ike-profiles
|
Create custom internet key exchange (IKE) ProfileCreate 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 non 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. |
POST /api/v1/vpn/ipsec/ike-profiles
|
Delete custom IKE ProfileDelete custom IKE Profile. Profile can not be deleted if profile has references to it. |
DELETE /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
|
Get IKE ProfileGet custom IKE Profile, given the particular id. |
GET /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
|
Edit custom IKE ProfileEdit custom IKE Profile. System owned profiles are non editable. |
PUT /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
|
Get IPSec local endpoint list resultGet paginated list of all local endpoints. |
GET /api/v1/vpn/ipsec/local-endpoints
|
Create custom local endpointCreate custom IPSec local endpoint. |
POST /api/v1/vpn/ipsec/local-endpoints
|
Delete custom IPSec local endpointDelete custom IPSec local endpoint. |
DELETE /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
|
Get custom IPSec local endpointGet custom IPSec local endpoint. |
GET /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
|
Edit custom IPSec local endpointEdit custom IPSec local endpoint. |
PUT /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
|
Get IPSecVPNPeerEndpoint List ResultGet paginated list of all peer endpoint. |
GET /api/v1/vpn/ipsec/peer-endpoints
|
Create custom peer endpointCreate custom IPSec peer endpoint. |
POST /api/v1/vpn/ipsec/peer-endpoints
|
Delete custom IPSec VPN peer endpointDelete custom IPSec VPN peer endpoint. All references are strong references and dependent peer endpoints can not be deleted if being referenced. |
DELETE /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
|
Get IPSec VPN peer endpointGet custom IPSec VPN peer endpoint. |
GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
|
Get IPSec VPN peer endpoint with PSKGet custom IPSec VPN peer endpoint with PSK. |
GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>?action=show-sensitive-data
|
Edit custom IPSecPeerEndpointEdit custom IPSec peer endpoint. System owned endpoints are non editable. |
PUT /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
|
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services. |
GET /api/v1/vpn/ipsec/services
|
Create VPN serviceCreate VPN service for given logical router. |
POST /api/v1/vpn/ipsec/services
|
Delete IPSec VPN serviceDelete IPSec VPN service for given router. |
DELETE /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
|
Get IPSec VPN serviceGet IPSec VPN service for given logical router. |
GET /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
|
Edit IPSec VPN serviceEdit IPSec VPN service for given logical router. |
PUT /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
|
Get IPSec VPN session list resultGet paginated list of all IPSec VPN sessions. |
GET /api/v1/vpn/ipsec/sessions
|
Create new VPN sessionCreate new VPN session. |
POST /api/v1/vpn/ipsec/sessions
|
Delete IPSec VPN sessionDelete IPSec VPN session. |
DELETE /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
|
Fetch IPSec VPN sessionFetch IPSec VPN session. |
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
|
Edit IPSec VPN sessionEdit IPSec VPN session. |
PUT /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
|
Get VPN configuration for the peer siteAPI to download VPN configuration for the peer site. The configuration contains pre-shared key and secret; be careful when sharing or storing it. |
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/peer-config
|
Get the Realized State of a IPSec VPN SessionReturn realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled. |
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/state
|
Get IPSecTunnelProfile List ResultGet paginated list of all IPSecTunnelProfiles. |
GET /api/v1/vpn/ipsec/tunnel-profiles
|
Create custom IPSec tunnel profileCreate 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 non editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. |
POST /api/v1/vpn/ipsec/tunnel-profiles
|
Delete custom IPSecTunnelProfileDelete custom IPSec Tunnel Profile. |
DELETE /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
|
Get IPSec tunnel profileGet custom IPSec Tunnel Profile. |
GET /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
|
Edit custom IPSecTunnelProfileEdit custom IPSec Tunnel Profile. System owned profiles are non editable. |
PUT /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
|