What's New in v25.1.0 - BlueCat Integrity - 25.1.0

Address Manager RESTful v2 API Guide
ft:locale
en-US
Product name
BlueCat Integrity
Version
25.1.0

Address Manager database reset and restore

Starting in Address Manager v25.1, Address Manager administrators can reset and restore the Address Manager database using the RESTful v2 API. The following endpoints have been added for database reset and restore:
  • GET /api/v2/databases/{collectionId}/restores
  • GET /api/v2/databases/{collectionId}/restores/{id}
  • POST /api/v2/databases/{collectionId}/restores
The POST /api/v2/databases/{collectionId}/restores endpoint allows you to reset or restore the Address Manager database from a backup file, depending on the HTTP header passed.

If you are resetting the Address Manager database to the factory settings, call the POST /api/v2/databases/{collectionId}/restores API with the x-bcn-reset-database HTTP header set to true. If you are resetting the Address Manager database, you do not need to pass in content in the API body.

If you are restoring the Address Manager database from a backup file, call the POST /api/v2/databases/{collectionId}/restores API with the database file that you would like to restore in the restoreFile parameter of the body.
Note:
  • The database backup file must exist on Address Manager before you can perform the database restore.
  • If you are backing up the Address Manager database from a backup file that was created on an earlier version of Address Manager software, you can specify the x-bcn-force-restore HTTP header set to true to ensure that Address Manager proceeds with the database restore, regardless of whether the backup file is from an older software version.

Address Manager and DNS/DHCP Server support bundles

New in v25.1.0, Address Manager administrators can use the RESTful v2 API to create, retrieve, and delete Address Manager and DNS/DHCP Server support bundles used for troubleshooting procedures with BlueCat Customer Care. The following endpoints can be used to create and manage support bundles:

Address Manager support bundles:

  • GET /api/v2/logs
  • GET /api/v2/logs/{id}
  • POST /api/v2/logs
  • DELETE /api/v2/logs/{id}

DNS/DHCP Server support bundles:

  • GET /api/v2/servers/{collectionId}/logs
  • GET /api/v2/servers/{collectionId}/logs/{id}
  • POST /api/v2/servers/{collectionId}/logs
  • DELETE /api/v2/servers/{collectionId}/logs/{id}

Appliance information enhancements

New in the v25.1.0 RESTful v2 API, additional Address Manager appliance information fields have been added to the SystemSettings resource returned by the /api/v2/settings endpoint. The following fields have been added:

  • macAddress
  • manufacturer
  • model
  • serviceTag
  • replicationRole
  • dateTime
  • timezone

Additional DNS/DHCP Server appliance information fields have also been added to the Server resource returned by /api/v2/servers. The following fields have been added:

  • version
  • manufacturer
  • model
  • serviceTag
  • haOnline
  • haLocalRole
  • haPeerRole
  • haPeerDiskState
  • haNode
  • encryptedNotificationsEnabled
Note: The encryptedNotificationsEnabled field will return a boolean value only for v25.1.0+ DNS/DHCP Servers. DNS/DHCP Servers running earlier software versions will return a null value.

Filter by blocks and networks by tag

New in the v25.1 RESTful v2 API, tags can be used as filterable fields for IPv4Block/IPv6Block and IPv4Network/IPv6Network resources. The following fields are supported as filterable:
  • _embedded.tags.id
  • _embedded.tags.name

Extended IP reconciliation functionality

The v25.1 RESTful v2 API extends support for IP reconciliation policies by allowing API users to manually run reconciliation policies, retrieve discovered IP address reconciliations, reconcile discovered IP addresses with reconciliation tasks, and view reconciliation task events. The following endpoints have been added to the RESTful v2 API to extend IP reconciliation functionality:

Run reconciliation policies and retrieve discovered IP address reconciliations:

  • PATCH /api/v2/reconciliationPolicies/{id}
  • GET /api/v2/reconciliations
  • GET /api/v2/reconciliationPolicies/{collectionId}/reconciliations
  • GET /api/v2/reconciliationPolicies/{collectionId}/reconciliations/{id}
  • GET /api/v2/configurations/{collectionId}/reconciliations
  • GET /api/v2/configurations/{collectionId}/reconciliations/{id}
  • DELETE /api/v2/reconciliationPolicies/{collectionId}/reconciliations/{id}

