Returns a list of namespaces, or namespaces associated with the site specified by site ID, or by namespace ID, if specified.
GET https://api-<BlueCat.edge.url>/v1/api/namespaces
Authorization: Bearer token
OR
GET https://api-<BlueCat.edge.url>/v1/api/namespaces/{namespaceId}
Authorization: Bearer token
OR
GET https://api-<BlueCat.edge.url>/v1/api/namespaces?siteId={siteId}
Authorization: Bearer token
OR
GET https://api-<BlueCat.edge.url>/v1/api/namespaces?domainListId={domainListId}
Authorization: Bearer token
Parameters
Name | Description | Type | Required |
siteId | The site for which you want to view namespace information. If no site is provided, an error is returned. If there is no site with that ID, an empty list is returned. | String | Optional |
namespaceId | The specific namespace that you would like to view. | String | Optional |
domainListId | Returns namespaces containing the specified domain list ID. | String | Optional |
Successful response
200 OK
Content-Type: application/JSON[
{
"name": "another namespace 2",
"type": "USER",
"description": "test-namespace-description-1",
"forwarders": [
"127.0.0.1",
"8.9.10.11"
],
"matchLists": [],
"exceptionLists": [],
"ttl": 60,
"staleCacheEntriesTTL": 86400,
"isDefault": true,
"ecsConfiguration": {
"v4Prefix": 24,
"v6Prefix": 56,
"override": false
},
"retryRCodes": [
3,
5
],
"negativeCacheTTL": 30
},
{
"name": "discovered namespace",
"type": "DISCOVERED",
"description": "A namespace configured to resolve using discovered data",
"forwarders": [],
"matchLists": [],
"exceptionLists": [],
"discoveryIds": [
"123aaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"456bbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
],
"searchDomains": []
},
{
"name": "external namespace",
"type": "RECURSIVE",
"description": "A namespace configured to resolve external records",
"matchLists": [],
"exceptionLists": [],
"enableDnsSec": false,
"customRootHints": {
"ttl": 3600,
"rootServers": [
{
"name": "bluecatnetworks.com",
"addresses": [
"192.168.0.50",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
]
},
{
"name": "bluecatlabs.net",
"addresses": [
"192.168.0.49"
]
}
]
}
}
]
Note: A TTL value of -1 indicates that the cache TTL value is overridden; however, the TTL
value of the custom root hint cannot be a negative value.
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, INVALID_STALE_CACHE_ENTRIES_TTL - Stale cache entries TTL must be one of 0, 3,600, or 86,400 seconds
- 404 Not Found, NOT_FOUND - No matching namespace found
- 404 Not Found, NOT_FOUND - namespaceId is invalid
- 500 Internal Server Error, UNEXPECTED_SERVER_ERROR - Unexpected error while processing the request