HTTP headers - BlueCat Integrity - 9.6.0

Address Manager RESTful v2 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.6.0
The v9.6.0 Address Manager RESTful v2 API supports the following HTTP headers to provide additional options when creating and updating v2 API resources:
Note: Starting in v9.6.0, the HTTP header x-bcn-link-to-external-host is replaced by the linkedRecord.type field within the Alias, MX, and SRV record resource.

x-bcn-link-to-external-host used in v9.5.0 indicates whether the linked record is an external host (only when provided with an absolute name) when creating and updating Alias, MX, and SRV records.

HTTP Header Used For Action
x-bcn-change-control-comment Adding a change control comment Adds a change control comment.
x-bcn-reuse-existing Creating IPv4 blocks and networks Indicates whether preexisting empty ranges will be searched when using the `DEPTH_FIRST` traversal method to determine the starting address of the block/network.
x-bcn-traversal-method Creating IPv4 blocks and networks Sets the algorithm used to determine the starting address of the block/network when only a size was provided for the `range` value. Refer to the Swagger documentation for more information.
x-bcn-force-zone-transfer Deployments Indicates whether to force a re-transfer of DNS zone data to a secondary DNS server where the primary DNS role belongs to an individual primary DNS server or servers in a multi-primary server group.
x-bcn-no-gateway Creating and updating IPv4 networks Indicates whether the IPv4 network should not contain a gateway address
x-bcn-create-reverse-record Assigning IPv4/IPv6 addresses Indicates whether a reverse record should be created for the host.
x-bcn-excluded-addresses Assigning IPv4 addresses A comma-separated list of IPv4 addresses and/or IPv4 address ranges to skip when searching for the next available address.
x-bcn-override-naming-policy Creating and updating resource records Indicates whether to override the naming policy for the view or zone when creating the resource record.
x-bcn-allow-multi-label-zone-names Creating and updating zones Indicates whether a dotted zone name will be used when an absolute name is specified, instead of creating non-existent subzones.
x-bcn-allow-address-overlap Auto-creation of networks when creating or updating resource records Indicates whether IP address overlap detection will be overridden for auto-created networks.
x-bcn-update-servers Moving addresses between networks, updating and deleting resource records Indicates whether Address Manager automatically deploys address or resource record updates to servers.
x-bcn-orphaned-address-state Updating DHCPv4 ranges Indicates the state to assign DHCP allocated IPv4 addresses that are no longer part of the resized range.
x-bcn-auto-create-network Creating and updating resource records Indicates whether a network will be automatically created if a network containing the IP address or addresses specified in the resource record does not already exist.
x-bcn-same-as-zone Creating and updating resource records Indicates whether the zone name will be used for the resource record name.
x-bcn-reset-services Updating DNS/DHCP Servers Indicates whether to reset configurations for DNS, DHCP, and TFTP services on the DNS/DHCP Server. Refer to the Swagger documentation for more information.
x-bcn-upgrade-server Adding and updating DNS/DHCP Servers Indicates whether to apply the latest version of DNS/DHCP Server software once the appliance is under Address Manager control.
x-bcn-reset-replication Removing Address Manager servers from replication clusters Indicates whether to reset replication on the Address Manager server, returning the server to its original stand-alone state.
x-bcn-force-failover Updating Address Manager servers in replication clusters Indicates whether to initiate failover on the primary Address Manager server in the database replication cluster.
x-bcn-reapply-certificates Address Manager HTTPS configuration Indicates whether to reapply the previously configured custom server certificate.
x-bcn-force-undo Undoing transactions Indicates whether to force undo a transaction if the undo operation is blocked due to broken optional resource dependencies.
x-bcn-ping-before-assignment Assigning IP addresses If set to true, Address Manager will ping IP addresses before assigning them. If set to false, Address Manager will assign addresses without checking their availability. This value overrides the value configured for network.