ProductsSupportPartnersDocumentation

Listing, Updating, and Deleting

Get

get

Retrieve a specific tunneling policy by ID.

Path parameters
idinteger · int32Required

Tunneling policy Id

Responses
200
OK
application/json; api-version=1.0
get
GET /api/TunnelingPolicy/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-07T17:57:12.333Z",
  "timeLastMod": "2025-07-07T17:57:12.333Z",
  "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

Modify a tunneling policy

newIPstring | nullableOptional

The gateway IP of the tunneling policy to modify.

publishTypestring · enumOptional

RD session hosts options

Possible values:
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
204
No Content
put
PUT /api/TunnelingPolicy/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 156

{
  "newIP": "text",
  "publishType": [
    "0 = AllRDSessionHostsInSite",
    "1 = RDSessionHostPool",
    "2 = RDSessionHosts",
    "3 = None"
  ],
  "rdsHostPoolIds": [
    1
  ],
  "rdsHostIds": [
    1
  ]
}
No content

Delete

delete

Delete a tunneling policy by ID.

Path parameters
idinteger · int32Required
Responses
204
No Content
delete
DELETE /api/TunnelingPolicy/{id} HTTP/1.1
Host: 
Accept: */*

No content
PreviousBasic OperationsNextVDI

Last updated

Was this helpful?