Create reconciliation tasks to reconcile discovered IP addresses, and retrieve reconciliation tasks and task events:

  • POST /api/v2/reconciliationPolicies/{collectionId}/reconciliationTasks/
  • POST /api/v2/configurations/{collectionId}/reconciliationTasks/
  • GET /api/v2/reconciliationTasks/{id}
  • GET /api/v2/reconciliationTasks/
  • GET /api/v2/reconciliationPolicies/{collectionId}/reconciliationTasks/{id}
  • GET /api/v2/reconciliationPolicies/{collectionId}/reconciliationTasks/
  • GET /api/v2/configurations/{collectionId}/reconciliationTasks/{id}
  • GET /api/v2/configurations/{collectionId}/reconciliationTasks/
  • GET /api/v2/reconciliationTasks/{collectionId}/events/{id}
  • GET /api/v2/reconciliationTasks/{collectionId}/events/

Address Manager metrics service

To support the enhancements to metrics collection and visualization (Prometheus support) introduced in Address Manager and DNS/DHCP Server v25.1, the MetricsService and MetricsExporterService resources have been added to the GET /api/v2/services, GET /api/v2/services/{id}, and PUT /api/v2/services/{id} endpoints for Address Manager metrics configuration. For DNS/DHCP Server metrics configuration, the MetricsExporterService resource has been added to the GET /api/v2/servers/{collectionId}/services, GET /api/v2/servers/{collectionId}/services/{id}, and PUT /api/v2/servers/{collectionId}/services/{id} endpoints. As the new metrics service and metrics exporter service replace the previous Address Manager and DNS/DHCP Server monitoring service, the MonitoringSettings resource has been removed from the GET /api/v2/settings, GET /api/v2/settings/{id}, and PUT /api/v2/settings/{id} endpoints.

Address Manager and DNS/DHCP Server updates

The v25.1.0 RESTful v2 API introduces support for upload, management, and application of Address Manager and DNS/DHCP Server update and patch files. The following endpoints have been added in v25.1:

Uploading and managing Address Manager and DNS/DHCP Server updates and patches:

  • POST /api/v2/updates
  • GET /api/v2/updates
  • GET /api/v2/updates/{id}
  • DELETE /api/v2/updates/{id}

Applying Address Manager updates and patches:

  • POST /api/v2/updateApplications
  • GET /api/v2/updateApplications
  • GET /api/v2/updateApplications/{id}

Applying DNS/DHCP Server updates and patches:

  • POST /api/v2/servers/{collectionId}/updateApplications
  • GET /api/v2/servers/{collectionId}/updateApplications

Naming policy values and restrictions

New in the v25.1 RESTful v2 API, naming policy values and naming policy restrictions can be added to and removed from naming policies using the following endpoints:

  • POST /api/v2/namingPolicies/{collectionId}/policyValues
  • DELETE /api/v2/namingPolicies/{collectionId}/policyValues/{id}
  • POST /api/v2/namingPolicies/{collectionId}/policyRestrictions
  • DELETE/api/v2/namingPolicies/{collectionId}/policyRestrictions/{id}

Users can also retrieve naming policies linked to a specific value or restriction using the following endpoints:

  • GET /api/v2/namingPolicyValues/{collectionId}/namingPolicies
  • GET /api/v2/namingPolicyRestrictions/{collectionId}/namingPolicies
  • GET /api/v2/namingPolicyValues/{collectionId}/namingPolicies/{id}
  • GET /api/v2/namingPolicyRestrictions/{collectionId}/namingPolicies/{id}

HSM support

The v25.1.0 RESTful v2 API introduces support for the creation and management of HSM configurations and servers. The following API endpoints have been added to facilitate HSM support:

  • GET /api/v2/hsmConfigurations
  • GET /api/v2/hsmConfigurations/{id}
  • POST /api/v2/hsmConfigurations
  • PUT /api/v2/hsmConfigurations/{id}
  • PATCH /api/v2/hsmConfigurations/{id}
  • DELETE /api/v2/hsmConfigurations/{id}
  • GET /api/v2/hsmConfigurations/{collectionId}/hsmServers
  • POST /api/v2/hsmConfigurations/{collectionId}/hsmServers
  • GET /api/v2/hsmServers/
  • GET /api/v2/hsmServers/{id}
  • PUT /api/v2/hsmServers/{id}
  • DELETE /api/v2/hsmServers/{id}
  • GET /api/v2/servers/{collectionId}/hsmServers
  • GET /api/v2/hsmServers/{collectionId}/servers
  • GET /api/v2/hsmConfigurations/{collectionId}/signingPolicies

