Gateway IPs | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve Criteria Gateway IP List of a session server with the specified ID.

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/GatewayIPs'

200

401

404

[
  {
    "gatewayIP": "text"
  }
]

Success

Add

post

Add a gateway IP to the Gateway IP List of the Criteria settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

Add a gateway IP to the Criteria Gateways list

ipstring | nullableoptional

The IP of the gateway to add to the Criteria.

gatewayIdinteger · int32 | nullableoptional

The ID of the gateway to add to the Criteria.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/GatewayIPs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ip": "text",
    "gatewayId": 1
  }'

201

401

404

409

No Content

Created

Remove

delete

Remove a gateway IP from the Gateway IP List of the Criteria settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

Remove a gateway IP from the Criteria Gateways list

ipstring | nullablerequired

The IP of the gateway to remove from the Criteria.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/Rules/{ruleId}/Criteria/GatewayIPs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ip": "text"
  }'

204

401

404

No Content