IPs | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve Criteria 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

objectOptional

Allowed IPs Criteria

application/json; api-version=1.0

get

GET /api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs HTTP/1.1
Host: 
Accept: */*

{
  "iPv4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "iPv6s": [
    {
      "from": "text",
      "to": "text"
    }
  ]
}

Add

post

Add an IP to the 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 an IP to the Criteria IP list

ipstring | nullableRequired

Value that represents the IP

ipTypestring · enumRequired

IP Version

Available options:

Responses

application/json; api-version=1.0

post

POST /api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 73

{
  "ip": "text",
  "ipType": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ]
}

No content

Remove

delete

Remove an IP from the 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 an IP from the Criteria IP list

ipstring | nullableRequired

Value that represents the IP

ipTypestring · enumRequired

IP Version

Available options:

Responses

application/json; api-version=1.0

delete

DELETE /api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 73

{
  "ip": "text",
  "ipType": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ]
}

No content