Edge client - Platform - BlueCat Gateway - 24.1

Click a link to jump to the indicated section.

• EdgeClient class

  • authenticate()

  • clear_token()

  • delete_v1_api_apikey()

  • delete_v1_api_apikey_by_id()

  • delete_v1_api_namespaces()

  • delete_v2_domainlists()

  • delete_v3_api_sites()

  • delete_v5_api_policies()

  • get_v1_api_apikeys()

  • get_v1_api_audit_logs()

  • get_v1_api_authentication_token_describe()

  • get_v1_api_customer_dnsquerystats_count()

  • get_v1_api_customer_dnsquerystats_topdomains()

  • get_v1_api_customer_dnsquerystats_uniqueip()

  • get_v1_api_customer_sitegroups()

  • get_v1_api_customer_sitesandsitegroups_search()

  • get_v1_api_list_dns()

  • get_v1_api_list_dns_by_id()

  • get_v1_api_list_dns_search()

  • get_v1_api_list_system()

  • get_v1_api_list_system_content()

  • get_v1_api_list_system_information()

  • get_v1_api_namespaces()

  • get_v1_api_namespaces_by_id()

  • get_v1_api_servicepoints()

  • get_v1_api_settings()

  • get_v1_api_spversions()

  • get_v1_api_tos()

  • get_v1_api_users()

  • get_v2_api_customer_dnsquerylog_count()

  • get_v2_api_spimage_config()

  • get_v2_api_spimage_status()

  • get_v2_domainlists()

  • get_v2_domainlists_by_id()

  • get_v3_api_dnsquerylogs()

  • get_v3_api_dnsquerylogs_by_id()

  • get_v3_api_sites()

  • get_v3_api_sites_by_id()

  • get_v5_api_policies()

  • get_v5_api_policies_by_id()

  • handle_error_response()

  • patch_v1_api_namespaces()

  • patch_v2_domainlists()

  • patch_v3_api_sites()

  • post_v1_api_apikeys()

  • post_v1_api_customer_sitegroups_create()

  • post_v1_api_customer_sitegroups_delete()

  • post_v1_api_customer_sitegroups_update()

  • post_v1_api_list_dns()

  • post_v1_api_list_dns_attachfile()

  • post_v1_api_list_dns_delete()

  • post_v1_api_list_dns_sourceconfiguration()

  • post_v1_api_list_dns_update()

  • post_v1_api_namespaces()

  • post_v1_api_users()

  • post_v2_api_spimage_generate()

  • post_v2_domainlists()

  • post_v3_api_sites()

  • post_v3_api_sites_clearcache()

  • post_v5_api_policies()

  • put_v1_api_namespaces()

  • put_v1_api_settings()

  • put_v1_api_users()

  • put_v2_domainlists()

  • put_v3_api_sites()

  • put_v5_api_policies()

class bluecat_libraries.edge.api.client.EdgeClient(url)

Bases: bluecat_libraries.http_client.client.Client

Client uses the requests library to communicate with the REST endpoints of DNS Edge.

authenticate(client_id, client_secret, refresh_token=False)

Log in to the DNS Edge CI using the access key set to retrieve a token and bearer type to populate the authorization header.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)

New in version 20.6.1.

clear_token()

Clear token from client and session header

delete_v1_api_apikey(email_address)

Delete all the API access key sets for the specified email address.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v1_api_apikey(<email_address>)

New in version 20.6.1.

delete_v1_api_apikey_by_id(client_id)

Delete the API access key set with the specified client ID for the current user.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v1_api_apikey_by_id(<client_id>)

New in version 20.6.1.

delete_v1_api_namespaces(namespace_id)

Delete the namespace specified by the namespace ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

namespace_id = <namespace_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v1_api_namespaces(namespace_id=namespace_id)

New in version 20.12.1.

delete_v2_domainlists(domain_list_id)

Delete the domain list specified by the domain list ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = "<domain_list_id>"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v2_domainlists(domain_list_id=domain_list_id)

New in version 20.6.1.

delete_v3_api_sites(site_id)

Delete the site specified by the site ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = "<site_id>"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v3_api_sites(site_id=site_id)

New in version 20.6.1.

delete_v5_api_policies(policy_id)

Delete the policy specified by the policy ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

policy_id = "<policy_id>"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.delete_v5_api_policies(policy_id)

New in version 20.12.1.

get_v1_api_apikeys()

Return the API access key sets for the current user.

Returns: API access key sets for the current user.

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    results = client.get_v1_api_apikeys()

for result in results:
    print(result)

New in version 20.6.1.

get_v1_api_audit_logs(offset=None, limit=None, start_time=None, end_time=None, user_name=None)

