What's New in BlueCat Gateway v20.12.1 - Platform - BlueCat Gateway - 20.12.1

Gateway Administration Guide

BlueCat Gateway

The following features and functionality are new in BlueCat Gateway v20.12.1

Better Gateway Deployments with expanded Built-in workspace

Improve BlueCat Gateway deployments with the expanded Built-in workspace. Initially introduced to support only the workflow data, the Built-in workspace now supports workflow configurations, permissions, and customizations. This expanded support means you can now place everything needed to satisfy your automation use-cases into the Built-in workspace, build a custom image, then deploy the Gateway container to Production. Deploy the same container repeatedly and consistently, improving container resiliency, redundancy, and scalability.

For more information, refer to the Built-in Workspace section in the BlueCat Gateway Help & Documentation or the BlueCat Gateway Administration Guide.

Security and Compliance Enhancements

BlueCat Gateway v20.12.1 increases security and compliance standards for session cookies, data in transit, as well as security headers and responses.
Attention: The default settings for the following security and compliance enhancements will result in breaking changes to existing Gateway workflows, applications, and plugins. As a part of the upgrade to BlueCat Gateway v20.12.1, BlueCat advises all Gateway customers to modify the settings as needed, as well as to update their existing workflow as necessary.
  • HTTPS enabled by default for the Flask session cookie. For more information, refer to the Logging into BlueCat Gateway section in the BlueCat Gateway Help & Documentation or the BlueCat Gateway Installation Guide.
  • Added the flask-talisman extension to allow additions to security headers to all responses: Content-Security-Policy, Strict-Transport-Security, X-Content-Type-Options, and XSS-Protection.
  • Removed Server header from all responses as they disclose HTTP server and version.
  • Added explicit cache control on all standard BlueCat Gateway pages and endpoints.

Support for Cross-Origin Resource Sharing (CORS) requests

CORS is an HTTP header-based mechanism that allows a server to indicate any other origins than its own from which a browser should allow loading of resources.

Import and export CSV files in DataTables

BlueCat Gateway now includes the ability to import or export CSV files in any workflows that use the DataTables UI component. By default, the Export CSV button is enabled in the BlueCat Gateway user interface.

For more information, refer to the Importing and exporting CSV files in DataTables section in the BlueCat Gateway Help & Documentation or the BlueCat Gateway Administration Guide.

BlueCat Edge Python API Library (Phase II)

BlueCat Gateway v20.12.1 continues the delivery of the BlueCat Edge Python library in Gateway. The first offering (v20.6.1) delivered wrapped endpoints for key Edge use-cases. With this enhancement, BlueCat Gateway establishes itself as the connective tissue between the BlueCat Integrity and Edge product families, opening up a world of possibilities for innovative and creative automation solutions for Edge, Integrity, and third-party integrations.

BlueCat includes the following Python methods for Edge API:

  • DNS - Management of DNS.
    • get_v1_api_list_dns

      Return a list of domain lists.

    • post_v1_api_list_dns

      Create a domain list.

    • post_v1_api_list_dns_attachfile

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

    • post_v1_api_list_dns_delete

      Delete the domain list specified by the domain list ID.

    • get_v1_api_list_dns_search

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

    • post_v1_api_list_dns_sourceconfiguration

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

    • post_v1_api_list_dns_update

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

  • DNS Query Logs - Management of DNS Query Logs.
    • get_v2_api_customer_dnsquerylog_count

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

    • get_v3_api_dnsquerylogs

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

    • get_v3_api_dnsquerylogs_by_id

      Return the details for a specific query.

  • Namespaces - Management of namespaces.
    • get_v1_api_namespaces

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

    • get_v1_api_namespaces_by_id

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


      Create a namespace.

    • put_v1_api_namespaces

      Update the namespace specified by the namespace ID.

    • patch_v1_api_namespaces

      Set (up to three) namespaces as defaults.

    • delete_v1_api_namespaces

      Delete the namespace specified by the namespace ID.

  • Policies - Management of policies.
    • get_v5_api_policies

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

    • post_v5_api_policies

      Create a new policy.

    • get_v5_api_policies_by_id

      Search for a policy by policy ID.

    • put_v5_api_policies

      Update an existing policy.

    • delete_v5_api_policies

      Delete the policy specified by the policy ID.

  • Service Point Image - Management of Service Point Image
    • get_v2_api_spimage_config

      Download the base64 encoded service point configuration information.

    • post_v2_api_spimage_generate

      Retrieve an OVA image of the specified site.

    • get_v2_api_spimage_status

      Retrieve the status of the image generation.

  • Settings - Management of Settings
    • get_v1_api_settings

      Retrieve the automatic service point update settings.

    • put_v1_api_settings

      Update the automatic service point update settings.

  • Sites - Management of a collection of sites or physical locations (for example, stores or regional offices) where service points are housed.
    • patch_v3_api_sites

      Update the service point version of specified sites.

  • Site Groups - Management of a group of sites.
    • post_v1_api_customer_sitegroups_create

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

    • post_v1_api_customer_sitegroups_delete

      Delete the site group specified by site group ID.

    • post_v1_api_customer_sitegroups_update

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

  • System Lists - Management of System Lists
    • get_v1_api_list_system

      Return the specified system-maintained domain lists.

    • get_v1_api_list_system_content

      Return the contents of the specified system-maintained domain lists in JSON or CSV format.

    • get_v1_api_list_system_information

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

  • Terms of Service - Management of Terms of Service
    • get_v1_api_tos

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

  • Users - Management of Users
    • get_v1_api_authentication_token_describe

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

    • get_v1_api_users

      Return a list of users.

    • post_v1_api_users

      Create a new user.

    • put_v1_api_users

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

For complete information refer to the BlueCat Gateway Help & Documentation or the BlueCat Gateway Administration Guide.