Server diagnostics

The v25.1 RESTful v2 API introduces support for DNS/DHCP Server diagnostics services to facilitate actions such as starting and stopping services, clearing the DNS cache, restarting DNS/DHCP Servers, and downloading service configurations. Service resources for DNS (DNSService), DHCPv4 (DHCPv4Service), DHCPv6 (DHCPv4Service), and the server system (ServerSystemService) are now supported for the following endpoints.

  • GET /api/v2/servers/{collectionId}/services/{id}
  • GET /api/v2/servers/{collectionId}/services
  • PUT /api/v2/servers/{collectionId}/services/{id}

The headers x-bcn-clear-cache-from-view, x-bcn-clear-cache-from-domains, and x-bcn-clear-cached-hosts have also been added for clearing the DNS cache, for more information refer to v25.1.0 HTTP headers.

Users can also retrieve DNS, DHCPv4, and DHCPv6 configuration files using the /api/v2/servers/{collectionId}/files and /api/v2/servers/{collectionId}/files/{id} endpoints.

DNS64 declarations

The v25.1 RESTful v2 API introduces support for DNS64 configuration using the following endpoints:

  • GET /api/v2/dns64Declarations
  • GET /api/v2/dns64Declarations/{id}
  • PUT /api/v2/dns64Declarations/{id}
  • DELETE /api/v2/dns64Declarations/{id}
  • POST /api/v2/views/{collectionId}/dns64Declarations
  • GET /api/v2/views/{collectionId}/dns64Declarations
  • GET /api/v2/views/{collectionId}/dns64Declarations/{id}

Address Manager reports and schedules

The v25.1.0 RESTful v2 API introduces the ability to create and manage Address Manager reports and report schedules through the API. The following endpoints have been added for configuration of Address Manager reports and report schedules:

Note: For more information on available Address Manager report types and associated data, refer to Report types in the Address Manager Administration Guide.
  • GET /api/v2/reports/{id}
  • GET /api/v2/reports
  • POST /api/v2/reports
  • PUT /api/v2/reports/{id}
  • DELETE /api/v2/reports/{id}
  • GET /api/v2/schedules/{collectionId}/reports/{id}
  • GET /api/v2/schedules/{collectionId}/reports
  • GET /api/v2/reports/{collectionId}/schedules/{id}
  • GET /api/v2/reports/{collectionId}/schedules
  • POST /api/v2/schedules/{collectionId}/reports
  • DELETE /api/v2/schedules/{collectionId}/reports
  • GET /api/v2/users/{collectionId}/schedules/{id}
  • GET /api/v2/users/{collectionId}/schedules
  • GET /api/v2/groups/{collectionId}/schedules/{id}
  • GET /api/v2/groups/{collectionId}/schedules
  • POST /api/v2/schedules
  • POST /api/v2/reports/{collectionId}/schedules
  • POST /api/v2/users/{collectionId}/schedules
  • POST /api/v2/groups/{collectionId}/schedules
  • DELETE /api/v2/reports/{collectionId}/schedules/{id}
  • DELETE /api/v2/users/{collectionId}/schedules/{id}
  • DELETE /api/v2/groups/{collectionId}/schedules/{id}
  • POST /api/v2/schedules/{id}
  • GET /api/v2/schedules/{collectionId}/subjects
  • POST /api/v2/schedules/{collectionId}/subjects
  • GET /api/v2/schedules/{collectionId}/subjects/{id}
  • DELETE /api/v2/schedules/{collectionId}/subjects/{id}
    Note: ReportSchedule resources can be retrieved, updated, and deleted using the following endpoints GET /api/v2/schedules and GET /api/v2/schedules/{id} PUT /api/v2/schedules/{id} and DELETE /api/v2/schedules/{id}.

Available IPv4/IPv6 addresses, blocks, and networks

The v25.1 RESTful v2 API introduces support for retrieving available IPv4/IPv6 addresses, blocks and networks using the following new endpoints:

  • GET /api/v2/networks/{collectionId}/availableAddresses
  • GET /api/v2/blocks/{collectionId}/availableAddresses
  • GET /api/v2/configurations/{collectionId}/availableAddresses
  • GET /api/v2/blocks/{collectionId}/availableAddresses
  • GET /api/v2/blocks/{collectionId}/availableBlocks
  • GET /api/v2/blocks/{collectionId}/availableBlocks/{id}
  • GET /api/v2/configurations/{collectionId}/availableBlocks
  • GET /api/v2/configurations/{collectionId}/availableBlocks/{id}
  • GET /api/v2/blocks/{collectionId}/availableNetworks
  • GET /api/v2/blocks/{collectionId}/availableNetworks/{id}
  • GET /api/v2/configurations/{collectionId}/availableNetworks
  • GET /api/v2/configurations/{collectionId}/availableNetworks/{id}

