VPN

Resources for VPN configurations.
[tags: DMA]

Resource Root

https://localhost:8443/api/rest/vpns/genkey

Summary

Resources	Methods
https://localhost:8443/api/rest/vpns/genkey	GET Generate a static VPN key for use with OpenVPN.
https://localhost:8443/api/rest/vpns	GET Get the list of VPN configurations. POST Creating a single VPN configuration entry.
https://localhost:8443/api/rest/vpns/config-remote-peer	POST .
https://localhost:8443/api/rest/vpns/{value}	GET Get the VPN information. PUT Updating VPN configuration entry. DELETE Delete the VPN configuration.
https://localhost:8443/api/rest/vpns/{value}/status	GET Get the status of a VPN connection [tags: DMA] .

Resources

https://localhost:8443/api/rest/vpns/genkey

Methods

GET

Generate a static VPN key for use with OpenVPN. This value can be placed in a plcm-vpn.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-vpn-gekey+xml application/vnd.plcm.plcm-vpn-genkey+json	List of VPN successfully retrieved.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed

https://localhost:8443/api/rest/vpns

Methods

GET

Get the list of VPN configurations.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-vpn-list+xml application/vnd.plcm.plcm-vpn-list+json	List of VPN successfully retrieved.
304		List of VPN information has not been changed since the last search. Note: The API client must provide the "plcm-vpn-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-vpn-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to VPN on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed

POST

Creating a single VPN configuration entry. The inverse of this (with respect to local an remote values) will need to be created on the remote server.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-vpn+xml

application/vnd.plcm.plcm-vpn+json

Response

Status	Representation	Description
201		VPN successfully created. Note: The response will only contain an ETag value.