Inbound Port | Parallels REST API

Parallels REST API

SupportDocumentation

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

object[]Optional

Windows device group - Inbound port

application/json; api-version=1.0

get

GET /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host: 
Accept: */*

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

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

post

POST /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 114

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

No content

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

delete

DELETE /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 114

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

No content