IPs

List

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

GET/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Response

200401404

Success

Body

application/json; api-version=1.0

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Add

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

POST/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

application/json; api-version=1.0

IP configuration.

ip*nullable string

Value that represents the IP

ipType*IPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

Response

201401404409

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ip": "text",
      "ipType": [
        "0 = Version4",
        "1 = Version6",
        "2 = BothVersions"
      ]
    }),
});
const data = await response.json();

Response

401404409

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Remove

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

DELETE/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

application/json; api-version=1.0

IP configuration.

ip*nullable string

Value that represents the IP

ipType*IPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ip": "text",
      "ipType": [
        "0 = Version4",
        "1 = Version6",
        "2 = BothVersions"
      ]
    }),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}