| Method Signature |
Description |
Path |
Workflow? |
| addACL(configurationId, name, properties, callback) |
Adds an Access Control List (ACL) to a view. |
{base_path}/{version}/v1/addACL?{query} |
Yes |
| addAliasRecord(absoluteName, linkedRecordName, properties, ttl, viewId, callback) |
Adds alias records. |
{base_path}/{version}/v1/addAliasRecord?{query} |
Yes |
| addBulkHostRecord(absoluteName, networkId, numberOfAddresses, properties, startAddress, ttl, viewId, callback) |
Adds bulk host records using auto-increment from the specific starting address. |
{base_path}/{version}/v1/addBulkHostRecord?{query} |
Yes |
| addDNSDeploymentOption(entityId, name, properties, value, callback) |
Adds DNS options. |
{base_path}/{version}/v1/addDNSDeploymentOption?{query} |
Yes |
| addEnumNumber(enumZoneId, number, properties, callback) |
Adds ENUM numbers. |
{base_path}/{version}/v1/addEnumNumber?{query} |
Yes |
| addEnumZone(parentId, prefix, properties, callback) |
Adds ENUM zones. |
{base_path}/{version}/v1/addEnumZone?{query} |
Yes |
| addExternalHostRecord(name, properties, viewId, callback) |
Adds external host records. |
{base_path}/{version}/v1/addExternalHostRecord?{query} |
Yes |
| addGenericRecord(absoluteName, properties, rdata, ttl, type, viewId, callback) |
Adds generic records. |
{base_path}/{version}/v1/addGenericRecord?{query} |
Yes |
| addHINFORecord(absoluteName, cpu, os, properties, ttl, viewId, callback) |
Adds HINFO records. |
{base_path}/{version}/v1/addHINFORecord?{query} |
Yes |
| addHostRecord(absoluteName, addresses, properties, ttl, viewId, callback) |
Adds host records for IPv4 or IPv6 addresses. |
{base_path}/{version}/v1/addHostRecord?{query} |
Yes |
| addMXRecord(absoluteName, linkedRecordName, priority, properties, ttl, viewId, callback) |
Adds MX records. |
{base_path}/{version}/v1/addMXRecord?{query} |
Yes |
| addNAPTRRecord(absoluteName, flags, order, preference, properties, regexp, replacement, service, ttl, viewId, callback) |
Adds NAPTR records. |
{base_path}/{version}/v1/addNAPTRRecord?{query} |
Yes |
| addResourceRecord(absoluteName, properties, rdata, ttl, type, viewId, callback) |
Add resource records. |
{base_path}/{version}/v1/addResourceRecord?{query} |
Yes |
| addResponsePolicy(configurationId, name, properties, responsePolicyType, ttl, callback) |
Adds a DNS response policy. |
{base_path}/{version}/v1/addResponsePolicy?{query} |
Yes |
| addResponsePolicyItem(itemName, options, policyId, callback) |
Adds a DNS response policy item under a specified local DNS response policy. |
{base_path}/{version}/v1/addResponsePolicyItem?{query} |
Yes |
| addSRVRecord(absoluteName, linkedRecordName, port, priority, properties, ttl, viewId, weight, callback) |
Adds SRV records. |
{base_path}/{version}/v1/addSRVRecord?{query} |
Yes |
| addStartOfAuthority(email, expire, minimum, parentId, properties, refresh, retry, callback) |
Adds SOA records. |
{base_path}/{version}/v1/addStartOfAuthority?{query} |
Yes |
| addTXTRecord(absoluteName, properties, ttl, txt, viewId, callback) |
Adds TXT records. |
{base_path}/{version}/v1/addTXTRecord?{query} |
Yes |
| addView(configurationId, name, properties, callback) |
Adds DNS views. |
{base_path}/{version}/v1/addView?{query} |
Yes |
| addZone(absoluteName, parentId, properties, callback) |
Adds DNS zones. |
{base_path}/{version}/v1/addZone?{query} |
Yes |
| addZoneTemplate(name, parentId, properties, callback) |
Adds a DNS zone template. |
{base_path}/{version}/v1/addZoneTemplate?{query} |
Yes |
| deleteDNSDeploymentOption(entityId, name, serverId, callback) |
Deletes DNS options. |
{base_path}/{version}/v1/deleteDNSDeploymentOption?{query} |
Yes |
| deleteResponsePolicyItem(itemName, options, policyId, callback) |
Deletes a DNS response policy item under a specified local DNS response
policy. |
{base_path}/{version}/v1/deleteResponsePolicyItem?{query} |
Yes |
| findResponsePoliciesWithItem(configurationId, itemName, options, callback) |
Finds local DNS response policies with their associated response policy items. |
{base_path}/{version}/v1/findResponsePoliciesWithItem?{query} |
Yes |
| getDNSDeploymentOption(entityId, name, serverId, callback) |
Retrieves all DNS options assigned for the object specified excluding the
options inherited from th |
{base_path}/{version}/v1/getDNSDeploymentOption?{query} |
Yes |
| getHostRecordsByHint(count, options, start, callback) |
Returns an array of objects with host record type. |
{base_path}/{version}/v1/getHostRecordsByHint?{query} |
Yes |
| getKSK(entityId, format, callback) |
Returns a string containing all active Key Signing Keys (KSK) for a given
entityId value in a speci |
{base_path}/{version}/v1/getKSK?{query} |
Yes |
| getNetworkLinkedProperties(networkId, callback) |
Returns an array of IP addresses with linked records and the IP addresses
that are assigned as DHCP |
{base_path}/{version}/v1/getNetworkLinkedProperties?{query} |
Yes |
| getZonesByHint(containerId, count, options, start, callback) |
Returns an array of accessible zones of child objects for a given containerId
value. |
{base_path}/{version}/v1/getZonesByHint?{query} |
Yes |
| moveResourceRecord(destinationZone, resourceRecordId, callback) |
Moves resource records between different zones that already exist. |
{base_path}/{version}/v1/moveResourceRecord?{query} |
Yes |
| searchResponsePolicyItems(count, keyword, properties, scope, start, callback) |
Searches Response Policy items configured in local Response Policies or
predefined BlueCat Security |
{base_path}/{version}/v1/searchResponsePolicyItems?{query} |
Yes |
| updateDNSDeploymentOption(body, callback) |
Updates DNS options. |
{base_path}/{version}/v1/updateDNSDeploymentOption?{query} |
Yes |
| uploadResponsePolicyItems(inputStream, parentId, body, callback) |
Uploads one response policy file containing a list of fully qualified domain
names (FQDNs). |
{base_path}/{version}/v1/uploadResponsePolicyItems?{query} |
Yes |
| addAccessRight(entityId, overrides, properties, userId, value, callback) |
Adds access rights to a specified object. |
{base_path}/{version}/v1/addAccessRight?{query} |
Yes |
| addDevice(configurationId, deviceSubtypeId, deviceTypeId, ip4Addresses, ip6Addresses, name, properties, callback) |
Adds a device to a configuration. |
{base_path}/{version}/v1/addDevice?{query} |
Yes |
| addDeviceSubtype(name, parentId, properties, callback) |
Adds a device sub-type to Address Manager. |
{base_path}/{version}/v1/addDeviceSubtype?{query} |
Yes |
| addDeviceType(name, properties, callback) |
Adds a device type to Address Manager. |
{base_path}/{version}/v1/addDeviceType?{query} |
Yes |
| addMACAddress(configurationId, macAddress, properties, callback) |
Adds MAC addresses. |
{base_path}/{version}/v1/addMACAddress?{query} |
Yes |
| addTag(name, parentId, properties, callback) |
Adds object tags. |
{base_path}/{version}/v1/addTag?{query} |
Yes |
| addTagGroup(name, properties, callback) |
Adds object tag groups. |
{base_path}/{version}/v1/addTagGroup?{query} |
Yes |
| addUser(password, properties, username, callback) |
Adds Address Manager users. |
{base_path}/{version}/v1/addUser?{query} |
Yes |
| addUserGroup(name, properties, callback) |
Adds user groups. |
{base_path}/{version}/v1/addUserGroup?{query} |
Yes |
| associateMACAddressWithPool(configurationId, macAddress, poolId, callback) |
Associates a MAC address with a MAC pool. |
{base_path}/{version}/v1/associateMACAddressWithPool?{query} |
Yes |
| breakReplication(callback) |
Breaks replication and returns each server to its original stand-alone state. |
{base_path}/{version}/v1/breakReplication?{query} |
Yes |
| configureStreamingReplication(compressReplication, latencyCriticalThreshold, latencyWarningThreshold, properties, standbyServer, callback) |
Enables database replication on a remote system in order to automate the
setup of replication betwe |
{base_path}/{version}/v1/configureStreamingReplication?{query} |
Yes |
| deleteAccessRight(entityId, userId, callback) |
Deletes an access right for a specified object. |
{base_path}/{version}/v1/deleteAccessRight?{query} |
Yes |
| denyMACAddress(configurationId, macAddress, callback) |
Denies MAC addresses. |
{base_path}/{version}/v1/denyMACAddress?{query} |
Yes |
| establishTrustRelationship(password, properties, remoteIP, username, callback) |
Establishes a trust relationship between a maximum of three Address Manager
servers, which is a pre |
{base_path}/{version}/v1/establishTrustRelationship?{query} |
Yes |
| failoverReplication(properties, standbyServer, callback) |
Performs a manual replication failover. |
{base_path}/{version}/v1/failoverReplication?{query} |
Yes |
| getAccessRight(entityId, userId, callback) |
Retrieves an access right for a specified object. |
{base_path}/{version}/v1/getAccessRight?{query} |
Yes |
| getAccessRightsForEntity(count, entityId, start, callback) |
Returns an array of access rights for entities. |
{base_path}/{version}/v1/getAccessRightsForEntity?{query} |
Yes |
| getAccessRightsForUser(count, start, userId, callback) |
Returns an array of access rights for a specified user. |
{base_path}/{version}/v1/getAccessRightsForUser?{query} |
Yes |
| getAllUsedLocations(callback) |
Returns a list of location objects that are used to annotate
other objects. |
{base_path}/{version}/v1/getAllUsedLocations?{query} |
Yes |
| getConfigurationGroups(callback) |
Gets a list of all configuration groups in Address Manager. |
{base_path}/{version}/v1/getConfigurationGroups?{query} |
Yes |
| getConfigurationSetting(configurationId, settingName, callback) |
Returns the configuration setting. |
{base_path}/{version}/v1/getConfigurationSetting?{query} |
Yes |
| getConfigurationsByGroup(groupName, properties, callback) |
Gets a list of configurations in Address Manager based on the name of a
configuration group. |
{base_path}/{version}/v1/getConfigurationsByGroup?{query} |
Yes |
| getLocationByCode(code, callback) |
Returns the location object with the specified hierarchical
location code. |
{base_path}/{version}/v1/getLocationByCode?{query} |
Yes |
| getMACAddress(configurationId, macAddress, callback) |
Returns an APIEntity for a MAC address. |
{base_path}/{version}/v1/getMACAddress?{query} |
Yes |
| getReplicationInfo(properties, callback) |
Retrieves information regarding the status of replication in Address Manager
through the API. |
{base_path}/{version}/v1/getReplicationInfo?{query} |
Yes |
| purgeHistoryNow(numberOfDaysToKeep, numberOfMonthsToKeep, untilWhenTimestamp, waitOption, callback) |
Runs the history purge function. |
{base_path}/{version}/v1/purgeHistoryNow?{query} |
Yes |
| removeTrustRelationship(otherBAMIP, properties, callback) |
Removes a remote Address Manager server from the trust relationship. |
{base_path}/{version}/v1/removeTrustRelationship?{query} |
Yes |
| terminateUserSessions(properties, username, callback) |
Terminates all active user sessions in Address Manager. |
{base_path}/{version}/v1/terminateUserSessions?{query} |
Yes |
| updateAccessRight(entityId, overrides, properties, userId, value, callback) |
Updates access rights for a specified object. |
{base_path}/{version}/v1/updateAccessRight?{query} |
Yes |
| updateConfigurationSetting(configurationId, properties, settingName, callback) |
Updates the configuration setting. |
{base_path}/{version}/v1/updateConfigurationSetting?{query} |
Yes |
| updateUserPassword(newPassword, options, userId, callback) |
Updates an Address Manager user password. |
{base_path}/{version}/v1/updateUserPassword?{query} |
Yes |
| addAdditionalIPAddresses(ipsToAdd, properties, serverId, callback) |
Adds additional IPv4 addresses and loopback addresses to the Services
interface for DNS service. |
{base_path}/{version}/v1/addAdditionalIPAddresses?{query} |
Yes |
| addDeviceInstance(configName, deviceName, ipAddressMode, ipEntity, macAddressMode, macEntity, options, recordName, viewName, zoneName, callback) |
Adds a device instance. |
{base_path}/{version}/v1/addDeviceInstance?{query} |
Yes |
| addIP4BlockByCIDR(cIDR, parentId, properties, callback) |
Adds a new IPv4 Block using CIDR notation. |
{base_path}/{version}/v1/addIP4BlockByCIDR?{query} |
Yes |
| addIP4BlockByRange(end, parentId, properties, start, callback) |
Adds a new IPv4 block defined by an address range. |
{base_path}/{version}/v1/addIP4BlockByRange?{query} |
Yes |
| addIP4IPGroupByRange(end, name, parentId, properties, start, callback) |
Adds an IPv4 IP group by range bounds (start address and end address). |
{base_path}/{version}/v1/addIP4IPGroupByRange?{query} |
Yes |
| addIP4IPGroupBySize(name, parentId, positionRangeBy, positionValue, properties, size, callback) |
Adds an IPv4 IP group by size. |
{base_path}/{version}/v1/addIP4IPGroupBySize?{query} |
Yes |
| addIP4Network(cIDR, blockId, properties, callback) |
Adds an IPv4 network using CIDR notation. |
{base_path}/{version}/v1/addIP4Network?{query} |
Yes |
| addIP4NetworkTemplate(configurationId, name, properties, callback) |
Add an IPv4 network template to the specified configuration. |
{base_path}/{version}/v1/addIP4NetworkTemplate?{query} |
Yes |
| addIP4ReconciliationPolicy(name, parentId, properties, callback) |
Adds an IPv4 reconciliation policy. |
{base_path}/{version}/v1/addIP4ReconciliationPolicy?{query} |
Yes |
| addIP6Address(address, containerId, name, properties, type, callback) |
Adds an IPv6 address to a specified IPv6 network. |
{base_path}/{version}/v1/addIP6Address?{query} |
Yes |
| addIP6BlockByMACAddress(macAddress, name, parentId, properties, callback) |
Adds an IPv6 block by specifying the MAC address of the server. |
{base_path}/{version}/v1/addIP6BlockByMACAddress?{query} |
Yes |
| addIP6BlockByPrefix(name, parentId, prefix, properties, callback) |
Adds an IPv6 block be specifying the prefix for the block. |
{base_path}/{version}/v1/addIP6BlockByPrefix?{query} |
Yes |
| addIP6NetworkByPrefix(name, parentId, prefix, properties, callback) |
Adds an IPv6 network be specifying the prefix for the network. |
{base_path}/{version}/v1/addIP6NetworkByPrefix?{query} |
Yes |
| addParentBlock(body, callback) |
Adds a parent block. |
{base_path}/{version}/v1/addParentBlock?{query} |
Yes |
| addParentBlockWithProperties(properties, body, callback) |
Adds a parent block with properties. |
{base_path}/{version}/v1/addParentBlockWithProperties?{query} |
Yes |
| applyIP4NetworkTemplate(networkId, properties, templateId, callback) |
Applies IPv4 network templates. |
{base_path}/{version}/v1/applyIP4NetworkTemplate?{query} |
Yes |
| assignIP4Address(action, configurationId, hostInfo, ip4Address, macAddress, properties, callback) |
Assigns a MAC address and other properties to an IPv4 address. |
{base_path}/{version}/v1/assignIP4Address?{query} |
Yes |
| assignIP4NetworkTemplate(networkId, properties, templateId, callback) |
Assigns IPv4 network templates. |
{base_path}/{version}/v1/assignIP4NetworkTemplate?{query} |
Yes |
| assignIP6Address(action, address, containerId, hostInfo, macAddress, properties, callback) |
Assigns an IPv6 address to a MAC address and host. |
{base_path}/{version}/v1/assignIP6Address?{query} |
Yes |
| assignNextAvailableIP4Address(action, configurationId, hostInfo, macAddress, parentId, properties, callback) |
Assign the next available IPv4 address. |
{base_path}/{version}/v1/assignNextAvailableIP4Address?{query} |
Yes |
| changeStateIP4Address(addressId, macAddress, targetState, callback) |
Converts the state of an address from and between Reserved, DHCP Reserved,
and Static, or DHCP Allo |
{base_path}/{version}/v1/changeStateIP4Address?{query} |
Yes |
| clearIP6Address(addressId, callback) |
Clears a specified IPv6 address assignment. |
{base_path}/{version}/v1/clearIP6Address?{query} |
Yes |
| deleteDeviceInstance(configName, identifier, options, callback) |
Deletes either the IP address or MAC address (and all related DNS entries
including host records, P |
{base_path}/{version}/v1/deleteDeviceInstance?{query} |
Yes |
| getAdditionalIPAddresses(adonisID, properties, callback) |
Returns IPv4 addresses and loopback addresses added to the Service interface
for DNS services. |
{base_path}/{version}/v1/getAdditionalIPAddresses?{query} |
Yes |
| getAliasesByHint(count, options, start, callback) |
Returns an array of CNAMEs with linked record name. |
{base_path}/{version}/v1/getAliasesByHint?{query} |
Yes |
| getDiscoveredDevice(deviceId, policyId, callback) |
Returns the object ID of the discovered device by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDevice?{query} |
Yes |
| getDiscoveredDeviceArpEntries(deviceId, policyId, callback) |
Returns all ARP entries of a specific device discovered by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDeviceArpEntries?{query} |
Yes |
| getDiscoveredDeviceHosts(deviceId, policyId, callback) |
Returns all hosts of a specific device discovered by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDeviceHosts?{query} |
Yes |
| getDiscoveredDeviceInterfaces(deviceId, policyId, callback) |
Returns all interfaces of a specific device discovered by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDeviceInterfaces?{query} |
Yes |
| getDiscoveredDeviceMacAddressEntries(deviceId, policyId, callback) |
Returns all MAC address entries of a specific device discovered by running an
IPv4 reconciliation p |
{base_path}/{version}/v1/getDiscoveredDeviceMacAddressEntries?{query} |
Yes |
| getDiscoveredDeviceNetworks(deviceId, policyId, callback) |
Returns all networks of a specific device discovered by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDeviceNetworks?{query} |
Yes |
| getDiscoveredDeviceVlans(deviceId, policyId, callback) |
Returns all VLANs of a specific device discovered by running an IPv4
reconciliation policy. |
{base_path}/{version}/v1/getDiscoveredDeviceVlans?{query} |
Yes |
| getDiscoveredDevices(policyId, callback) |
Returns a list of discovered Layer 2 or Layer 3 devices by running an IPv4
reconciliation policy sp |
{base_path}/{version}/v1/getDiscoveredDevices?{query} |
Yes |
| getIP4Address(address, containerId, callback) |
Returns the details for the requested IPv4 address object. |
{base_path}/{version}/v1/getIP4Address?{query} |
Yes |
| getIP4NetworksByHint(containerId, count, options, start, callback) |
Returns an array of IPv4 networks found under a given container object. |
{base_path}/{version}/v1/getIP4NetworksByHint?{query} |
Yes |
| getIP6Address(address, containerId, callback) |
Returns an APIEntity for the specified IPv6 address. |
{base_path}/{version}/v1/getIP6Address?{query} |
Yes |
| getIP6ObjectsByHint(containerId, count, objectType, options, start, callback) |
Returns an array of IPv6 objects found under a given container object. |
{base_path}/{version}/v1/getIP6ObjectsByHint?{query} |
Yes |
| getIPRangedByIP(address, containerId, type, callback) |
Returns the DHCP range containing the specified IPv4 or IPv6 address. |
{base_path}/{version}/v1/getIPRangedByIP?{query} |
Yes |
| getLinkedNetworkConflicts(networkId, templateId, callback) |
Get a list of deployment options that conflict with the associated networks
or network that are lin |
{base_path}/{version}/v1/getLinkedNetworkConflicts?{query} |
Yes |
| getMaxAllowedRange(rangeId, callback) |
Finds the maximum possible address range to which the existing IPv4 DHCP
range can be extended. |
{base_path}/{version}/v1/getMaxAllowedRange?{query} |
Yes |
| getNextAvailableIP4Address(parentId, callback) |
Returns the IPv4 address for the next available (unallocated) address within
a configuration, block |
{base_path}/{version}/v1/getNextAvailableIP4Address?{query} |
Yes |
| getNextAvailableIP4Network(autoCreate, isLargerAllowed, parentId, size, callback) |
Returns the object ID for the next available (unused) network within a
configuration or block. |
{base_path}/{version}/v1/getNextAvailableIP4Network?{query} |
Yes |
| getNextAvailableIP6Address(parentId, properties, callback) |
Returns the next available IPv6 address within an IPv6 block or network. |
{base_path}/{version}/v1/getNextAvailableIP6Address?{query} |
Yes |
| getNextAvailableIPRange(parentId, properties, size, type, callback) |
Returns the object ID for the next available (unused) block or network within
a configuration or bl |
{base_path}/{version}/v1/getNextAvailableIPRange?{query} |
Yes |
| getNextAvailableIPRanges(count, parentId, properties, size, type, callback) |
Returns the object IDs for the next available (unused) blocks or networks
within a configuration or |
{base_path}/{version}/v1/getNextAvailableIPRanges?{query} |
Yes |
| getNextIP4Address(parentId, properties, callback) |
Returns the next available IP addresses in octet notation under specified
circumstances. |
{base_path}/{version}/v1/getNextIP4Address?{query} |
Yes |
| getTemplateTaskStatus(taskId, callback) |
Gets the IPv4 template task status when the template is applied. |
{base_path}/{version}/v1/getTemplateTaskStatus?{query} |
Yes |
| isAddressAllocated(configurationId, ipAddress, macAddress, callback) |
Queries a MAC address to determine if the address has been allocated to an IP
address. |
{base_path}/{version}/v1/isAddressAllocated?{query} |
Yes |
| mergeBlocksWithParent(body, callback) |
Merges specified IPv4 blocks into a single block. |
{base_path}/{version}/v1/mergeBlocksWithParent?{query} |
Yes |
| mergeSelectedBlocksOrNetworks(blockOrNetworkToKeep, body, callback) |
Merges specified IPv4 blocks or IPv4 networks into a single IPv4 block or
IPv4 network. |
{base_path}/{version}/v1/mergeSelectedBlocksOrNetworks?{query} |
Yes |
| moveIPObject(address, objectId, options, callback) |
Moves an IPv4 block, IPv4 network, IPv4 address, IPv6 block, or IPv6 network
to a new IPv4 or IPv6 |
{base_path}/{version}/v1/moveIPObject?{query} |
Yes |
| reapplyTemplate(properties, templateId, callback) |
Reapplies DNS zone templates. |
{base_path}/{version}/v1/reapplyTemplate?{query} |
Yes |
| reassignIP6Address(destination, oldAddressId, properties, callback) |
Reassigns an existing IPv6 address to a new IPv6 address. |
{base_path}/{version}/v1/reassignIP6Address?{query} |
Yes |
| removeAdditionalIPAddresses(ipsToRemove, properties, serverId, callback) |
Removes additional IPv4 addresses and loopback addresses from the Services
interface. |
{base_path}/{version}/v1/removeAdditionalIPAddresses?{query} |
Yes |
| resizeRange(objectId, options, range, callback) |
Changes the size of an IPv4 block, IPv4 network, DHCPv4 range, IPv6 block, or
IPv6 network. |
{base_path}/{version}/v1/resizeRange?{query} |
Yes |
| splitIP4Network(networkId, numberOfParts, options, callback) |
Splits an IPv4 network into the specified number of networks. |
{base_path}/{version}/v1/splitIP4Network?{query} |
Yes |
| splitIP6Range(numberOfParts, options, rangeId, callback) |
Splits an IPv6 block or network into the specified number of blocks or
networks. |
{base_path}/{version}/v1/splitIP6Range?{query} |
Yes |
| unassignIP4NetworkTemplate(networkId, properties, templateId, callback) |
Unassigns IPv4 network templates. |
{base_path}/{version}/v1/unassignIP4NetworkTemplate?{query} |
Yes |
| addCustomOptionDefinition(allowMultiple, configurationId, name, optionId, optionType, properties, callback) |
Adds a custom deployment option. |
{base_path}/{version}/v1/addCustomOptionDefinition?{query} |
Yes |
| addDHCP4Range(end, networkId, properties, start, callback) |
Adds IPv4 DHCP ranges. |
{base_path}/{version}/v1/addDHCP4Range?{query} |
Yes |
| addDHCP4RangeBySize(networkId, offset, properties, size, callback) |
Adds IPv4 DHCP ranges by offset and percentage. |
{base_path}/{version}/v1/addDHCP4RangeBySize?{query} |
Yes |
| addDHCP6ClientDeploymentOption(entityId, name, properties, value, callback) |
Adds DHCPv6 client options and returns the database object ID for the new
option object. |
{base_path}/{version}/v1/addDHCP6ClientDeploymentOption?{query} |
Yes |
| addDHCP6Range(end, networkId, properties, start, callback) |
Adds IPv6 DHCP ranges. |
{base_path}/{version}/v1/addDHCP6Range?{query} |
Yes |
| addDHCP6RangeBySize(networkId, properties, size, start, callback) |
Adds IPv6 DHCP ranges by size. |
{base_path}/{version}/v1/addDHCP6RangeBySize?{query} |
Yes |
| addDHCP6ServiceDeploymentOption(entityId, name, properties, value, callback) |
Adds DHCPv6 service options. |
{base_path}/{version}/v1/addDHCP6ServiceDeploymentOption?{query} |
Yes |
| addDHCPClientDeploymentOption(entityId, name, properties, value, callback) |
Adds a DHCP client option and returns the object ID for the new option object. |
{base_path}/{version}/v1/addDHCPClientDeploymentOption?{query} |
Yes |
| addDHCPMatchClass(configurationId, matchCriteria, name, properties, callback) |
Adds DHCP match classes to Address Manager. |
{base_path}/{version}/v1/addDHCPMatchClass?{query} |
Yes |
| addDHCPServiceDeploymentOption(entityId, name, properties, value, callback) |
Adds DHCP service options. |
{base_path}/{version}/v1/addDHCPServiceDeploymentOption?{query} |
Yes |
| addDHCPSubClass(matchClassId, matchValue, properties, callback) |
Adds DHCP match class values. |
{base_path}/{version}/v1/addDHCPSubClass?{query} |
Yes |
| addDHCPVendorDeploymentOption(optionId, parentId, properties, value, callback) |
Adds a DHCP vendor deployment option to specified objects. |
{base_path}/{version}/v1/addDHCPVendorDeploymentOption?{query} |
Yes |
| addVendorOptionDefinition(allowMultiple, description, name, optionId, optionType, properties, vendorProfileId, callback) |
Adds a vendor option definition to a vendor profile. |
{base_path}/{version}/v1/addVendorOptionDefinition?{query} |
Yes |
| addVendorProfile(description, identifier, name, properties, callback) |
Adds a vendor profile and returns the object ID for the new vendor profile. |
{base_path}/{version}/v1/addVendorProfile?{query} |
Yes |
| deleteDHCP6ClientDeploymentOption(entityId, name, serverId, callback) |
Deletes DHCPv6 client options. |
{base_path}/{version}/v1/deleteDHCP6ClientDeploymentOption?{query} |
Yes |
| deleteDHCP6ServiceDeploymentOption(entityId, name, serverId, callback) |
Deletes DHCPv6 service options. |
{base_path}/{version}/v1/deleteDHCP6ServiceDeploymentOption?{query} |
Yes |
| deleteDHCPClientDeploymentOption(entityId, name, serverId, callback) |
Deletes DHCP client options. |
{base_path}/{version}/v1/deleteDHCPClientDeploymentOption?{query} |
Yes |
| deleteDHCPServiceDeploymentOption(entityId, name, serverId, callback) |
Deletes DHCP service options. |
{base_path}/{version}/v1/deleteDHCPServiceDeploymentOption?{query} |
Yes |
| deleteDHCPVendorDeploymentOption(entityId, optionId, serverId, callback) |
Deletes a specified DHCP vendor deployment option. |
{base_path}/{version}/v1/deleteDHCPVendorDeploymentOption?{query} |
Yes |
| getDHCP6ClientDeploymentOption(entityId, name, serverId, callback) |
Returns DHCPv6 client options assigned for the object specified excluding the
options inherited fro |
{base_path}/{version}/v1/getDHCP6ClientDeploymentOption?{query} |
Yes |
| getDHCP6ServiceDeploymentOption(entityId, name, serverId, callback) |
Returns DHCPv6 service options assigned for the object specified excluding
the options inherited fr |
{base_path}/{version}/v1/getDHCP6ServiceDeploymentOption?{query} |
Yes |
| getDHCPClientDeploymentOption(entityId, name, serverId, callback) |
Returns DHCPv4 client options assigned for the object specified excluding the
options inherited fro |
{base_path}/{version}/v1/getDHCPClientDeploymentOption?{query} |
Yes |
| getDHCPServiceDeploymentOption(entityId, name, serverId, callback) |
Returns DHCP service options assigned for the object specified excluding the
options inherited from |
{base_path}/{version}/v1/getDHCPServiceDeploymentOption?{query} |
Yes |
| getDHCPVendorDeploymentOption(entityId, optionId, serverId, callback) |
Retrieves a DHCP vendor deployment option assigned for the object specified
excluding the options i |
{base_path}/{version}/v1/getDHCPVendorDeploymentOption?{query} |
Yes |
| getSharedNetworks(tagId, callback) |
Returns multiple IPv4 networks linked to the given shared network tag. |
{base_path}/{version}/v1/getSharedNetworks?{query} |
Yes |
| shareNetwork(networkId, tagId, callback) |
Links an IPv4 network with a shared network tag. |
{base_path}/{version}/v1/shareNetwork?{query} |
Yes |
| unshareNetwork(networkId, callback) |
Unlinks the shared network tag from an IPv4 network. |
{base_path}/{version}/v1/unshareNetwork?{query} |
Yes |
| updateDHCP6ClientDeploymentOption(body, callback) |
Updates DHCPv6 client options. |
{base_path}/{version}/v1/updateDHCP6ClientDeploymentOption?{query} |
Yes |
| updateDHCP6ServiceDeploymentOption(body, callback) |
Updates DHCPv6 service options. |
{base_path}/{version}/v1/updateDHCP6ServiceDeploymentOption?{query} |
Yes |
| updateDHCPClientDeploymentOption(body, callback) |
Updates DHCP client options. |
{base_path}/{version}/v1/updateDHCPClientDeploymentOption?{query} |
Yes |
| updateDHCPServiceDeploymentOption(body, callback) |
Updates DHCP service options. |
{base_path}/{version}/v1/updateDHCPServiceDeploymentOption?{query} |
Yes |
| updateDHCPVendorDeploymentOption(body, callback) |
Updates the specified DHCP vendor deployment option. |
{base_path}/{version}/v1/updateDHCPVendorDeploymentOption?{query} |
Yes |
| addDHCPDeploymentRole(entityId, properties, serverInterfaceId, type, callback) |
Adds a DHCP deployment role to a specified object. |
{base_path}/{version}/v1/addDHCPDeploymentRole?{query} |
Yes |
| addDNSDeploymentRole(entityId, properties, serverInterfaceId, type, callback) |
Adds a DNS deployment role to a specified object. |
{base_path}/{version}/v1/addDNSDeploymentRole?{query} |
Yes |
| addServer(configurationId, defaultInterfaceAddress, fullHostName, name, profile, properties, callback) |
Adds servers to Address Manager. |
{base_path}/{version}/v1/addServer?{query} |
Yes |
| addTFTPDeploymentRole(entityId, properties, serverId, callback) |
Adds a TFTP deployment role to a specified object. |
{base_path}/{version}/v1/addTFTPDeploymentRole?{query} |
Yes |
| deleteDHCPDeploymentRole(entityId, serverInterfaceId, callback) |
Deletes DHCP deployment roles. |
{base_path}/{version}/v1/deleteDHCPDeploymentRole?{query} |
Yes |
| deleteDNSDeploymentRole(entityId, serverInterfaceId, callback) |
Deletes a specified DNS deployment role. |
{base_path}/{version}/v1/deleteDNSDeploymentRole?{query} |
Yes |
| deleteDNSDeploymentRoleForView(entityId, serverInterfaceId, viewId, callback) |
Deletes the DNS deployment role assigned to view-level objects in the IP
space for ARPA zones. |
{base_path}/{version}/v1/deleteDNSDeploymentRoleForView?{query} |
Yes |
| deployServer(serverId, callback) |
Deploys servers. |
{base_path}/{version}/v1/deployServer?{query} |
Yes |
| deployServerConfig(properties, serverId, callback) |
Deploys specific configuration(s) to a particular server. |
{base_path}/{version}/v1/deployServerConfig?{query} |
Yes |
| deployServerServices(serverId, services, callback) |
Deploys specific service(s) to a particular server. |
{base_path}/{version}/v1/deployServerServices?{query} |
Yes |
| getDHCPDeploymentRole(entityId, serverInterfaceId, callback) |
Retrieves the DHCP deployment role assigned to a specified object. |
{base_path}/{version}/v1/getDHCPDeploymentRole?{query} |
Yes |
| getDNSDeploymentRole(entityId, serverInterfaceId, callback) |
Retrieves a DNS deployment role from a specified object. |
{base_path}/{version}/v1/getDNSDeploymentRole?{query} |
Yes |
| getDNSDeploymentRoleForView(entityId, serverInterfaceId, viewId, callback) |
Retrieves the DNS deployment role assigned to a view-level objects in the IP
space for ARPA zones. |
{base_path}/{version}/v1/getDNSDeploymentRoleForView?{query} |
Yes |
| getDeploymentRoles(entityId, callback) |
Returns the DNS and DHCP deployment roles associated with the specified
object. |
{base_path}/{version}/v1/getDeploymentRoles?{query} |
Yes |
| getDeploymentTaskStatus(deploymentTaskToken, callback) |
Returns the deployment status of the deployment task that was created using
the. |
{base_path}/{version}/v1/getDeploymentTaskStatus?{query} |
Yes |
| getServerDeploymentRoles(serverId, callback) |
Returns a list of all deployment roles associated with the server. |
{base_path}/{version}/v1/getServerDeploymentRoles?{query} |
Yes |
| getServerDeploymentStatus(properties, serverId, callback) |
Returns the deployment status of the server. |
{base_path}/{version}/v1/getServerDeploymentStatus?{query} |
Yes |
| getServerForRole(roleId, callback) |
Returns a list of all servers associated with the specified deployment role. |
{base_path}/{version}/v1/getServerForRole?{query} |
Yes |
| moveDeploymentRoles(moveDhcpRoles, moveDnsRoles, options, sourceServerId, targetServerInterfaceId, callback) |
Moves all DNS and DHCP deployment roles from a server to the specified
interface of another server. |
{base_path}/{version}/v1/moveDeploymentRoles?{query} |
Yes |
| quickDeploy(entityId, properties, callback) |
Instantly deploys changes you made to DNS resource records
since the last full or quick deployment. |
{base_path}/{version}/v1/quickDeploy?{query} |
Yes |
| replaceServer(defaultInterface, hostName, name, password, properties, serverId, upgrade, callback) |
Replaces a server. |
{base_path}/{version}/v1/replaceServer?{query} |
Yes |
| selectiveDeploy(properties, body, callback) |
Selectively deploys—creates a differential deployment task to deploy changes made to specific DNS
e |
{base_path}/{version}/v1/selectiveDeploy?{query} |
Yes |
| updateDHCPDeploymentRole(body, callback) |
Updates a DHCP deployment role. |
{base_path}/{version}/v1/updateDHCPDeploymentRole?{query} |
Yes |
| updateDNSDeploymentRole(body, callback) |
Updates a specified DNS deployment role. |
{base_path}/{version}/v1/updateDNSDeploymentRole?{query} |
Yes |
| addEntity(parentId, body, callback) |
A generic method for adding configurations, DNS zones, and DNS resource
records. |
{base_path}/{version}/v1/addEntity?{query} |
Yes |
| assignOrUpdateTemplate(entityId, properties, templateId, callback) |
Assigns, updates, or removes DNS zone and IPv4 network templates. |
{base_path}/{version}/v1/assignOrUpdateTemplate?{query} |
Yes |
| customSearch(count, filters, options, start, type, callback) |
Search for an array of entities by specifying object properties. |
{base_path}/{version}/v1/customSearch?{query} |
Yes |
| delete(objectId, callback) |
Deletes an object using the generic. |
{base_path}/{version}/v1/delete?{query} |
Yes |
| deleteWithOptions(objectId, options, callback) |
Deletes objects that have options associated with their removal. |
{base_path}/{version}/v1/deleteWithOptions?{query} |
Yes |
| getEntities(count, parentId, start, type, callback) |
Returns multiple entities for the specified parent ID. |
{base_path}/{version}/v1/getEntities?{query} |
Yes |
| getEntitiesByName(count, name, parentId, start, type, callback) |
Returns an array of entities that match the specified parent, name, and
object type. |
{base_path}/{version}/v1/getEntitiesByName?{query} |
Yes |
| getEntitiesByNameUsingOptions(count, name, options, parentId, start, type, callback) |
Returns an array of entities that match the specified name and object type. |
{base_path}/{version}/v1/getEntitiesByNameUsingOptions?{query} |
Yes |
| getEntityByCIDR(cidr, parentId, type, callback) |
Returns an IPv4 Network object from the database by calling it using CIDR
notation. |
{base_path}/{version}/v1/getEntityByCIDR?{query} |
Yes |
| getEntityById(id, callback) |
Returns objects from the database referenced by their database ID and with
its properties fields po |
{base_path}/{version}/v1/getEntityById?{query} |
Yes |
| getEntityByName(name, parentId, type, callback) |
Returns objects from the database referenced by their name field. |
{base_path}/{version}/v1/getEntityByName?{query} |
Yes |
| getEntityByPrefix(containerId, prefix, type, callback) |
Returns an APIEntity for the specified IP block or network. |
{base_path}/{version}/v1/getEntityByPrefix?{query} |
Yes |
| getEntityByRange(address1, address2, parentId, type, callback) |
Returns an IPv4 DHCP range object by calling it using its range. |
{base_path}/{version}/v1/getEntityByRange?{query} |
Yes |
| getLinkedEntities(count, entityId, start, type, callback) |
Returns an array of entities containing the entities linked to a specified
entity. |
{base_path}/{version}/v1/getLinkedEntities?{query} |
Yes |
| getParent(entityId, callback) |
Returns the parent entity of a given entity. |
{base_path}/{version}/v1/getParent?{query} |
Yes |
| getSystemInfo(callback) |
Gets Address Manager system information. |
{base_path}/{version}/v1/getSystemInfo?{query} |
Yes |
| linkEntities(entity1Id, entity2Id, properties, callback) |
Establishes a link between two specified Address Manager entities. |
{base_path}/{version}/v1/linkEntities?{query} |
Yes |
| login(password, username, callback) |
Logs in as API user. |
{base_path}/{version}/v1/login?{query} |
Yes |
| loginWithOptions(options, password, username, callback) |
Logs in as an API user with the option to change the locale to Japanese or Simplified Chinese. |
{base_path}/{version}/v1/loginWithOptions?{query} |
Yes |
| logout(callback) |
Logs out of the current API session. |
{base_path}/{version}/v1/logout?{query} |
Yes |
| searchByCategory(category, count, keyword, start, callback) |
Returns an array of entities by searching for keywords associated with
objects of a specified objec |
{base_path}/{version}/v1/searchByCategory?{query} |
Yes |
| searchByObjectTypes(count, keyword, start, types, callback) |
Returns an array of entities by searching for keywords associated with
objects of a specified objec |
{base_path}/{version}/v1/searchByObjectTypes?{query} |
Yes |
| unlinkEntities(entity1Id, entity2Id, properties, callback) |
Removes the link between two specified Address Manager entities. |
{base_path}/{version}/v1/unlinkEntities?{query} |
Yes |
| update(body, callback) |
Updates entity objects. |
{base_path}/{version}/v1/update?{query} |
Yes |
| updateWithOptions(options, body, callback) |
Updates objects requiring a certain behavior that is not covered by the
regular. |
{base_path}/{version}/v1/updateWithOptions?{query} |
Yes |
| addRawDeploymentOption(parentId, body, callback) |
Adds raw deployment options. |
{base_path}/{version}/v1/addRawDeploymentOption?{query} |
Yes |
| getDeploymentOptions(entityId, optionTypes, serverId, callback) |
Retrieves deployment options for Address Manager DNS and DHCP services. |
{base_path}/{version}/v1/getDeploymentOptions?{query} |
Yes |
| updateRawDeploymentOption(body, callback) |
Updates raw deployment options. |
{base_path}/{version}/v1/updateRawDeploymentOption?{query} |
Yes |
| addTFTPFile(inputStream, name, parentId, properties, version, body, callback) |
Adds TFTP files. |
{base_path}/{version}/v1/addTFTPFile?{query} |
Yes |
| addTFTPFolder(name, parentId, properties, callback) |
Adds TFTP folders. |
{base_path}/{version}/v1/addTFTPFolder?{query} |
Yes |
| addTFTPGroup(configurationId, name, properties, callback) |
Adds TFTP groups. |
{base_path}/{version}/v1/addTFTPGroup?{query} |
Yes |
| addUserDefinedField(type, body, callback) |
Adds user-defined fields. |
{base_path}/{version}/v1/addUserDefinedField?{query} |
Yes |
| deleteUserDefinedField(name, type, callback) |
Deletes user-defined fields. |
{base_path}/{version}/v1/deleteUserDefinedField?{query} |
Yes |
| getUserDefinedFields(requiredFieldsOnly, type, callback) |
Returns the user-defined fields information. |
{base_path}/{version}/v1/getUserDefinedFields?{query} |
Yes |
| updateBulkUdf(inputStream, properties, body, callback) |
Updates values of various user-defined fields (UDFs) for different objects. |
{base_path}/{version}/v1/updateBulkUdf?{query} |
Yes |
| updateUserDefinedField(type, body, callback) |
Updates user-defined fields. |
{base_path}/{version}/v1/updateUserDefinedField?{query} |
Yes |
| breakXHAPair(breakInProteusOnly, xHAServerId, callback) |
Breaks an xHA pair and returns each server to its original stand-alone state. |
{base_path}/{version}/v1/breakXHAPair?{query} |
Yes |
| createXHAPair(activeServerId, activeServerNewIPv4Address, configurationId, passiveServerId, properties, callback) |
Creates an xHA pair. |
{base_path}/{version}/v1/createXHAPair?{query} |
Yes |
| editXHAPair(name, properties, xHAServerId, callback) |
Updates the xHA pair created. |
{base_path}/{version}/v1/editXHAPair?{query} |
Yes |
| failoverXHA(xHAServerId, callback) |
Performs a manual xHA failover. |
{base_path}/{version}/v1/failoverXHA?{query} |
Yes |
| cleanBrokenTrustRelationship(ipsToRemove, callback) |
This is an internal API used by Address Manager services. |
{base_path}/{version}/v1/cleanBrokenTrustRelationship?{query} |
Yes |
| configureReplication(compressReplication, properties, replicationBreakThreshold, replicationQueueThreshold, standbyServer, callback) |
This API has been deprecated and is no longer supported. |
{base_path}/{version}/v1/configureReplication?{query} |
Yes |
| exchangeKeyBundles(body, callback) |
This is an internal API used by Address Manager services. |
{base_path}/{version}/v1/exchangeKeyBundles?{query} |
Yes |
| moveIP4Object(address, objectId, callback) |
This API has been deprecated and is no longer supported. |
{base_path}/{version}/v1/moveIP4Object?{query} |
Yes |
| getProbeData(definedProbe, properties, callback) |
Returns the JSON response from the properties field of the APIData object. |
{base_path}/{version}/v1/getProbeData?{query} |
Yes |
| getProbeStatus(definedProbe, callback) |
Returns the status of the triggered data collection process. |
{base_path}/{version}/v1/getProbeStatus?{query} |
Yes |
| startProbe(definedProbe, properties, callback) |
Starts collecting data from the Address Manager database using pre-defined SQL
queries. |
{base_path}/{version}/v1/startProbe?{query} |
Yes |
| isMigrationRunning(filename, callback) |
Returns true or false to indicate if the migration service is running. |
{base_path}/{version}/v1/isMigrationRunning?{query} |
Yes |
| migrateFile(filename, callback) |
Migrates the specified XML file into Address Manager. |
{base_path}/{version}/v1/migrateFile?{query} |
Yes |