Gateway IPs

List

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

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

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

gatewayIPnullable string

The gateway IP.

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "gatewayIP": "text"
  }
]

Add

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

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

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

Gateway IP configuration.

ipnullable string

The IP of the gateway to add to the Criteria.

gatewayIdnullable integer (int32)

The ID of the gateway to add to the Criteria.

Response

201401404409

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/GatewayIPs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404409

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

Remove

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

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

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

Gateway IP configuration.

ip*nullable string

The IP of the gateway to remove from the Criteria.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/GatewayIPs', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ip": "text"
    }),
});
const data = await response.json();

Response

401404

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