Changes in Behavior - BlueCat Address Manager - 9.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.2.0

Address Manager API v9.2.0 includes the following changes:

  • The selectiveDeploy API has been enhanced to include the dynamicRecords option that defines how dynamic records are handled in selective deployment tasks.
  • You can now download the REST API specification file in JSON format from your browser using the following URL: http://<AddressManager_IP or hostname>/apidocs/api-spec.json. If HTTPS is enabled on Address Manager, use the HTTPS protocol in the address.
  • Secure Address Manager API with OAuth 2.0. Enabling OAuth secures the Address Manager API through the use of access tokens issued by the authorization server.
  • Previously, when importing objects using data migration, mandatory UDF fields that did not have values set would be imported with empty values. Starting in Address Manager v9.2.0, mandatory UDF fields of objects will inherit the default value if the value is not set.

Changes to required REST API parameters

Previously, a subset of REST API parameters were incorrectly configured as optional and allowed invalid, null, and empty values to be passed in through the parameter, resulting in incorrect configurations and inconsistencies with the SOAP API. The following API parameters have been updated to be required and perform validation for their associated API method:
  • /v1/login: the username and password parameters are now required when calling this method.
  • /v1/loginWithOptions: the username and password parameters are now required when calling this method.
  • /v1/addEntity: the parentId parameter is now required when calling this method.
  • /v1/addIP4BlockByCIDR: the parentId parameter is now required when calling this method.
  • /v1/addIP4BlockByRange: the parentId parameter is now required when calling this method.
  • /v1/addZone: the parentId parameter is now required when calling this method.
  • /v1/addAliasRecord: the viewId and ttl parameters are now required when calling this method.
  • /v1/addHostRecord: the viewId, addresses, and ttl parameters are now required when calling this method.
  • /v1/addView: the configurationId parameter is now required when calling this method.
  • /v1/addIP4Network: the blockId parameter is now required when calling this method.
  • /v1/addAccessRight: the entityId and userId parameters are now required when calling this method.
  • /v1/addIP6BlockByMACAddress: the parentId parameter is now required when calling this method.
  • /v1/addResponsePolicy: the configurationId and ttl parameters are now required when calling this method.
  • /v1/createXHAPair: the configurationId, activeServerId, and passiverServerId parameters are now required when calling this method.
  • /v1/breakXHAPair: the xHAServerId and breakInProteusOnly parameters are now required when calling this method.
  • /v1/deployServer: the serverId parameter is now required when calling this method.
  • /v1/addDHCPClientDeploymentOption: the entityId parameter is now required when calling this method.
  • /v1/addDHCPServiceDeploymentOption: the entityId parameter is now required when calling this method.
  • /v1/addDNSDeploymentOption: the entityId parameter is now required when calling this method.
  • /v1/addRawDeploymentOption: the parentId parameter is now required when calling this method.
  • /v1/addDHCP6ClientDeploymentOption: the entityId parameter is now required when calling this method.
  • /v1/addDHCP6ServiceDeploymentOption: the entityId parameter is now required when calling this method.
  • /v1/addDHCPDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/addDNSDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/splitIP4Network: the networkId and numberOfParts parameters are now required when calling this method.
  • /v1/addACL: the configurationId parameter is now required when calling this method.
  • /v1/addAdditionalIPAddresses: the serverId parameter is now required when calling this method.
  • /v1/addCustomOptionDefinition: the configurationId, optionId, and allowMultiple parameters are now required when calling this method.
  • /v1/addDevice: the configurationId, deviceTypeId, and deviceSubtypeId parameters are now required when calling this method.
  • /v1/addDeviceSubtype: the parentId parameter is now required when calling this method.
  • /v1/addDHCP4Range: the networkId parameter is now required when calling this method.
  • /v1/addDHCP4RangeBySize: the networkId parameter is now required when calling this method.
  • /v1/addDHCP6Range: the networkId parameter is now required when calling this method.
  • /v1/addDHCP6RangeBySize: the networkId parameter is now required when calling this method.
  • /v1/addDHCPMatchClass: the configurationId parameter is now required when calling this method.
  • /v1/addDHCPSubClass: the matchClassId parameter is now required when calling this method.
  • /v1/addEnumNumber: the enumZoneId and number parameters are now required when calling this method.
  • /v1/addEnumZone: the parentId and prefix parameters are now required when calling this method.
  • /v1/addExternalHostRecord: the viewId parameter is now required when calling this method.
  • /v1/addGenericRecord: the viewId and ttl parameters are now required when calling this method.
  • /v1/addHINFO: the viewId and ttl parameters are now required when calling this method.
  • /v1/addIP4IPGroupByRange: the parentId parameter is now required when calling this method.
  • /v1/addIP4IPGroupBySize: the parentId and size parameters are now required when calling this method.
  • /v1/addIP4NetworkTemplate: the configurationId parameter is now required when calling this method.
  • /v1/addZoneTemplate: the parentId parameter is now required when calling this method.
  • /v1/addIP4ReconciliationPolicy: the parentId parameter is now required when calling this method.
  • /v1/addIP6Address: the containerId parameter is now required when calling this method.
  • /v1/addIP6BlockByPrefix: the parentId parameter is now required when calling this method.
  • /v1/addIP6NetworkByPrefix: the parentId parameter is now required when calling this method.
  • /v1/addMACAddress: the configurationId parameter is now required when calling this method.
  • /v1/addMXRecord: the viewId, priority, and ttl parameters are now required when calling this method.
  • /v1/addNAPTRRecord: the viewId, order, preference, and ttl parameters are now required when calling this method.
  • /v1/addResourceRecord: the viewId and ttl parameters are now required when calling this method.
  • /v1/addSRVRecord: the viewId, priority, port, weight, and ttl parameters are now required when calling this method.
  • /v1/addTXTRecord: the viewId and ttl parameters are now required when calling this method.
  • /v1/addTag: the parentId parameter is now required when calling this method.
  • /v1/addTFTPGroup: the configurationId parameter is now required when calling this method.
  • /v1/addTFTPFolder: the parentId parameter is now required when calling this method.
  • /v1/addTFTPDeploymentRole: the entityId and serverId parameters are now required when calling this method.
  • /v1/addServer: the configurationId parameter is now required when calling this method.
  • /v1/addStartOfAuthority: the parentId, refresh, retry, expire, and minimum parameters are now required when calling this method.
  • /v1/addVendorOptionDefinition: the vendorProfileId, optionId, and allowMultiple parameters are now required when calling this method.
  • /v1/addDHCPVendorDeploymentOption: the parentId and optionId parameters are now required when calling this method.
  • /v1/assignIP4Address: the configurationId parameter is now required when calling this method.
  • /v1/assignIP6Address: the containerId parameter is now required when calling this method.
  • /v1/assignNextAvailableIP4Address: the configurationId and parentId parameters are now required when calling this method.
  • /v1/assignOrUpdateTemplate: the entityId and templateId parameters are now required when calling this method.
  • /v1/associateMACAddressWithPool: the configurationId and poolId parameters are now required when calling this method.
  • /v1/configureStreamingReplication: the compressReplication, latencyWarningThreshold, and latencyCriticalThreshold parameters are now required when calling this method.
  • /v1/deployServerServices: the serverId parameter is now required when calling this method.
  • /v1/deployServerConfig: the serverId parameter is now required when calling this method.
  • /v1/quickDeploy: the entityId parameter is now required when calling this method.
  • /v1/reapplyTemplate: the templateId parameter is now required when calling this method.
  • /v1/getLinkedNetworkConflicts: the templateId and networkId parameters are now required when calling this method.
  • /v1/assignIP4NetworkTemplate: the templateId and networkId parameters are now required when calling this method.
  • /v1/unassignIP4NetworkTemplate: the templateId and networkId parameters are now required when calling this method.
  • /v1/reassignIP6Address: the oldAddressId parameter is now required when calling this method.
  • /v1/mergeSelectedBlocksOrNetworks: the blockOrNetworkToKeep parameter is now required when calling this method.
  • /v1/uploadResponsePolicyItems: the parentId parameter is now required when calling this method.
  • /v1/addTFTPFile: the parentId parameter is now required when calling this method.
  • /v1/getEntityById: the id parameter is now required when calling this method.
  • /v1/getAccessRight: the entityId and userId parameters are now required when calling this method.
  • /v1/getUserDefinedFields: the requiredFieldsOnly parameter is now required when calling this method.
  • /v1/getNextAvailableIP4Address: the parentId parameter is now required when calling this method.
  • /v1/getEntites: the parentId, start, and count parameters are now required when calling this method.
  • /v1/getEntityByPrefix: the containerId parameter is now required when calling this method.
  • /v1/getEntityByName: the parentId parameter is now required when calling this method.
  • /v1/isAddressAllocated: the configurationId parameter is now required when calling this method.
  • /v1/getDHCPClientDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDHCPServiceDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDNSDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDNSDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/getDHCPDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/getDNSDeploymentRoleForView: the entityId, serverInterfaceId, and viewId parameters are now required when calling this method.
  • /v1/getAccessRightsForEntity: the entityId, start, and count parameters are now required when calling this method.
  • /v1/getAccessRightsForUser: the userId, start, and count parameters are now required when calling this method.
  • /v1/getAdditionalIPAddresses: the adonisId parameter is now required when calling this method.
  • /v1/getAliasesByHint: the start and count parameters are now required when calling this method.
  • /v1/getDeploymentOptions: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDeploymentRoles: the entityId parameter is now required when calling this method.
  • /v1/getDiscoveredDeviceHosts: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getDiscoveredDeviceInterfaces: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getDiscoveredDeviceMacAddressEntries: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getDiscoveredDeviceNetworks: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getDiscoveredDevices: the policyId parameter is now required when calling this method.
  • /v1/getDiscoveredDeviceVlans: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getEntitiesByName: the parentId, start, and count parameters are now required when calling this method.
  • /v1/getEntitiesByNameUsingOptions: the parentId, start, and count parameters are now required when calling this method.
  • /v1/getEntityByCIDR: the parentId parameter is now required when calling this method.
  • /v1/getHostRecordsByHint: the start and count parameters are now required when calling this method.
  • /v1/getIP4Address: the containerId parameter is now required when calling this method.
  • /v1/getIP4NetworksByHint: the containerId, start, and count parameters are now required when calling this method.
  • /v1/getIP6Address: the containerId parameter is now required when calling this method.
  • /v1/getIPRangedByIP: the containerId parameter is now required when calling this method.
  • /v1/getKSK: the entityId parameter is now required when calling this method.
  • /v1/getLinkedEntities: the entityId, start, and count parameters are now required when calling this method.
  • /v1/getMACAddress: the configurationId parameter is now required when calling this method.
  • /v1/getMaxAllowedRange: the rangeId parameter is now required when calling this method.
  • /v1/getNetworkLinkedProperties: the networkId parameter is now required when calling this method.
  • /v1/getNextAvailableIP4Network: the parentId, size, isLargerAllowed, and autoCreate parameters are now required when calling this method.
  • /v1/getNextAvailableIPRange: the parentId and size parameters are now required when calling this method.
  • /v1/getNextAvailableIPRanges: the parentId, size, and count parameters are now required when calling this method.
  • /v1/getNextIP4Address: the parentId parameter is now required when calling this method.
  • /v1/getParent: the entityId parameter is now required when calling this method.
  • /v1/getServerDeploymentRoles: the serverId parameter is now required when calling this method.
  • /v1/getServerDeploymentStatus: the serverId parameter is now required when calling this method.
  • /v1/getServerForRole: the roleId parameter is now required when calling this method.
  • /v1/getSharedNetworks: the tagId parameter is now required when calling this method.
  • /v1/getZonesByHint: the containerId, start, and count parameters are now required when calling this method.
  • /v1/searchByCategory: the start and count parameters are now required when calling this method.
  • /v1/searchByObjectTypes: the start and count parameters are now required when calling this method.
  • /v1/getDHCP6ClientDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDHCP6ServiceDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/getDHCPVendorDeploymentOption: the entityId, optionId, and serverId parameters are now required when calling this method.
  • /v1/editXHAPair: the xHAServerId parameter is now required when calling this method.
  • /v1/moveDeploymentRoles: the sourceServerId, targetServerInterfaceId, moveDnsRoles, and moveDhcpRoles parameters are now required when calling this method.
  • /v1/moveresourceRecord: the resourceRecordId parameter is now required when calling this method.
  • /v1/unlinkEntities: the entity1Id and entity2Id parameters are now required when calling this method.
  • /v1/unshareNetwork: the networkId parameter is now required when calling this method.
  • /v1/updateAccessRight: the entityId and userId parameters are now required when calling this method.
  • /v1/changeStateIP4Address: the addressId parameter is now required when calling this method.
  • /v1/replaceServer: the serverId and upgrade parameters are now required when calling this method.
  • /v1/resizeRange: the objectId parameter is now required when calling this method.
  • /v1/linkEntities: the entity1Id and entity2Id parameters are now required when calling this method.
  • /v1/purgeHistoryNow: the numberOfDaysToKeep, numberOfMonthsToKeep, and waitOption parameters are now required when calling this method.
  • /v1/denyMACAddress: the configurationId parameter is now required when calling this method.
  • /v1/failoverXHA: the xHAServerId parameter is now required when calling this method.
  • /v1/shareNetwork: the networkId and tagId parameters are now required when calling this method.
  • /v1/delete: the objectId parameter is now required when calling this method.
  • /v1/deleteDHCPClientDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/deleteDHCPDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/deleteDHCPServiceDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/deleteDNSDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/deleteDNSDeploymentRole: the entityId and serverInterfaceId parameters are now required when calling this method.
  • /v1/deleteDNSDeploymentRoleForView: the entityId, serverInterfaceId, and viewId parameters are now required when calling this method.
  • /v1/deleteAccessRight: the entityId and userId parameters are now required when calling this method.
  • /v1/deleteWithOptions: the objectId parameter is now required when calling this method.
  • /v1/clearIP6Address: the addressId parameter is now required when calling this method.
  • /v1/removeAdditionalIPAddresses: the serverId parameter is now required when calling this method.
  • /v1/deleteDHCP6ClientDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/deleteDHCP6ServiceDeploymentOption: the entityId and serverId parameters are now required when calling this method.
  • /v1/deleteDHCPVendorDeploymentOption: the entityId, optionId, and serverId parameters are now required when calling this method.
  • /v1/splitIP6Range: the rangeId and numberOfParts parameters are now required when calling this method.
  • /v1/getIP6ObjectsByHint: the containerId, start, and count parameters are now required when calling this method.
  • /v1/getDiscoveredDevice: the policyId and deviceId parameters are now required when calling this method.
  • /v1/getDiscoveredDeviceArpEntries: the policyId and deviceId parameters are now required when calling this method.
  • /v1/searchResponsePolicyItems: the start and count parameters are now required when calling this method.
  • /v1/getConfigurationSetting: the configurationId parameter is now required when calling this method.
  • /v1/updateConfigurationSetting: the configurationId parameter is now required when calling this method.
  • /v1/updateUserPassword: the userId parameter is now required when calling this method.
  • /v1/findResponsePoliciesWithItem: the configurationId parameter is now required when calling this method.
  • /v1/addResponsePolicyItem: the policyId parameter is now required when calling this method.
  • /v1/deleteResponsePolicyItem: the policyId parameter is now required when calling this method.