IPs | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve Criteria IP List of a Site Defaults object.

Query parameters

siteIdinteger · int32optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/MFADefaultSettings/Criteria/IPs'

200

401

404

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

Success

Add

post

Add an IP to the IP List of the Criteria settings.

Query parameters

siteIdinteger · int32optional

The Site ID of an object for which to modify the Criteria settings (optional).

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFADefaultSettings/Criteria/IPs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ip": "text",
    "ipType": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ]
  }'

201

401

404

409

No Content

Created

Remove

delete

Remove an IP from the IP List of the Criteria settings.

Query parameters

siteIdinteger · int32optional

The Site ID of an object for which to modify the Criteria settings (optional).

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/MFADefaultSettings/Criteria/IPs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ip": "text",
    "ipType": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ]
  }'

204

401

404

No Content