/v1/api/namespaces (POST) - BlueCat DNS Edge

DNS Edge User Guide

prodname
BlueCat DNS Edge

Creates a namespace.

POST https://api-<DNS.Edge.URL>/v1/api/namespaces
Authorization: Bearer token
Content-Type: application/json

{
   "name": "namespace",
   "description": "this is a namespace",
   "forwarders": ["8.8.8.8", "2.2.2.2"],
   "matchLists": ["domainListId1", "domainListId2"],
   "exceptionLists": ["domainListId1", "domainListId2"],
   "umbrellaIntegrationId": "<id of umbrella integration>",
   "ttl": 60,
   "staleCacheEntriesTTL": 3600"
}

Parameters

Name Description Type Required
name The name of the namespace String Required
description A description of the namespace String Optional
forwarders Forwarder IP addresses. If the namespace uses a Cisco Umbrella integration, enter the two standard Cisco Umbrella cloud IP addresses. String Required
matchLists Domain list IDs for match lists String Optional
exceptionLists Domain list ID for exception lists String Optional
umbrellaIntegrationId The ID of the Cisco Umbrella integration created in Edge. String Optional
ttl The TTL of the query response. The default value is -1.
Note: Currently, the only supported TTL value is 60 seconds and -1 (indicating that the TTL value of the query response isn't overridden).
Integer Optional
staleCacheEntriesTTL The TTL of the expired DNS queries. If unspecified, the default value is 3600.
Note: Currently, the only supported TTL values are 0, 3600, and 86400 seconds.
Integer Optional

Successful response

201 CREATED

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, TOO_MANY_DOMAIN_LISTS - The namespace can't contain more than 20 domain lists.
  • 400 Bad Request, TOO_MANY_DOMAINS - A domain list in the match list contains more than the maximum 100,000 domains allowed.
  • 400 Bad Request, TOO_MANY_DOMAINS - A domain list in the exception list contains more than the maximum 100,000 domains allowed.
  • 400 Bad Request, DOMAIN_LIST_NOT_FOUND - A domain list in the match list can't be found.
  • 400 Bad Request, DOMAIN_LIST_NOT_FOUND - A domain list in the exception list can't be found.
  • 400 Bad Request, INVALID_STALE_CACHE_ENTRIES_TTL - Stale cache entries TTL must be one of 0, 3,600, or 86,400 seconds.
  • 409 Conflict, NAMESPACE_ALREADY_EXISTS - The namespace name is already in use
  • 500 Internal Server Error, UNEXPECTED_SERVER_ERROR - Unexpected error while processing the request