Inbound Port | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

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

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

post

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

Path parameters

idinteger · int32required

Windows device group Id

Body

Add an Inbound Port to a Windows Device Group

portinteger · int32required

The Port to add to the windows device group.

protocolstring · enumrequired

Connection Protocol type.

Available options:

profilestring[Flag] · enumrequired

Profile Setting.

Available options:

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 Content

Created

Remove

delete

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

Path parameters

idinteger · int32required

Windows device group Id

Body

Remove an Inbound Port from a Windows Device Group

portinteger · int32required

The Port of the Windows Device Group to remove.

protocolstring · enumrequired

Connection Protocol type.

Available options:

profilestring[Flag] · enumrequired

Profile Setting.

Available options:

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 Content