Listing, Updating, and Deleting

PreviousBasic Operations NextVDI

Last updated 20 days ago

Was this helpful?

Delete

delete

Delete a tunneling policy by ID.

Path parameters

idinteger · int32required

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/TunnelingPolicy/{id}'

204

401

404

No body

No Content

Get

get

Retrieve a specific tunneling policy by ID.

Path parameters

idinteger · int32required

Tunneling policy Id

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/TunnelingPolicy/{id}'

200

401

404

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

Update

put

Update tunneling policy settings.

Path parameters

idinteger · int32required

Tunneling policy ID.

Body

newIPstring | nullableoptional

The gateway IP of the tunneling policy to modify.

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.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/TunnelingPolicy/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "newIP": "text",
    "publishType": [
      "0 = AllRDSessionHostsInSite",
      "1 = RDSessionHostPool",
      "2 = RDSessionHosts",
      "3 = None"
    ],
    "rdsHostPoolIds": [
      1
    ],
    "rdsHostIds": [
      1
    ]
  }'

204

401

404

No body

No Content