Split IPv6 blocks and networks

New in the v25.1 RESTful v2 API, users can split IPv6 blocks and networks using the following endpoints:

  • GET /api/v2/splits/{id}
  • GET /api/v2/splits/
  • GET /api/v2/blocks/{collectionId}/splits/{id}
  • GET /api/v2/blocks/{collectionId}/splits/
  • POST /api/v2/blocks/{collectionId}/splits/

DHCP lease synchronization

New in the v25.1 RESTful v2 API, users can refresh DHCP lease states for specified networks or servers and retrieve DHCP lease synchronization tasks using the following endpoints:

  • GET /api/v2/leaseSyncTasks/{id}
  • GET /api/v2/leaseSyncTasks
  • GET /api/v2/networks/{collectionId}/leaseSyncTasks
  • GET /api/v2/servers/{collectionId}/leaseSyncTasks
  • POST /api/v2/networks/{collectionId}/leaseSyncTasks
  • POST /api/v2/servers/{collectionId}/leaseSyncTasks

Moving TFTP files and folders

New in the v25.1 RESTful v2 API, users can move TFTP files and folders using the following endpoints

  • POST /api/v2/files/{collectionId}/moves
  • GET /api/v2/files/{collectionId}/moves

Dependent records

In the v25.1 RESTful v2 API, the GET /api/v2/resourceRecords/{collectionId}/dependentRecords and GET /api/v2/resourceRecords/{collectionId}/dependentRecords/{id} now return dependent HTTPS records, MX records, SRV records, and SVCB records in addition to alias records.

Bulk DNS updates

The v25.1 RESTful v2 API introduces support for bulk DNS updates in CSV format using the POST /api/v2/views/{collectionId}/bulkUpdates and POST /api/v2/zones/{collectionId}/bulkUpdates endpoints.

Linked resources

Four new endpoints have been added to the v25.1 RESTful v2 API to support retrieving resources linked to access control lists and TSIG keys:

  • GET /api/v2/accessControlLists/{collectionId}/linkedResources
  • GET /api/v2/accessControlLists/{collectionId}/linkedResources/{id}
  • GET /api/v2/signingKeys/{collectionId}/linkedResources
  • GET /api/v2/signingKeys/{collectionId}/linkedResources/{id}

Generate signing keys

The following endpoints have been added in the v25.1 RESTful v2 API to support the auto-generation of signing keys for reverse zones:
  • POST /api/v2/blocks/{collectionId}/signingKeys
  • POST /api/v2/networks/{collectionId}/signingKeys
  • POST /api/v2/zones/{collectionId}/signingKeys

Raw option definitions

The GET /api/v2/deploymentOptionDefinitions and GET /api/v2/deploymentOptionDefinitions/{id} endpoints now return deployment option definitions for DNS raw options (DNSRawOptionDefinition), DHCPv4 raw options (DHCPv4RawOptionDefinition), and DHCPv6 raw options (DHCPv6RawOptionDefinition).

Delete user-defined links

New in the v25.1 RESTful v2 API, users can delete user-defined links for a linked resource using the DELETE /api/v2/userDefinedLinkDefinitions/{collectionId}/linkedResources/{id} endpoint.

Reset password functionality

New in the v25.1 RESTful v2 API, the passwordResetRequired field of user resources is supported as a patchable field for the PATCH /api/v2/users/{id} endpoint to allow API users to reset user passwords.

Cancelling deployments

New in the v25.1 RESTful v2 API, the PATCH /api/v2/deployments/{id} endpoint has been added to allow users to cancel deployments through the API.

Gateway service enhancements

The v25.1 RESTful v2 API extends support for Gateway on DNS/DHCP Server service configuration by allowing users to start or stop Gateway instances through the PATCH /servers/{collectionId}/services/{id} endpoint. In addition, a new PUT /api/v2/servers/{collectionId}/services/{gatewayServiceId} endpoint has been added for users to manually upload Gateway images using the v2 API.

Importing resource records from server

