Attention: The v1 version of this API has been
deprecated.
Returns all IP lists or multiple selected IP lists by ID.
GET https://api-<BlueCat.edge.url>/v1/api/ipLists?ids=12345,7789
Authorization: Bearer token
Parameters
Name | Description | Type | Required |
ids | The ID of the IP list. If the ID is not specified, all the IP lists are returned. | String | Optional |
Successful response
200 OK
Content-Type: application/JSON
[
{
"id": "12345",
"name": "An IP list",
"description": "IP lists",
"version": "111-222-333-4444",
"cidrCount": 5
},
{
"id": "6789",
"name": "The other IP list",
"description": "Your second IP list",
"version": "555-666-777-8888",
"cidrCount": 20
}
]
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
- 400 Bad Request
- 404 IP List was not found
- 500 Internal Server Error