/v2/domainLists (POST) - BlueCat DNS Edge

DNS Edge API Guide

Locale
English (United States)
Product name
BlueCat DNS Edge

Create a domain list

POST https://api-<DNS.Edge.URL>/v2/domainLists
Authorization: Bearer authorization token
Content-type: application/JSON
{
   "name": "<domain-list-name>",
   "description": "<domain-list-description>",
   "sourceType": "<user | dynamic>",
   "dynamicOptions":{
      "hostname": "<hostname>",
      "privateKey": "<private-key>",
      "filePath": "<filepath>",
      "port": <port>,
      "transferType": "rsyncSSH",
      "user": "<ssh-user>",
      "publicHostKey": "<public-host-key>",
      "syncRate": <syncRate>
    }
}  
Note: If the sourceType for a domain list is "user", you don't configure dynamicOptions. The Dynamic Option information only needs to be configured when the sourceType is dynamic.

Successful response

201 CREATED
Possible error codes
  • NAMESPACE_OVER_100k - Domain lists associated with namespaces can't exceed 100,000 domains
  • DUPLICATE_LIST_NAME - A domain list exists with the same name
  • INVALID_LIST_JSON - Domain list JSON is invalid
  • INVALID_PARAMETER - Domain list parameter is invalid
  • UNSUPPORTED_LIST_TYPE - Domain list type is invalid
  • MISSING_PRIVATE_KEY - The domain list private key is missing
  • INTERNAL_ERROR - Internal server error