Ip filters

List IP rules

get

Retrieve a collection of IP blacklist entries or whitelist entries.

Authorizations

Query parameters

filterstringoptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringoptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringoptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100optional

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ip_filters' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "cidr": "text",
      "target": "ACCEPT",
      "expire_at": "2017-07-21T17:32:28Z",
      "description": "text"
    }
  ]
}

OK

Create an IP rule

post

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

Authorizations

Body

cidrstringrequired

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.

targetstring · enumrequired

IP rule's target:

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

Options: ACCEPT, DENY

expire_atall ofoptional

IP rule's expire time.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

descriptionstring · max: 255optional

Remarks for the IP rule.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ip_filters' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cidr": "text",
    "target": "ACCEPT",
    "expire_at": "2017-07-21T17:32:28Z",
    "description": "text"
  }'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve an IP rule

get

Retrieve IP blacklist entry or whitelist entry.

Authorizations

Path parameters

idall ofrequired

The unique ID of IP rule.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ip_filters/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "cidr": "text",
  "target": "ACCEPT",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

OK

Update an IP rule

post

Update IP blacklist entry or whitelist entry that already exists.

Authorizations

Path parameters

idall ofrequired

The unique ID of IP rule.

The unique ID of the resource.

Body

cidrstringoptional

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.

targetstring · enumoptional

IP rule's target:

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

Options: ACCEPT, DENY

expire_atall ofoptional

IP rule's expire time.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

descriptionstring · max: 255optional

Remarks for the IP rule.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ip_filters/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cidr": "text",
    "target": "ACCEPT",
    "expire_at": "2017-07-21T17:32:28Z",
    "description": "text"
  }'

200

4XX

200

No body

OK