Return the audit log records of API requests and responses.

Returns: Audit log records of API requests and responses.

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_audit_logs()

for log in result:
    print(log)

New in version 20.6.1.

get_v1_api_authentication_token_describe()

Return information about the user whose credentials were used to obtain the authorization token.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    current_user = client.get_v1_api_authentication_token_describe()

print(current_user)

New in version 20.12.1.

get_v1_api_customer_dnsquerystats_count(start, downsample, end=None)

Return the total count of logged DNS queries per policy action type in a Customer Instance for any time interval within the last 24 hours.

Returns: DNS query count results including columns: time, totalQueries, totalAllowed, totalMonitored, totalRedirected, totalNonMatched

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

start = 0         # Start of time range
downsample = 10   # Sample period of returned dataset

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    stats = client.get_v1_api_customer_dnsquerystats_count(start=start, downsample=downsample)

for stat in stats:
    print(stat)

New in version 20.6.1.

get_v1_api_customer_dnsquerystats_topdomains(start, count, end=None)

Return the specified number of domains most frequently queried per Customer Instance for any time interval within the last 24 hours.

Returns: The most frequently queried domains info: domainName, hitcount

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

start = 0         # Start of time range
count = 10        # Number of results to return

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_customer_dnsquerystats_topdomains(start=start, count=count)

for domain in result:
    print(domain)

New in version 20.6.1.

get_v1_api_customer_dnsquerystats_uniqueip(start, end=None)

Return the total number of unique client IPs that issued DNS queries in a Customer Instance for any time interval within the last 24 hours.

Returns: Total number of unique client IPs that issued DNS queries in a Customer Instance with key “count”.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

start = 0         # Start of time range

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    stats = client.get_v1_api_customer_dnsquerystats_uniqueip(start=start)

print(stats["count"])

New in version 20.6.1.

get_v1_api_customer_sitegroups()

Gets a list of the site groups.

Returns: A list of all site groups.

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_customer_sitegroups()

for sp in result:
    print(sp)

New in version 20.6.1.

get_v1_api_customer_sitesandsitegroups_search(name_contains=None, desired_result_count=None)

Return a list of the sites that match the specified search string.

Returns: A list of the sites that match the specified search string.

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

name_contains = "test"         # search key word
desired_result_count = 10      # max number of records to return

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_customer_sitesandsitegroups_search(name_contains=name_contains,
                                                              desired_result_count=desired_result_count)

for s in result:
    print(s)

New in version 20.6.1.

get_v1_api_list_dns()

Return a list of domain lists.

Returns: A list of domain lists

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient


with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_list_dns()

for r in result:
    print(r)

New in version 20.12.1.

get_v1_api_list_dns_by_id(domain_list_id)

Return a list of domain lists.

Returns: Domain names of the given domain list.

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = '3f76fe19-900d-47ff-b00c-c3cab6f40903'         # domain list ID

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.v1_api_list_dns_by_id(domain_list_id=domain_list_id)

for r in result:
    print(r)

New in version 20.6.1.

get_v1_api_list_dns_search(name_contains, desired_result_count)

Return a list of domain lists with names containing the search fragment, stopping when the desired result count reaches.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_list_dns_search(<name_contains>, 10)

New in version 20.12.1.

get_v1_api_list_system(list_name)

Return the specified system-maintained domain lists, including all of the domains in the list, and the last time each listed domain incurred DNS traffic identifying it as suspected tunneling.

Returns: The list of all the domains and the last time each listed domain incurred DNS traffic.

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient

query_id = <query_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_list_system('tunneling')

print(result)

New in version 20.12.1.

get_v1_api_list_system_content(list_name)

Return the contents of the specified system-maintained domain lists in JSON or CSV format. Leave out the Accept parameter to retrieve a CSV list instead of JSON. For each domain, the last time the domain incurred DNS traffic identifying it as a suspect for tunneling, and the time when that domain clears from the list according to the system-level set TTL, are returned.

Returns: The contents of the specified system-maintained domain lists.

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient

query_id = <query_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_list_system_content('tunneling')

print(result)

New in version 20.12.1.

get_v1_api_list_system_information(list_name)

Return the meta information for the specified system-maintained domain list.

Returns: The system-maintained domain list meta information.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

query_id = <query_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_list_system_information('tunneling')

print(result)

New in version 20.12.1.

get_v1_api_namespaces(site_id='')

Return a list of namespaces, or namespaces associated with the site specified by site ID, if specified.

Returns: The namespaces (all or those associated with the given site).

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_namespaces()

for ns in result:
    print(ns)

New in version 20.12.1.

