Ip filters

PreviousDestroy NextDestroy

Was this helpful?

List IP rules

Retrieve a collection of IP blacklist entries or whitelist entries.

get

/ip_filters

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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: 0

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: 100

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

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

Create an IP rule

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

post

/ip_filters

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.

descriptionstring · max: 255

Remarks for the IP rule.

targetstring · enumrequired

IP rule's target:

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

Options: ACCEPT, DENY

expire_atall of

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
    "description": "text",
    "target": "ACCEPT",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve an IP rule

Retrieve IP blacklist entry or whitelist entry.

get

/ip_filters/{id}

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 -L \
  --url 'https://HOSTNAME:8887/api/ip_filters/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Update an IP rule

Update IP blacklist entry or whitelist entry that already exists.

post

/ip_filters/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of IP rule.

The unique ID of the resource.

Body

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.

descriptionstring · max: 255

Remarks for the IP rule.

targetstring · enum

IP rule's target:

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

Options: ACCEPT, DENY

expire_atall of

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

Responses

cURL

JavaScript

Python

HTTP

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",
    "description": "text",
    "target": "ACCEPT",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

No body