Basic Operations

PreviousTunneling Policies NextListing, Updating, and Deleting

Last updated 20 days ago

Was this helpful?

List

get

Retrieve a list of tunneling policies.

Query parameters

siteIdinteger · int32optional

Site ID for which to retrieve the tunneling policy (optional).

ipstringoptional

Filter the result by the gateway IP (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/TunnelingPolicy'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-03T06:44:13.499Z",
    "timeLastMod": "2025-04-03T06:44:13.499Z",
    "ip": "text",
    "publishType": [
      "0 = AllRDSessionHostsInSite",
      "1 = RDSessionHostPool",
      "2 = RDSessionHosts",
      "3 = None"
    ],
    "rdsHostPoolIds": [
      1
    ],
    "rdsHostIds": [
      1
    ]
  }
]

Create

post

Create a new tunneling policy.

Body

ipstring | nullablerequired

The gateway IP of the tunneling policy.

publishTypestring · enumoptional

RD session hosts options

Available options:

rdsHostPoolIdsinteger · int32[] | nullableoptional

The IDs of the selected RD session host pools.

rdsHostIdsinteger · int32[] | nullableoptional

The IDs of the selected individual RD session hosts.