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

Tunneling Policy

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

ipstring · nullableOptional

The gateway IP of the tunneling policy.

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.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/TunnelingPolicy/{id}

HTTPcURLJavaScriptPython

GET /api/TunnelingPolicy/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-15T20:10:17.430Z",
  "timeLastMod": "2026-03-15T20:10:17.430Z",
  "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

application/json; api-version=1.0

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

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/TunnelingPolicy/{id}

HTTPcURLJavaScriptPython

PUT /api/TunnelingPolicy/{id} HTTP/1.1
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

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/TunnelingPolicy/{id}

HTTPcURLJavaScriptPython

DELETE /api/TunnelingPolicy/{id} HTTP/1.1
Accept: */*

No content