/v2/api/ipLists/{id} (GET) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x

Returns an IP list by ID. 

GET https://api-<BlueCat.edge.url>/v2/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,
    "type": "user"
 }
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.
  • type: The type of IP list. For user-defined lists, the value is user. For BlueCat Threat Protection IP lists, the value is threatIntelligence.
Possible error codes
  • 401 Unauthorized
  • 404 IP List was not found
  • 500 Internal Server Error