Get an allowed entered IP addresses by the user.
GET {{baseUrl}}/v1/allowlist/cidr/:cidr
What
Obtain an allowed IPv4 or IPv6 addresses or CIDR that have been entered by the user. The allowed IP addresses or CIDRs are the ones submitted manually by the user from files or indidual items.
Parameters
The endpoint accepts the following parameters in the path:
- cidr
: (Mandatory) The public IPv4 or IPv6 addresses or CIDR to be queried. Note: The CIDR must be in the format x.x.x.x/y
or x:x:x:x:x:x:x:x/y
. The CIDR in the path MUST be double escaped with %252F
. If you are using the online editor, you have to use the %2F
character.
Result
The result is a JSON object with the following fields:
- self
: the URI to individual reported IP information.
- last_report
: Unix timestamp in milliseconds when the IP address or CIDR was last submitted.
- description
: A string with the description of the IP address or CIDR.
- expiry
: Unix timestamp in milliseconds when the IP address or CIDR will expire and be removed.
- protocol
: IP protocol version of the IP address. Same value as the ip_protocol_version
parameter if given.
Errors
- a
422 Unprocessable Entity
error if the CIDR is malformed.
It will also return the API Global errors described in the API description.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"self":"dolor in","last_report":-16351697,"description":"dolore ut aute","expiry":-66230258,"protocol":"ALL"}