The following HTTP headers are supported in the v25.1 RESTful v2 API to provide additional options when creating and updating v2 API resources:
| HTTP Header | Used For | Action |
|---|---|---|
| x-bcn-abort-on-error | Bulk DNS updates | Indicates whether the update process will be cancelled if there is an error with any of the updates. If set to true, none of the updates will be applied if any one update contains an error, with the exception of the delete action, where the error will be ignored if the record is not found in Address Manager. |
| x-bcn-allow-address-overlap | Auto-creating blocks and networks, finding available networks, moving blocks and networks | Indicates whether IP address overlap detection will be overridden when auto-creating blocks and networks, finding networks, or moving blocks and networks |
| x-bcn-allow-duplicate-hostnames | Assigning IP addresses | Indicates whether duplicate hostnames are allowed for the address. This value overrides the value configured for the network. |
| 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-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-clear-cached-hosts | Clearing the DNS cache | Specifies one or more hosts to clear DNS cache entries for. Provide a single hostname or multiple hostnames in a comma-separated list for the header value. When this header is provided with no other cache headers, all matching hostname cache entries in all views associated with the server will be cleared. When this header is provided with `x-bcn-clear-cache-from-view`, only matching hostname cache entries in the specified view will be cleared. |
| x-bcn-clear-cache-from-domains | Clearing the DNS cache | Specifies one or more domains to clear DNS cache entries from. Provide a single domain name or multiple domain names in a comma-separated list for the header value. When this header is provided with no other cache headers, all matching domain cache entries in all views associated with the server will be cleared. When this header is provided with `x-bcn-clear-cache-from-view`, only matching domain cache entries in the specified view will be cleared. |
| x-bcn-clear-cache-from-view | Clearing the DNS cache | Specifies a view to clear DNS cache entries from. Provide the view name for the header value. When this header is provided with no other cache headers, all cache entries within the view will be cleared. |
| x-bcn-create-parent-block | Creating IPv6 blocks | Indicates whether irregular IPv6 intervals will be rounded up during IPv6 block creation to match the closest valid CIDR block value. If no header is present `False` will be used by default. `False`: irregular intervals will fail with INVALID_IPV6_RANGE_VALUE response. `True`: irregular intervals will be rounded-up to the nearest valid CIDR block value. |
| x-bcn-create-reverse-record | Assigning IPv4/IPv6 addresses | Indicates whether a reverse record should be created for the host. |
| x-bcn-delete-mac-address-from-pool | Assigning, updating, and deleting IP addresses | Indicates whether to remove the associated MAC address from the MAC pool. |
| x-bcn-deploy-dynamic-records | Bulk DNS updates | Indicates whether the dynamic records are deployed to the server. |
| x-bcn-detect-server-settings | Creating servers | Indicates whether to return the settings of the unmanaged DNS/DHCP Server as a server resource. If set to true, the DNS/DHCP Server will not be taken under Address Manager control or added to the configuration. |
| 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-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-force-restore | Restoring the database | Indicates whether to restore the Address Manager database with an incompatible version. If set to true, Address Manager will proceed with the database restore, even if the backup file is from an older version of Address Manager software. |
| 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-force-zone-retransfer | 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-ignore-errors | Updating DHCP client classes | Indicates whether validation errors will be ignored when updating DHCP client classes |
| x-bcn-ignore-errors | Updating DHCP client classes | Indicates whether validation errors will be ignored when updating the DHCP client class. |
| x-bcn-move-dotted-resource-records | Creating zones | Indicates whether to move matching dotted-name resource records
to the new zone being created. For example, if this header is set to
true while creating zoneA.example.com, existing
resource record ex1.zoneA.example.com in zone
example.com will be moved to the new
zone. |
| x-bcn-no-gateway | Creating and updating IPv4 networks | Indicates whether the IPv4 network should not contain a gateway address |
| 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-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-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. |
| x-bcn-reapply-certificates | Address Manager HTTPS configuration | Indicates whether to reapply the previously configured custom server certificate. |
| x-bcn-repair-server | Repairing xHA nodes | Indicates the xHA node to repair. |
| x-bcn-replace-server | Replacing DNS/DHCP Servers | Indicates whether to replace the server. |
| x-bcn-reset-database | Resetting the database | Indicates whether to reset the Address Manager database. If set to true, Address Manager will proceed to reset the Address Manager database. |
| x-bcn-reset-database | Resetting the Address Manager database | The database reset flag. Forces database reset instead of restore. |
| x-bcn-reset-logo-image | Resetting the logo image for Address Manager reports | Indicates whether to reset the logo image. |
| 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-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-reuse-existing | Searching for available blocks and networks, 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-same-as-zone | Creating and updating resource records | Indicates whether the zone name will be used for the resource record name. |
| x-bcn-server-address | Importing resource records from external DNS servers | Indicates the IP address of the external DNS server from which to import the resource records. |
| x-bcn-server-address | Importing resource records into a zone | Indicates the address of the server from which to import zone data. |
| x-bcn-sign-zone | Assigning DNSSEC policies to zones | Indicates whether to sign the zone when the policy is applied. |
| x-bcn-traversal-method | Searching for available blocks and networks, 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-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-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-upgrade-to-default-version | Applying patches/updates to servers | Indicates whether to upgrade the DNS/DHCP Server to the latest version once the appliance is under Address Manager control, using the default update file bundled with Address Manager. Omit the `update` field if this header is set to true. |