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.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
VPN already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Local binding/connection (IP:Port) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Remote binding/connection (IP:Port) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Local VPN address (IP) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
VPN key information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cipher value invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Protocol value invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Address or port conflict, address port values conflict with other VPN configurations or other system values

https://localhost:8443/api/rest/vpns/config-remote-peer


Methods

POST

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|identifier}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, then the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Representations

application/vnd.plcm.plcm-rest-login-details+xml
application/vnd.plcm.plcm-rest-login-details+json

Response

Status Representation Description
204
Partner was successfully configured.
401 Invalid credentials.
409 Invalid credentials for the partner node.
409 See the possible responses for the PUT for updating the remote peer configuration.

https://localhost:8443/api/rest/vpns/{value}


Template Parameters

Name Type Description
value xs:string Unique name or identifier of the VPN.

Methods

GET


Get the VPN information.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|identifier}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, then the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-vpn+xml
application/vnd.plcm.plcm-vpn+json
VPN information successfully retrieved.
304
VPN information has not been changed since the last search.

Note: The API client must provide the "plcm-vpn" 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" 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
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such VPN configuration

PUT


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

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|identifier}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, then the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Representations

application/vnd.plcm.plcm-vpn+xml
application/vnd.plcm.plcm-vpn+json

Response

Status Representation Description
204
VPN entry successfully updated.
Note: The response will only contain both an ETag value
and link to the updated VPN resource.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such VPN
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
VPN already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Local binding/connection (IP:Port) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Local VPN address (IP) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Remote VPN address (IP) information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
VPN key information is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cipher value invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Protocol value invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Address or port conflict, address port values conflict with other VPN configurations or other system values
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The resource has changed on the server. The API client must retrieve the latest resource version, apply the resource modifications, then update to the server.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-vpn.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The request contained ETags in both the header (header-ETag) and the body (body-ETag) and they do not match.

DELETE


Delete the VPN configuration.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|identifier}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, then the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
204 application/vnd.plcm.plcm-vpn+xml
application/vnd.plcm.plcm-vpn+json
VPN deleted successfully.
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
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such VPN

https://localhost:8443/api/rest/vpns/{value}/status


Template Parameters

Name Type Description
value xs:string Unique name or identifier of the VPN.

Methods

GET


Get the status of a VPN connection
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|identifier}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, then the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-vpn-status+xml
application/vnd.plcm.plcm-vpn-status+json
Status for a VPN entry successfully retrieved.