query ip whitelist

POST

https://api.ipcola.com/api/ip_whitelist/query

Request

Header Params

Authorization

string

optional

Default:

Bearer {{AUTH_TOKEN}}

Body Params application/json

filter

object

required

integer

optional

optional, specific record id

string

optional

optional, specific ip

from_db

boolean

required

from db or cache

limit

integer

optional

query quantity for pagination

offset

integer

optional

query offset for pagination

Example

{
    "from_db": true,
    "filter": {
    },
    "offset": 0,
    "limit": 10
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ipcola.com/api/ip_whitelist/query' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "from_db": true,
    "filter": {
    },
    "offset": 0,
    "limit": 10
}'

Responses

🟢200result

application/json

Body

data

array [object {5}]

required

query record result

created_unixtime

integer

optional

integer

optional

string

optional

tag

string

optional

user_id

integer

optional

meta_message

string

required

success or other error msg

meta_status

integer

required

1 for success, negative for error

total_count

integer

required

total record quantity

Example

{
    "data": [
        {
            "created_unixtime": 0,
            "id": 0,
            "ip": "string",
            "tag": "string",
            "user_id": 0
        }
    ],
    "meta_message": "string",
    "meta_status": 0,
    "total_count": 0
}

Modified at 2023-06-15 01:18:37

delete ip whitelist

update ip whitelist