The v25.1 RESTful v2 API introduces support for the import of resource records from external DNS servers into Address Manager zones using the /api/v2/zones/{collectionId}/imports endpoint.

Users can retrieve ImportsFromServer resources from the GET /api/v2/imports and /api/v2/imports/{id} endpoints.

Notification group subjects

The GET /api/v2/notificationGroups/{collectionId}/subjects/{id} endpoint has been added to the v25.1 RESTful v2 API to retrieve a user or user group that is linked to a notification group.

Multi-label zone names

To align functionality between the UI and API and prevent invalid zone configuration, the x-bcn-allow-multi-label-zone-names HTTP header has been removed from all associated endpoints:

  • POST /api/v2/views/{collectionId}/imports
  • POST /api/v2/views/{collectionId}/zones
  • POST /api/v2/zones/{collectionId}/zones
  • POST /api/v2/workflowRequests/{collectionId}/zones
  • PUT /api/v2/zones/{id}

Address workflow requests

The /api/v2/workflowRequests/{collectionId}/addresses endpoint has been added to the v25.1 RESTful v2 API to retrieve information about all address workflow requests under a parent network that is pending workflow request approval.

Authenticator endpoints and changes in behaviour

The following endpoints have been added to the v25.1 RESTful v2 API to support retrieving authenticators linked to users and groups, and available LDAP groups for LDAP authenticators:
  • GET /api/v2/groups/{collectionId}/authenticators
  • GET /api/v2/users/{collectionId}/authenticators
  • GET /api/v2/groups/{collectionId}/authenticators/{id}
  • GET /api/v2/users/{collectionId}/authenticators/{id}
  • GET /api/v2/authenticators/{collectionId}/availableGroups
  • GET /api/v2/authenticators/{collectionId}/availableGroups/{id}
In addition, the Authenticator field for User and UserGroup resources has been replaced with Authenticators, now containing an array of Authenticator resources.

Convert user group to SSO group

The PATCH /api/v2/groups/{id} endpoint has been added to the v25.1.0 RESTful v2 API for conversion of user groups to SSO groups.

Retrieving favorites

The GET /api/v2/users/{collectionId}/favorites/{id} endpoint has been added to the v25.1.0 RESTful v2 API to support retrieving a favorite linked to a user.

Data checker

New in the v25.1.0 RESTful v2 API, the following endpoints have been added to support retrieving data checker issues:
  • GET /api/v2/issues
  • GET /api/v2/issues/{id}
  • GET /api/v2/{collection}/{collectionId}/issues
Users can also retrieve and update DataCheckerSettings resources using the following endpoints:
  • GET /api/v2/settings
  • GET /api/v2/settings/{id}
  • PUT /api/v2/settings/{id}

Key distribution centers

The GET /api/v2/servicePrincipals/{collectionId}keyDistributionCenters endpoint has been added to the v25.1.0 RESTful v2 API to support retrieving overridden key distribution centers within a Kerberos service principal.

Top level IPv4 blocks

In the v25.1.0 RESTful v2 API, users can create and retrieve top level IPv4 blocks using the following endpoints:
  • GET /api/v2/configurations/{collectionId}/imports/{id}
  • GET /api/v2/configurations/{collectionId}/imports
  • POST /api/v2/configurations/{collectionId}/imports

Server logs

New in the v25.1.0 RESTful v2 API, the GET /api/v2/logs endpoint now returns DatabaseLog and ImportLog resources.

Users can also delete logs using the following endpoints:
  • DELETE /api/v2/logs/{id}
  • DELETE /api/v2/servers/{collectionId}/logs/{id}

Global access rights

To support the new global access rights (formerly administrative access rights) added in Address Manager v25.1.0 for deployment history, user sessions, user-defined fields, and user-defined links, the Deployment, UserSession, UserDefinedLinkDefinition, and UserDefinedFieldDefinition resourceTypes have been added to the AdministrativeAccessRight resource.

Configurations

The following fields have been added to Configuration resources in the v25.1.0 RESTful v2 API:

  • dataCheckerState
  • dataCheckerEnabled
  • feedCategories
  • ipOverlapConfigurations

Resource records

New in the v25.1.0 RESTful v2 API, resource record resources now include the View resource associated with the resource record's parent zone.

IP overlap detection

New in the v25.1.0 RESTful v2 API, an ipOverlapAllowed field has been added to IPv4Block and IPv4Network resources to indicate whether override IP overlap detection is enabled.