Secondary Connections

List

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

GET/api/ClientPolicies/{id}/SecondaryConnections

Path parameters

id*integer (int32)

Client Policy ID.

Response

200401404

Success

Body

application/json; api-version=1.0

modeMode (enum)

Mode Type.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode

servernullable string

The Server which the user is going to connect to

serverPortinteger (int32)

The port of the server

Request

JavaScriptCurlPython

const response = await fetch('/api/ClientPolicies/{id}/SecondaryConnections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Add

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

POST/api/ClientPolicies/{id}/SecondaryConnections

Path parameters

id*integer (int32)

Client Policy ID.

Body

application/json; api-version=1.0

The secondary connection configuration.

mode*Mode (enum)

Mode Type.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode

server*nullable string

The Server which the user is going to connect to.

serverPort*integer (int32)

The port of the Server.

Response

201401

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/ClientPolicies/{id}/SecondaryConnections', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "mode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode"
      ],
      "server": "text",
      "serverPort": 0
    }),
});
const data = await response.json();

Response

401

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

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

DELETE/api/ClientPolicies/{id}/SecondaryConnections

Path parameters

id*integer (int32)

Client Policy ID.

Body

application/json; api-version=1.0

The secondary connection configuration.

mode*Mode (enum)

Mode Type.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode

server*nullable string

The Server which the user is going to connect to.

serverPort*integer (int32)

The port of the Server.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ClientPolicies/{id}/SecondaryConnections', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "mode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode"
      ],
      "server": "text",
      "serverPort": 0
    }),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}