Secondary Connections | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve the list of secondary connections of the specified client policy with ID.

Path parameters

idinteger · int32Required

Client Policy ID.

Responses

application/json; api-version=1.0

object[]Optional

Sessions Secondary Connection Policy

application/json; api-version=1.0

get

GET /api/ClientPolicies/{id}/SecondaryConnections HTTP/1.1
Host: 
Accept: */*

[
  {
    "mode": [
      "0 = GatewayMode",
      "1 = DirectMode",
      "2 = GatewaySSLMode",
      "3 = DirectSSLMode"
    ],
    "server": "text",
    "serverPort": 1
  }
]

Add

post

Add a connection to the list of secondary connections of the specified client policy with ID.

Path parameters

idinteger · int32Required

Client Policy ID.

Body

Add a new connection to the secondary connections list

modestring · enumRequired

Mode Type.

Available options:

serverstring | nullableRequired

The Server which the user is going to connect to.

serverPortinteger · int32Required

The port of the Server.

Responses

application/json; api-version=1.0

post

POST /api/ClientPolicies/{id}/SecondaryConnections HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 117

{
  "mode": [
    "0 = GatewayMode",
    "1 = DirectMode",
    "2 = GatewaySSLMode",
    "3 = DirectSSLMode"
  ],
  "server": "text",
  "serverPort": 1
}

No content

Delete

delete

Delete a connection to the list of secondary connections of the specified client policy with ID.

Path parameters

idinteger · int32Required

Client Policy ID.

Body

Remove a connection from the secondary connections list

modestring · enumRequired

Mode Type.

Available options:

serverstring | nullableRequired

The Server which the user is going to connect to.

serverPortinteger · int32Required

The port of the Server.

Responses

application/json; api-version=1.0

delete

DELETE /api/ClientPolicies/{id}/SecondaryConnections HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 117

{
  "mode": [
    "0 = GatewayMode",
    "1 = DirectMode",
    "2 = GatewaySSLMode",
    "3 = DirectSSLMode"
  ],
  "server": "text",
  "serverPort": 1
}

No content