get_v1_api_namespaces_by_id(namespace_id)

Return information of the namespace that matches the specified namespace ID.

Returns: Information of the namespace including: id, name, description, forwarders, matchLists, exceptionLists, isDefault, associatedSiteSettings, ttl, umbrellaIntegrationId, latency

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

namespace_id = <namespace_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_namespaces_by_id(namespace_id=namespace_id)

print(result)

New in version 20.12.1.

get_v1_api_servicepoints()

Return information about all currently registered service points.

Returns: Currently registered service points information including: id, name, siteId, lastSync, connectionState, connectionStateLastChanged, ipAddresses, loopbackIps, version, updateInitiatedTimestamp, updateStatus

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_servicepoints()

for sp in result:
    print(sp)

New in version 20.6.1.

get_v1_api_settings()

Retrieve the automatic service point update settings.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    api_settings = client.get_v1_api_settings()

New in version 20.12.1.

get_v1_api_spversions()

Return a list of available service point versions, listed from the most recently released version to the oldest supported version.

Returns: A list of available service point versions.

Return type: list[str]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_spversions()

for ver in result:
    print(ver)

New in version 20.6.1.

get_v1_api_tos()

Return the name, user email address, and timestamp when the current user accepted their Terms of Service.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.get_v1_api_tos()

New in version 20.12.1.

get_v1_api_users()

Return the list of users.

Returns: A list of all users.

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v1_api_users()

for user in result:
    print(user)

New in version 20.12.1.

get_v2_api_customer_dnsquerylog_count(site_name)

Returns the total count of logged DNS queries within 30 days for the specified site name.

Returns: Count of logged DNS queries within 30 days for the specified site name.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

site_name = <site_name>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v2_api_customer_dnsquerylog_count(site_name=site_name)

New in version 20.12.1.

get_v2_api_spimage_config(site_id)

Download the base64 encoded service point configuration information, including:

Returns: The base64 encoded service point configuration information.

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = <site_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v2_api_spimage_config(site_id=site_id)

print(result)

New in version 20.12.1.

get_v2_api_spimage_status(site_id)

Retrieve the status of the image generation.

Returns: The status of the image generation along with other information.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = <site_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v2_api_spimage_status(site_id=site_id)

print(result)

New in version 20.12.1.

get_v2_domainlists(name_contains=None)

Return a list of domain lists (that match the specified search string).

Returns: A list of domain lists (that match the specified search string).

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v2_domainlists()

for r in result:
    print(r)

New in version 20.6.1.

get_v2_domainlists_by_id(domain_list_id)

Return a specific domain list.

Returns: Information of the domain list (that matches the given id) including: id, name, description, sourceType, domainCount, etc.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = "<domain_list_id>"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v2_domainlists_by_id(domain_list_id=domain_list_id)

print(result)

New in version 20.6.1.

get_v3_api_dnsquerylogs(filters=None)

Return a list of all (or optionally filtered) logged DNS queries.

Returns: The DNS queries (all or filtered).

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

