/v1/api/list/dns/{domainListId}/sourceConfiguration (POST) - BlueCat DNS Edge

DNS Edge User Guide

prodname
BlueCat DNS Edge

Creates a domain list sourced and dynamically updated from a local feed.

POST https://api-<DNS.Edge.URL>/v1/api/list/dns/{domainListId}/sourceConfiguration
Authorization: Bearer authorization token
{
"hostName":"source.host.name.org",
"privateKey":"privateKey",
"filePath":"/location/location",
"port":22,
"transferType":"rsyncSSH"
"user":"userName",
"publicHostKey":"publicKey",
"syncRate":5
}
Parameters
  • hostName: The IP or FQDN of the local feed server. This must be publicly accessible.
  • privateKey and publicHostKey: Generated outside of DNS Edge. The publicHostKey must be uploaded on the server. These parameters must be entered exactly as they were generated.
  • filePath: The absolute path to the domain list file.
  • port: The port port that the SSH service is set up to listen on the server. This is usually "22".
  • transferType: This is always "rsyncSSH"
  • user: The SSH user.
  • syncRate:The frequency of sync attempts, in minutes.

Successful response

200 - OK Content-type: text/plain

Response on unsuccessful authorization

401 Unauthorized
Content-Type: application/JSON
{"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
  • INPUT_VALIDATION_ERROR
  • UNEXPECTED_ERROR