Get the list of allowed entered IP addresses by the user.
GET {{baseUrl}}/v1/allowlist/cidr?expires_before=49822579&expires_after=22732944&ip_protocol_version=ALL&output_format=JSON
What
Obtain the list of all the allowed IPv4 or IPv6 addresses that have been entered by the user. The allowed IP addresses are the ones submitted manually by the user from files or indidual items.
Parameters
The endpoint accepts the following parameters in the query string:
- expires_before: (Optional) The UNIX timestamp in milliseconds of the earliest expiry date to be included in the query. If not given, then the earliest date is current time.
- expires_after: (Optional) The UNIX timestamp in milliseconds of the oldest expiry date to be included in the query. If not given, then the oldest date is the first event logged.
- ip_protocol_version: (Optional) Restricts the result displaying only the IP addresses with the given IP protocol version. Values are: ALL, IPV4, IPV6. If not given, then all IP addresses are returned.
- output_format: (Optional) The format of the output. Values are: JSON, CSV, AWS-WAF. If not given, then the default format is JSON. AWS-WAF is the format used by AWS WAF to import ipsets in the service. You can find more information about AWS WAF import here.
Result
The result is a JSON object with a list of the following JSON objects:
- self: the URI to individual status.
- cidrs: a list of JSON objects 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
400 Bad Requesterror if any timestamp is in the future. - a
422 Unprocessable Entityerror if some of the parameters are malformed.
It will also return the API Global errors described in the API description.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
expires_before | number | Restricts the result displaying only the IP addresses that will expire before expires_before. It must be a UNIX timestamp in seconds greater than the current UNIX timestamp. | |
expires_after | number | Restricts the result displaying only the IP addresses that will expire after expires_after. It must be a UNIX timestamp in seconds greater than the current UNIX timestamp. | |
ip_protocol_version | string | Restrict the result displaying the IP protocol version requested (IPV4 or V6) or both (ALL). Some output formats MUST filter by IP protocol version first. | |
output_format | string | The output format of the datasets. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"self":"veniam ad do ea","cidrs":[{"self":"veniam i","last_report":49878666,"description":"tempor","expiry":-69410682,"protocol":"ALL"},{"self":"Ut commodo labore proident","last_report":-10539629,"description":"ex ut laborum","expiry":18450902,"protocol":"IPV4"}]}