Ip filters

List IP rules

Retrieve a collection of IP blacklist entries or whitelist entries.

GEThttp://127.0.0.1:8888/api/ip_filters

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ip_filters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "cidr": "text",
      "target": "ACCEPT",
      "expire_at": {},
      "description": "text"
    }
  ]
}

Create an IP rule

Add a new IP blacklist entry or whitelist entry to the system.

POSThttp://127.0.0.1:8888/api/ip_filters

Body

application/json

cidr*string

The CIDR notation IP address and prefix length, like "192.0.2.0/24" or "2001:db8::/32", as defined in RFC 4632 and RFC 4291.

target*enum

IP rule's target:

• ACCEPT: An accepted rule.
• DENY: A rejection rule.

ACCEPTDENY

expire_atall of

IP rule's expire time.

descriptionstring

Remarks for the IP rule.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of IP rule.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ip_filters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cidr": "text",
      "target": "ACCEPT"
    }),
});
const data = await response.json();

Response

200

{
  "id": {}
}

Retrieve an IP rule

Retrieve IP blacklist entry or whitelist entry.

GEThttp://127.0.0.1:8888/api/ip_filters/{id}

Path parameters

id*all of

The unique ID of IP rule.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of IP rule.

cidrstring

The CIDR notation IP address and prefix length, like "192.0.2.0/24" or "2001:db8::/32", as defined in RFC 4632 and RFC 4291.

targetenum

IP rule's target:

• ACCEPT: An accepted rule.
• DENY: A rejection rule.

ACCEPTDENY

expire_atall of

IP rule's expire time.

descriptionstring

Remarks for the IP rule.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ip_filters/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "cidr": "text",
  "target": "ACCEPT",
  "expire_at": {},
  "description": "text"
}

Update an IP rule

Update IP blacklist entry or whitelist entry that already exists.

POSThttp://127.0.0.1:8888/api/ip_filters/{id}

Path parameters

id*all of

The unique ID of IP rule.

Body

application/json

cidrstring

The CIDR notation IP address and prefix length, like "192.0.2.0/24" or "2001:db8::/32", as defined in RFC 4632 and RFC 4291.

targetenum

IP rule's target:

• ACCEPT: An accepted rule.
• DENY: A rejection rule.

ACCEPTDENY

expire_atall of

IP rule's expire time.

descriptionstring

Remarks for the IP rule.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ip_filters/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();