Attention: The v1 version of this API has been
deprecated.
Returns an IP list by ID.
GET https://api-<BlueCat.edge.url>/v1/api/ipLists/{id}
Authorization: Bearer token
Parameters
Name | Description | Type | Required |
id | The ID of the IP list. If the ID is not specified, all the IP lists are returned. | String | Required |
Successful response
200 OK
Content-Type: application/JSON
{
"id": "1234567",
"name": "IP List 1",
"description": "IP list used for blocking",
"version": "111-222-333-4444",
"cidrCount": 100
}
Returns the following information:
- id: The ID of IP list.
- name: The name of the IP list.
- description: A description of the IP list.
- version: The version of the list if modified.
- cidrCount: The number of CIDR ranges in the list.
Response on unsuccessful authorization
401 Unauthorized
Content-Type: application/JSON
{"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
- 404 IP List was not found
- 500 Internal Server Error