Inbound Port

PreviousWindows Device Groups NextPublishing

Last updated 11 months ago

Was this helpful?

Get

Retrieve a Windows device group's Inbound ports by ID.

get

/api/WinDeviceGroup/{id}/InboundPort

Path parameters

idinteger · int32required

Windows device group Id

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/WinDeviceGroup/{id}/InboundPort'

200

401

404

[
  {
    "port": 1,
    "protocol": [
      "0 = TCP",
      "1 = UDP"
    ],
    "profile": [
      "1 = Domain",
      "2 = Private",
      "4 = Public",
      "2147483647 = All"
    ]
  }
]

Success

Add

Add an Inbound port to a Windows device group by ID.

post

/api/WinDeviceGroup/{id}/InboundPort

Path parameters

idinteger · int32required

Windows device group Id

Body

portinteger · int32required

<para type="description">The Port to add to the windows device group.</para>

protocolstring · enumrequired

<para type="synopsis">Connection Protocol type.</para> <para type="description"></para>

Options: 0 = TCP,1 = UDP

profilestring[Flag] · enumrequired

<para type="synopsis">Profile Setting.</para> <para type="description"></para>

Options: 1 = Domain,2 = Private,4 = Public,2147483647 = All

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/WinDeviceGroup/{id}/InboundPort' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "port": 1,
    "protocol": [
      "0 = TCP",
      "1 = UDP"
    ],
    "profile": [
      "1 = Domain",
      "2 = Private",
      "4 = Public",
      "2147483647 = All"
    ]
  }'

201

401

404

No body

Created

Remove

Remove an Inbound port from a Windows device group by ID.

delete

/api/WinDeviceGroup/{id}/InboundPort

Path parameters

idinteger · int32required

Windows device group Id

Body

portinteger · int32required

<para type="description">The Port of the Windows Device Group to remove.</para>

protocolstring · enumrequired

<para type="synopsis">Connection Protocol type.</para> <para type="description"></para>

Options: 0 = TCP,1 = UDP

profilestring[Flag] · enumrequired

<para type="synopsis">Profile Setting.</para> <para type="description"></para>

Options: 1 = Domain,2 = Private,4 = Public,2147483647 = All

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/WinDeviceGroup/{id}/InboundPort' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "port": 1,
    "protocol": [
      "0 = TCP",
      "1 = UDP"
    ],
    "profile": [
      "1 = Domain",
      "2 = Private",
      "4 = Public",
      "2147483647 = All"
    ]
  }'

204

401

404

No body

No Content