/v2/domainLists/{domainListId} (GET) - BlueCat Edge - Service Point v3.x.x

BlueCat Edge User Guide

Locale
English
Product name
BlueCat Edge
Version
Service Point v3.x.x

Gets a specific domain list.

GET https://api-<BlueCat.edge.url>/v2/domainLists/{domainListId}
Authorization: Bearer authorization token
Content-type: application/JSON

Successful response

200 OK
{
   "id": "<domain-list-id>",
   "name": "<domain-list-name>",
   "description": "<description>",
   "sourceType": "<user|dynamic>",
   "dynamicOptions": {
      "hostname": "<hostname>",
      "filePath": "<filepath>",
      "port": <port>,
      "tranferType": "rsyncSSH",
      "user": "<ssh-user>",
      "publicHostKey": "<public-host-key>",
      "syncRate": 5 
      },
   "domainCount": <count>
      ...    
}
Note: If the sourceType for a domain list is "user", the dynamic option configuration information isn't returned. Dynamic option information is only returned when the sourceType is dynamic.
Possible error codes
  • UNAUTHORIZED - Missing or invalid token
  • UNEXPECTED_ERROR - Internal server error