filters = {
    "site_id": [<site_id_1>, <site_id_2>],
    "source_ip": "172.17.149.40"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v3_api_dnsquerylogs(filters=filters)

for q in result:
    print(q)

New in version 20.12.1.

get_v3_api_dnsquerylogs_by_id(query_id)

Return the details for a specific query.

Returns: Information of the DNS query including: time, source, siteId, query, queryType, response, id, actionTaken, matchedPolicies, authority, queryProtocol, threats, queriedNamespaces, latency

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

query_id = <query_id>

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v3_api_dnsquerylogs_by_id(query_id=query_id)

New in version 20.12.1.

get_v3_api_sites(name=None, name_contains=None, fields=None, desired_result_count=None, namespace_id=None, overrides_forwarders=None)

Return information about all the sites.

Returns: Sites information including: id, name, location, settings, registeredServicePointCount, version, updateInitiatedTimestamp, updateStatus, blockedServicePointIds

Return type: list[dict]

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v3_api_sites()

for sp in result:
    print(sp)

New in version 20.6.1.

get_v3_api_sites_by_id(site_id)

Return information of the site that matches the specified site ID.

Returns: Information of the site including: id, name, location, settings, registeredServicePointCount, updateStatus, updateInitiatedTime, version, blockedServicePointIds

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = '3f76fe19-900d-47ff-b00c-c3cab6f40903'         # Site ID

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v3_api_sites_by_id(site_id=site_id)

print(result)

New in version 20.6.1.

get_v5_api_policies(site_id=None, site_group_id=None, domain_list_id=None)

Get a list of all policies, or policies associated with a specified site, site group, or domain list.

Returns: A list of policies

Return type: list

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v5_api_policies()

for r in result:
    print(r)

New in version 20.12.1.

get_v5_api_policies_by_id(policy_id)

Search for a policy by policy ID.

Returns: Policy for the given policy ID.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.get_v5_api_policies_by_id(<policy_id>)

New in version 20.12.1.

handle_error_response(response)

Handle a response that’s considered to be an error. If the response matches an Edge error, an EdgeErrorResponse is raised. Otherwise, the handling is delegated to the base class’ implementation.

patch_v1_api_namespaces(namespaces)

Set (up to three) namespaces as defaults.

Example:

from bluecat_libraries.edge.api import EdgeClient

namespaces = [
    {
        "id": "<id of the namespace>",
        "isDefault": "true" or "false"
    },
    {
        "id": "<id of the other namespace>",
        "isDefault": "true" or "false"
    }
]

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.patch_v1_api_namespaces(namespaces=namespaces)

New in version 20.12.1.

patch_v2_domainlists(domain_list_id, domain_names_add=None, domain_names_remove=None)

Update the content of an existing domain list by adding or deleting domain names.

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = "<domain_list_id>"
domain_names_add = ["name-001", "name-002"]
domain_names_remove = ["name-003", "name-004"]

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.patch_v2_domainlists(domain_list_id=domain_list_id, domain_names_add=domain_names_add,
                                domain_names_remove=domain_names_remove)

New in version 20.6.1.

patch_v3_api_sites(payload)

Update the service point version of specified sites.

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = [
    {
        "id": "33709b0b-d429-45f1-8c82-51b2942a9133",
        "version": "3.0.5",
        "blockedServicePointIds": [
            "feac4ad6-adb6-4c8d-924e-d314d29ec96d",
            "91cbda2f-ac60-4a32-bc9f-02161e532b2d"]
    },
    {
        "id": "aaa0830d-4639-4210-9158-0ac6395e2396",
        "version": "3.0.6"
    }
]

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.patch_v3_api_sites(payload)

New in version 20.12.1.

post_v1_api_apikeys()

Create an API access key set for the current user.

Returns: Dictionary containing clientId and clientSecret that is created.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    api_key = client.post_v1_api_apikeys()

print(api_key)

New in version 20.6.1.

post_v1_api_customer_sitegroups_create(payload)

Create a new site group with the sites specified by site ID.

Returns: The details of the site group created.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient
payload = {
    "name":"name",
    "description":"description",
    "siteIds":["id1","id2"]
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_customer_sitegroups_create(payload=payload)

New in version 20.12.1.

post_v1_api_customer_sitegroups_delete(site_group_id)

Delete the site group specified by site group ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

site_group_id = 2

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_customer_sitegroups_delete(site_group_id=site_group_id)

New in version 20.12.1.

post_v1_api_customer_sitegroups_update(site_group_id, payload)

Update the site group specified by site group ID with the new name, description, or sites.

Example:

from bluecat_libraries.edge.api import EdgeClient

site_group_id = 2
payload = {
    "name":"name",
    "description":"description",
    "siteIds":["id1","id2"]
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_customer_sitegroups_update(site_group_id=site_group_id, payload=payload)

New in version 20.12.1.

post_v1_api_list_dns(payload)

Create a domain list.

Returns: The created domain list.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "name": "<domain-list-name>",
    "description": "<domain-list-description>",
    "sourceType": "user"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_list_dns(payload=payload)

print(result)

New in version 20.12.1.

post_v1_api_list_dns_attachfile(domain_list_id, file_handle)

Upload a CSV file containing a list of domain names to an existing DNS list.

Returns: A dictionary containing a number of registered domains.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    with open('file.csv', 'r') as f:
        client.authenticate(<client_id>, <client_secret>)
        result = client.post_v1_api_list_dns_attachfile(<domain_list_id>, f)

New in version 20.12.1.

post_v1_api_list_dns_delete(domain_list_id)

Delete the domain list specified by the domain list ID.

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_list_dns_delete(<domain_list_id>)

New in version 20.12.1.

post_v1_api_list_dns_sourceconfiguration(domain_list_id, payload)

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

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
            "hostName":"source.host.name.org",
            "privateKey":"privateKey",
            "filePath":"/location/location",
            "port":22,
            "transferType":"rsyncSSH",
            "user":"userName",
            "publicHostKey":"publicKey",
            "syncRate":5
        }
with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_list_dns_sourceconfiguration(<domain_list_id>, payload)

New in version 20.12.1.

post_v1_api_list_dns_update(domain_list_id, payload)

Update a domain list name, description, or source type.

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = "<domain_list_id>"
payload = {
   "name": "new domain list name",
   "description": "new domain list description",
   "sourceType": "dynamic"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.post_v1_api_list_dns_update(domain_list_id, payload)

New in version 20.12.1.

post_v1_api_namespaces(payload)

Create a namespace.

Returns: The ID of the created namespace.

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
   "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
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_namespaces(payload=payload)

print(result)

New in version 20.12.1.

post_v1_api_users(payload)

Create a new user. An email is sent to the user with a temporary password and instructions on how to log in and set a new password.

Returns: The ID of the created user.

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "email": "email address",
    "name": "first and last name",
    "role": "SYSADMIN | ADMIN | ANALYST",
    "status": "active | inactive"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v1_api_users(payload=payload)

print(result)

New in version 20.12.1.

post_v2_api_spimage_generate(payload)

Retrieve an OVA image of the specified site.

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "siteId": <site_id>
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v2_api_spimage_generate(payload=payload)

print(result)

New in version 20.12.1.

post_v2_domainlists(payload)

Create a domain list.

Returns: The ID of a new domain list.

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "name": "<domain-list-name>",
    "description": "<domain-list-description>",
    "sourceType": "user"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v2_domainlists(payload=payload)

print(result)

New in version 20.6.1.

post_v3_api_sites(payload)

Create a new site.

Returns: The ID of the created site.

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "name": "<site-name>",
    "location": {
    "address": "<address>"
    }
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    result = client.post_v3_api_sites(payload=payload)

print(result)

New in version 20.6.1.

post_v3_api_sites_clearcache(site_id)

Clear the cache of a site.

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = "28c1b312-55e0-4dc4-8253-de7ae37db25d"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.post_v3_api_sites_clearcache(site_id)

New in version 20.6.1.

post_v5_api_policies(payload)

Create a new policy.

Returns: The ID of the created policy

Return type: str

Example:

from bluecat_libraries.edge.api import EdgeClient

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.post_v5_api_policies(<payload>)

New in version 20.12.1.

put_v1_api_namespaces(namespace_id, payload)

Update the namespace specified by the namespace ID. Note that all the fields are updated with this action, whether you specify values or not. If you leave a field out, its value will be overwritten with no data.

Example:

from bluecat_libraries.edge.api import EdgeClient

namespace_id = <namespace_id>
payload = {
   "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
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v1_api_namespaces(namespace_id=namespace_id, payload=payload)

New in version 20.12.1.

put_v1_api_settings(payload)

Update the automatic service point update settings.

Example:

from bluecat_libraries.edge.api import EdgeClient

payload = {
    "spAutomaticUpdatesEnabled": "true" or "false"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v1_api_settings(payload)

New in version 20.12.1.

put_v1_api_users(user_id, payload)

Update the email address, name, role, and status of the user specified by the user ID.

Returns: The updated user.

Return type: dict

Example:

from bluecat_libraries.edge.api import EdgeClient

user_id = <user_id>
payload = {
    "email":"new email address",
    "name":"new name",
    "role":"ADMIN | ANALYST",
    "status":"active | inactive"
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v1_api_users(user_id=user_id, payload=payload)

New in version 20.12.1.

put_v2_domainlists(domain_list_id, domain_names)

Replace all domains within a domain list by supplying a list of domain names.

Example:

from bluecat_libraries.edge.api import EdgeClient

domain_list_id = "<domain_list_id>"
domain_names = ["name-001", "name-002"]

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v2_domainlists(domain_list_id=domain_list_id, domain_names=domain_names)

New in version 20.6.1.

put_v3_api_sites(site_id, payload)

Update an existing site. Note that all the parameters are updated with this action, whether you specify the values or not. If you leave a parameter out, its value will be overwritten with no data.

Example:

from bluecat_libraries.edge.api import EdgeClient

site_id = "28c1b312-55e0-4dc4-8253-de7ae37db25d"
payload = {
    "name": "the new site name",
    "location": {
         "address": "123 Main St., Toronto",
         "lng": "-79.3756671",
         "lat": "43.6421529"
     }
}

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v3_api_sites(site_id, payload)

New in version 20.6.1.

put_v5_api_policies(policy_id, payload)

Update the policy specified by the policy ID. Note that all the fields are updated with this action, whether you specify any values or not. If you leave a field out, it’s value will be overwritten with no data.

Example:

from bluecat_libraries.edge.api import EdgeClient

policy_id = "<policy_id>"

with EdgeClient(<edge_ci_url>) as client:
    client.authenticate(<client_id>, <client_secret>)
    client.put_v5_api_policies(policy_id, <payload>)

New in version 20.12.1.