IP Filters

Get IP filter

Retrieve the IP address list for the specified published resource. Deprecated path - Use Criteria section instead.

GET/api/PubItems/{id}/IPFilters

Path parameters

id*integer (int32)

ID of the published resource to be updated

Response

200401404

Success

Body

application/json; api-version=1.0

allowedIP4snullable array of IP4Range (object)

Lists the IPv4 addresses.

allowedIP6snullable array of IP6Range (object)

Lists the IPv6 addresses.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ]
}

Add IP filter

Add an IP address to the filter of type 'IP Address' for the specified published resource. Deprecated path - Use Criteria section instead.

POST/api/PubItems/{id}/IPFilters

Path parameters

id*integer (int32)

ID of the published resource to be updated

Body

application/json; api-version=1.0

Published item IP filter configuration

ip*nullable string

The IP address to add to the filter.

Response

201401404409

Created

Request

JavaScriptCurlPython

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

Response

401404409

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

Delete IP filter

Delete an IP address from the filter of type 'IP Address' for the specified published resource. Deprecated path - Use Criteria section instead.

DELETE/api/PubItems/{id}/IPFilters/{ip}

Path parameters

id*integer (int32)

ID of the published resource to be updated

ip*string

IP to be deleted from the IP filter

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/IPFilters/{ip}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

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