openapi: 3.0.0 info: title: BAM REST API contact: {} version: '9.2.0-919.GA.bcn@release-9.2#caa46e7d0c5f70ca0abedd2af01bf51ea596cb16 built 2020-04-15 22:42:24Z' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com paths: /v1/addAccessRight: post: tags: - bam_object_methods summary: addAccessRight description: Adds access rights to a specified object. operationId: addAccessRight parameters: - name: entityId in: query description: >- The object ID of the entity to which the access right is being added. Set to zero (0) if you are adding the access right to the root level default access rights. style: form explode: true schema: type: integer format: int64 - name: overrides in: query description: >- A list of type-specific overrides in the following format: "objectType=accessValue|objectType=accessValue" style: form explode: true schema: type: string - name: properties in: query description: >- A string including the following options: style: form explode: true schema: type: string - name: userId in: query description: The object ID of the user to whom this access right applies. style: form explode: true schema: type: integer format: int64 - name: value in: query description: >- The value of the access right being added. Valid values for this parameter are listed in the table. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new access right. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDevice: post: tags: - bam_object_methods summary: addDevice description: Adds a device to a configuration. operationId: addDevice parameters: - name: configurationId in: query description: The object ID of the configuration in which the device is to be located. style: form explode: true schema: type: integer format: int64 - name: deviceSubtypeId in: query description: >- The object ID of the device sub-type with which the device is associated. The value can be 0 if you do not wish to associate a device sub-type to the device you are adding. style: form explode: true schema: type: integer format: int64 - name: deviceTypeId in: query description: >- The object ID of the device type with which the device is associated. The value can be 0 if you do not wish to associate a device type to the device you are adding. style: form explode: true schema: type: integer format: int64 - name: ip4Addresses in: query description: >- One or more IPv4 addresses to which the device is assigned. Specify multiple addresses in a comma-delimited list. style: form explode: true schema: type: string - name: ip6Addresses in: query description: >- One or more IPv6 addresses to which the device is assigned. Specify multiple addresses in a comma-delimited list. style: form explode: true schema: type: string - name: name in: query description: The descriptive name of the device. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new device. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDeviceSubtype: post: tags: - bam_object_methods summary: addDeviceSubtype description: >- Adds a device sub-type to Address Manager. Use device types and device sub-types to categorize and organize devices on the network. operationId: addDeviceSubtype parameters: - name: name in: query description: The descriptive name for the device sub-type. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the parent device type object. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new device sub-type. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDeviceType: post: tags: - bam_object_methods summary: addDeviceType description: >- Adds a device type to Address Manager. Use device types and device sub-types to categorize and organize devices on the network. operationId: addDeviceType parameters: - name: name in: query description: The descriptive name for the device type. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new device type. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addMACAddress: post: tags: - bam_object_methods summary: addMACAddress description: Adds MAC addresses. operationId: addMACAddress parameters: - name: configurationId in: query description: The object ID of the parent configuration in which the MAC address resides. style: form explode: true schema: type: integer format: int64 - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: properties in: query description: >- Adds object properties, including the name, MAC Pool ID macPool, and user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new MAC address. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addTag: post: tags: - bam_object_methods summary: addTag description: Adds object tags. operationId: addTag parameters: - name: name in: query description: The name of the object tag. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent for this object tag. The parent is either an object tag or an object tag group. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new object tag. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addTagGroup: post: tags: - bam_object_methods summary: addTagGroup description: Adds object tag groups. operationId: addTagGroup parameters: - name: name in: query description: The name of the tag group. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new tag group. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addUser: post: tags: - bam_object_methods summary: addUser description: Adds Address Manager users. operationId: addUser parameters: - name: password in: query description: >- The Address Manager password for the user. The password must be set even if the authenticator property option is defined. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing user-defined fields and options listed in List of options. You can separate multiple property values with pipe character (|), for example, my $properties = “email=$email phoneNumber=$tel authenticator=1368969 userAccessType=$accessType” You must add a pipe character at the end of the properties string. style: form explode: true schema: type: string - name: username in: query description: The name of the user. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new Address Manager user. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addUserGroup: post: tags: - bam_object_methods summary: addUserGroup description: Adds user groups. operationId: addUserGroup parameters: - name: name in: query description: The name of the user group. style: form explode: true schema: type: string - name: properties in: query description: >- A string including the following option:

style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new Address Manager user group. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/associateMACAddressWithPool: post: tags: - bam_object_methods summary: associateMACAddressWithPool description: Associates a MAC address with a MAC pool. operationId: associateMACAddressWithPool parameters: - name: configurationId in: query description: >- The object ID of the parent configuration in which the MAC address resides. style: form explode: true schema: type: integer format: int64 - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: poolId in: query description: The object ID of the MAC pool with which this MAC address is associated. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/breakReplication: post: tags: - bam_object_methods summary: breakReplication description: Breaks replication and returns each server to its original stand-alone state. operationId: breakReplication parameters: [] responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/configureStreamingReplication: post: tags: - bam_object_methods summary: configureStreamingReplication description: >- Enables database replication on a remote system in order to automate the setup of replication between two or three Address Manager systems. This API method must be run against the Address Manager system that will be primary. operationId: configureStreamingReplication parameters: - name: compressReplication in: query description: >- The boolean value. Set to true to compress the database replication files. Compressing database replication files is a resource-intensive process that might affect system performance. Use caution when performing this action. By default, the compressReplication parameter is disabled. style: form explode: true schema: type: boolean - name: latencyCriticalThreshold in: query description: >- A value to specify the threshold size of the replication break in seconds (sec). Valid values for this parameter range from 0 to any positive value. By default, the latencyCriticalThreshold parameter is set to 86400 seconds. style: form explode: true schema: type: integer format: int64 - name: latencyWarningThreshold in: query description: >- A value to specify the threshold size of the replication directory in seconds (sec). Valid values for this parameter range from 0 to any positive value. By default, the latencyWarningThreshold parameter is set to 3600 seconds. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string including the following option: style: form explode: true schema: type: string - name: standbyServer in: query description: >- The IP address of the standby server. style: form explode: true schema: type: string responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteAccessRight: delete: tags: - bam_object_methods summary: deleteAccessRight description: Deletes an access right for a specified object. operationId: deleteAccessRight parameters: - name: entityId in: query description: The object ID of the entity to which the access right is assigned. style: form explode: true schema: type: integer format: int64 - name: userId in: query description: The object ID of the user to whom this access right is applied. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/denyMACAddress: put: tags: - bam_object_methods summary: denyMACAddress description: Denies MAC addresses. operationId: denyMACAddress parameters: - name: configurationId in: query description: >- The object ID of the parent configuration in which the MAC address resides. style: form explode: true schema: type: integer format: int64 - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/establishTrustRelationship: post: tags: - bam_object_methods summary: establishTrustRelationship description: >- Establishes a trust relationship between a maximum of three Address Manager servers, which is a prerequisite for configuring replication in Address Manager. operationId: establishTrustRelationship parameters: - name: password in: query description: The password for the API user logging into Address Manager. style: form explode: true schema: type: string - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string - name: remoteIP in: query description: >- The IP address of the standby server. The standby server must be accessible from the primary server and must have database access from the primary server. To enable database access, refer to the Configuring database replication section in the Address Manager Administration Guide. style: form explode: true schema: type: string - name: username in: query description: >- The username for the API user created using the Address Manager interface. style: form explode: true schema: type: string responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/failoverReplication: post: tags: - bam_object_methods summary: failoverReplication description: Performs a manual replication failover. operationId: failoverReplication parameters: - name: properties in: query description: >- A string that includes the following option: style: form explode: true schema: type: string - name: standbyServer in: query description: >- The IP address of the standby server, which will become the primary BAM server once a failover has been performed. style: form explode: true schema: type: string responses: '201': description: Performs a manual replication failover. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/getAccessRight: get: tags: - bam_object_methods summary: getAccessRight description: Retrieves an access right for a specified object. operationId: getAccessRight parameters: - name: entityId in: query description: The object ID of the entity to which the access right is assigned. style: form explode: true schema: type: integer format: int64 - name: userId in: query description: The object ID of the user to whom the access right is applied. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the access right for the specified object. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIAccessRight' - description: This class controls Access Right objects. deprecated: false /v1/getAccessRightsForEntity: get: tags: - bam_object_methods summary: getAccessRightsForEntity description: Returns an array of access rights for entities. operationId: getAccessRightsForEntity parameters: - name: count in: query description: The maximum number of access right child objects to return. style: form explode: true schema: type: integer format: int32 - name: entityId in: query description: The object ID of the entity whose access rights are returned. style: form explode: true schema: type: integer format: int64 - name: start in: query description: >- Indicates where in the list of child access right objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of access right objects. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIAccessRight' description: '' deprecated: false /v1/getAccessRightsForUser: get: tags: - bam_object_methods summary: getAccessRightsForUser description: Returns an array of access rights for a specified user. operationId: getAccessRightsForUser parameters: - name: count in: query description: The maximum number of access right child objects to return. style: form explode: true schema: type: integer format: int32 - name: start in: query description: >- Indicates where in the list of child access right objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: userId in: query description: The object ID of the user whose access rights are returned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an array of access right objects. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIAccessRight' description: '' deprecated: false /v1/getAllUsedLocations: get: tags: - bam_object_methods summary: getAllUsedLocations description: >- Returns a list of location objects that are used to annotate other objects. operationId: getAllUsedLocations parameters: [] responses: '200': description: Returns an array of location APIEntity objects. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getConfigurationGroups: get: tags: - bam_object_methods summary: getConfigurationGroups description: Gets a list of all configuration groups in Address Manager. operationId: getConfigurationGroups parameters: [] responses: '200': description: Returns a list of configuration groups. headers: {} content: application/json: schema: type: array items: type: string description: '' deprecated: false /v1/getConfigurationSetting: get: tags: - bam_object_methods summary: getConfigurationSetting description: Returns the configuration setting. operationId: getConfigurationSetting parameters: - name: configurationId in: query description: The object ID of the configuration in which the setting is to be located. style: form explode: true schema: type: integer format: int64 - name: settingName in: query description: >- The name of the specific setting to be read. Only the option inheritance OPTION_INHERITANCE setting is supported. style: form explode: true schema: type: string responses: '200': description: Returns the properties of the setting of the configuration. headers: {} content: application/json: schema: type: string deprecated: false /v1/getConfigurationsByGroup: get: tags: - bam_object_methods summary: getConfigurationsByGroup description: >- Gets a list of configurations in Address Manager based on the name of a configuration group. operationId: getConfigurationsByGroup parameters: - name: groupName in: query description: >- The name of the configuration group in which the configurations are to be located. Configuration group names are case sensitive. style: form explode: true schema: type: string - name: properties in: query description: This is reserved for future use. style: form explode: true schema: type: string responses: '200': description: Returns a list of configurations based on the specified group. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getLocationByCode: get: tags: - bam_object_methods summary: getLocationByCode description: >- Returns the location object with the specified hierarchical location code. operationId: getLocationByCode parameters: - name: code in: query description: >- The hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: The code is case-sensitive. It must be all UPPER CASE letters.

The county code and child location code should be alphanumeric strings.

style: form explode: true schema: type: string responses: '200': description: Returns the entity that matches the specified hierarchical location code. If no entity is found, returns an empty APIEntity. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getMACAddress: get: tags: - bam_object_methods summary: getMACAddress description: Returns an APIEntity for a MAC address. operationId: getMACAddress parameters: - name: configurationId in: query description: The object ID of the configuration in which the MAC address is located. style: form explode: true schema: type: integer format: int64 - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string responses: '200': description: Returns an APIEntity for the MAC address. Returns an empty APIEntity if the MAC address does not exist. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getReplicationInfo: get: tags: - bam_object_methods summary: getReplicationInfo description: >- Retrieves information regarding the status of replication in Address Manager through the API. operationId: getReplicationInfo parameters: - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string responses: '200': description: Returns a JSON string containing the hostname, status of replication, latency, the IP address of the Primary and standby servers, and cluster information. headers: {} content: application/json: schema: type: string deprecated: false /v1/purgeHistoryNow: put: tags: - bam_object_methods summary: purgeHistoryNow description: Runs the history purge function. operationId: purgeHistoryNow parameters: - name: numberOfDaysToKeep in: query description: >- The number of days for which the data will be preserved in the database. The valid value for this parameter is between 1 and 3650. Set this parameter to -1 if you are using either untilWhenTimestamp or numberOfMonthsToKeep. Using this parameter will archive all history that will be purged and overwrite existing archive files in the /data/Archive directory. style: form explode: true schema: type: integer format: int32 - name: numberOfMonthsToKeep in: query description: >- The number of months for which the data will be preserved in the database. The valid value for this parameter is between 0 to infinite months. Set this parameter to -1 if you are using either untilWhenTimestamp or numberOfDaysToKeep. Using this parameter will not archive any data. style: form explode: true schema: type: integer format: int32 - name: untilWhenTimestamp in: query description: >- The string specifying the point in time after which history is to be preserved. The valid timestamp pattern is YYYY-MM[-DD[ HH:MM:SS[.mmm]]]. Set this parameter with an empty string "" if you are using either numbeOfDaysToKeep or numberOfMonthsToKeep. Using this parameter will not archive any data. style: form explode: true schema: type: string - name: waitOption in: query description: >- The Boolean value. If set to true, the purge will be performed and the result will be returned when completed. The default value is false. style: form explode: true schema: type: boolean responses: '204': description: Returns 0 (zero) when the purge service has successfully completed. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/removeTrustRelationship: post: tags: - bam_object_methods summary: removeTrustRelationship description: >- Removes a remote Address Manager server from the trust relationship. You can remove Address Manager servers within the trust relationship one at a time. operationId: removeTrustRelationship parameters: - name: otherBAMIP in: query description: >- The IP address of the standby server. If the Address Manager server is in replication, you must first remove it from replication in order to remove it from the trust relationship. style: form explode: true schema: type: string - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/terminateUserSessions: post: tags: - bam_object_methods summary: terminateUserSessions description: Terminates all active user sessions in Address Manager. operationId: terminateUserSessions parameters: - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string - name: username in: query description: The username of the user for which all active sessions are terminated. style: form explode: true schema: type: string responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateAccessRight: put: tags: - bam_object_methods summary: updateAccessRight description: Updates access rights for a specified object. operationId: updateAccessRight parameters: - name: entityId in: query description: The object ID of the entity to which the access right is assigned. style: form explode: true schema: type: integer format: int64 - name: overrides in: query description: >- A list of potentially modified type-specific overrides in the following format: "objectType=accessValue|objectType=accessValue" style: form explode: true schema: type: string - name: properties in: query description: >- A string including the following options:
  • workflowLevel —valid values for this option are as follows:
    • None —changes made by the user or group take effect immediately.
    • Recommend —changes made by the user or group are saved as change requests and must be reviewed and approved before they take effect.
    • Approve —changes made by the user or group take effect immediately and the user or group can approve change requests from other users or groups.
  • deploymentAllowed—either true or false; to indicate whether or not the user or group can perform a full deployment of data from the configuration to a managed server
  • quickDeploymentAllowed—either true or false; to indicate whether or not the user or group can instantly deploy changed DNS resource records.perform a full deployment of data from the configuration to a managed server.
  • All of these properties are optional.
  • The deploymentAllowed property is applicable only for configuration, server or root with Full access.
  • The workflowLevel property is applicable only for Change, Add, or Full access rights.
 style: form explode: true schema: type: string - name: userId in: query description: >- The object ID of the user to whom the access right is assigned. This value is not mutable. style: form explode: true schema: type: integer format: int64 - name: value in: query description: >- The new value for the access right. Valid entries are listed in . style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/updateConfigurationSetting: put: tags: - bam_object_methods summary: updateConfigurationSetting description: Updates the configuration setting. operationId: updateConfigurationSetting parameters: - name: configurationId in: query description: The object ID of the configuration in which the setting is to be located. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The new properties of the configuration setting to be updated. Only the disable DNS option inheritance disableDnsOptionInheritance property is supported. If set to true, DNS options that have been configured on a zone are not inherited by the child zone. In the reverse space, DNS options that have been configured on a block are not inherited by the child block or network.
  • Disabling DNS option inheritance only affect options attached to a zone or block and the inheritance of those options by child zones, blocks, or networks.
  • You cannot disable the inheritance of DNS options that are attached to a configuration, view, or server. These DNS options will continue to be inherited by all zones, blocks, or networks found under the object.
 style: form explode: true schema: type: string - name: settingName in: query description: >- The name of the specific setting to be read. Only the option inheritance OPTION_INHERITANCE setting is supported. style: form explode: true schema: type: string responses: '204': description: Update the configuration setting. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/updateUserPassword: put: tags: - bam_object_methods summary: updateUserPassword description: >- Updates an Address Manager user password. You must be an Address Manager administrator to invoke this method. operationId: updateUserPassword parameters: - name: newPassword in: query description: The new password for the user. style: form explode: true schema: type: string - name: options in: query description: Reserved for future use. style: form explode: true schema: type: array items: type: string - name: userId in: query description: >- The user ID of an application user who is either a primary or a secondary authenticator. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/getProbeData: get: tags: - data_collection_methods summary: getProbeData description: Returns the JSON response from the properties field of the APIData object. operationId: getProbeData parameters: - name: definedProbe in: query description: >- Pre-defined SQL queries that will be triggered to collect data. The available values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM. style: form explode: true schema: type: string - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string responses: '200': description: Returns the JSON response from the properties field of the APIData object. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIData' - description: API Data with a timestamp. deprecated: false /v1/getProbeStatus: get: tags: - data_collection_methods summary: getProbeStatus description: Returns the status of the triggered data collection process. operationId: getProbeStatus parameters: - name: definedProbe in: query description: >- Pre-defined SQL queries that have been triggered to collect data. The available values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM. style: form explode: true schema: type: string responses: '200': description: Returns a pre-defined value from 0 to 3, depending on the status of the data collection process. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/startProbe: put: tags: - data_collection_methods summary: startProbe description: >- Starts collecting data from the Address Manager database using pre-defined SQL queries. operationId: startProbe parameters: - name: definedProbe in: query description: >- Pre-defined SQL queries that will be triggered to collect data. The available values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM. style: form explode: true schema: type: string - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/addCustomOptionDefinition: post: tags: - dhcp_methods summary: addCustomOptionDefinition description: Adds a custom deployment option. operationId: addCustomOptionDefinition parameters: - name: allowMultiple in: query description: >- This parameter determines whether or not the custom option requires multiple values. The default value is false;

In Perl script, only an empty string and zero (0) are considered as false; other values are considered as true. Therefore, a string containing the word false is considered to be true because the string is not empty. In Perl, set the allowMultiple data type to string and set the value to either true or false: SOAP::Data->type ('string') -> name ('allowMultiple') -> value ("false") -> attr ({xmlns => ''}) Or, set the allowMultiple data type to boolean. Set the value to either 0 or an empty string to represent false. Set the value to any other text to represent true. SOAP::Data->type ('boolean') -> name ('allowMultiple') -> value (0) -> attr ({xmlns => ''})

style: form explode: true schema: type: boolean - name: configurationId in: query description: The object ID of the parent configuration. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the custom deployment option. style: form explode: true schema: type: string - name: optionId in: query description: >- The option code for the custom deployment option. This value must be within the range of 151 to 174, 178 to 207, 212 to 219, 222 to 223, or 224 to 254. style: form explode: true schema: type: integer format: int64 - name: optionType in: query description: >- The type of custom deployment option. This value must be one of the items listed in . style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new option defined. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP4Range: post: tags: - dhcp_methods summary: addDHCP4Range description: Adds IPv4 DHCP ranges. operationId: addDHCP4Range parameters: - name: end in: query description: An IP address defining the highest address or end of the range. style: form explode: true schema: type: string - name: networkId in: query description: The object ID for the network in which this DHCP range is located. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including the object name and user-defined fields. style: form explode: true schema: type: string - name: start in: query description: An IP address defining the lowest address or start of the range. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv4 range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP4RangeBySize: post: tags: - dhcp_methods summary: addDHCP4RangeBySize description: Adds IPv4 DHCP ranges by offset and percentage. operationId: addDHCP4RangeBySize parameters: - name: networkId in: query description: The object ID for the network in which this DHCP range is located. style: form explode: true schema: type: integer format: int64 - name: offset in: query description: >- An integer value specifying the point where the range should begin. The positive values indicate that the starting IP address of the range will be counted from the Network ID first IP address and forward in the range. The negative values indicate that the starting IP address of the range will be counted from the Network Broadcast Address last IP address and backward in the range. style: form explode: true schema: type: string - name: properties in: query description: >- Optional object properties that can contain the object name, the value of defineRangeBy, and user-defined fields. The possible values for defineRangeBy are OFFSET_AND_SIZE and OFFSET_AND_PERCENTAGE. OFFSET_AND_SIZE is reserved for future use. style: form explode: true schema: type: string - name: size in: query description: >- The size of the range. Currently, you can only specify the range size in a relative size proportional to the parent network size. To define the relative range size, you must set defineRangeBy with the OFFSET_AND_PERCENTAGE value in the properties field. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv4 range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP6ClientDeploymentOption: post: tags: - dhcp_methods summary: addDHCP6ClientDeploymentOption description: >- Adds DHCPv6 client options and returns the database object ID for the new option object. operationId: addDHCP6ClientDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which you are adding the deployment option. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv6 client option you are adding. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: value in: query description: >- The value you are assigning to the option. Depending on the type of deployment option you are adding, the format of the value might differ. For more information, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new DHCPv6 client object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP6Range: post: tags: - dhcp_methods summary: addDHCP6Range description: Adds IPv6 DHCP ranges. operationId: addDHCP6Range parameters: - name: end in: query description: An IP address defining the highest address or end of the range. style: form explode: true schema: type: string - name: networkId in: query description: The object ID for the network in which this DHCPv6 range is located. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including the object name and user-defined fields. style: form explode: true schema: type: string - name: start in: query description: An IP address defining the lowest address or start of the range. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv6 range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP6RangeBySize: post: tags: - dhcp_methods summary: addDHCP6RangeBySize description: Adds IPv6 DHCP ranges by size. operationId: addDHCP6RangeBySize parameters: - name: networkId in: query description: The object ID for the network in which the DHCP range is located. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Optional object properties that can contain the object name, the value of defineRangeBy, and user-defined fields. The possible values for defineRangeBy are AUTOCREATE_BY_SIZE, OFFSET_AND_SIZE, and START_ADDRESS_AND_SIZE. If you do not specify the defineRangeBy value, the DHCP range will be created using AUTOCREATE_BY_SIZE by default. style: form explode: true schema: type: string - name: size in: query description: >- The size of the range. Currently, you can only specify the range size in a relative size proportional to the parent network size. style: form explode: true schema: type: string - name: start in: query description: >- An integer value or IPv6 address specifying the point where the range should begin. The positive values indicate that the starting IP address of the range will be counted from the Network ID first IP address and forward in the range. The IPv6 address value indicates the starting address of the range.
  • If you set defineRangeBy with the AUTOCREATE_BY_SIZE value in the property field, the start field must contain an empty string ("").
  • If you set defineRangeBy with the OFFSET_AND_SIZE value in the property field, the start field must contain a positive integer value.
  • If you set defineRangeBy with the START_ADDRESS_AND_SIZE value in the property field, the start field must contain a valid IPv6 address that will be used as the starting address of the DHCP range.
 style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv6 range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCP6ServiceDeploymentOption: post: tags: - dhcp_methods summary: addDHCP6ServiceDeploymentOption description: Adds DHCPv6 service options. operationId: addDHCP6ServiceDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which you are adding the service option. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv6 service option you are adding. This name must be one of the constants listed in . If you do not configure the DDNS_UPDATE_STYLE service option, the default value is interim. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: value in: query description: >- The value you are assigning to the option. When adding the DDNS hostname option, you must specify the value in the format: [Type], [Data] for IP and DUID. Where:
  • Type—type of DDNS hostname. The possible values are DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_IP, DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_DUID.
  • Data—for IP and DUID, this value is used to form the DDNS hostname. This is optional.

When adding the DDNS update style, you must specify the value in the following format:

  • DHCPServiceOptionConstants.DDNS_UPDATE_STYLE_INTERIM
  • DHCPServiceOptionConstants.DDNS_UPDATE_STYLE_STANDARD

 Depending on the type of deployment option you are adding, the format of the value input might differ. For more information, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new option. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCPClientDeploymentOption: post: tags: - dhcp_methods summary: addDHCPClientDeploymentOption description: Adds a DHCP client option and returns the object ID for the new option object. operationId: addDHCPClientDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which you are adding the client option. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 client option you are adding. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: value in: query description: >- The value you are assigning to the option. Depending on the type of deployment option you are adding, the format of the value might differ. For more information, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv4 client option object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCPMatchClass: post: tags: - dhcp_methods summary: addDHCPMatchClass description: Adds DHCP match classes to Address Manager. operationId: addDHCPMatchClass parameters: - name: configurationId in: query description: The object ID of the configuration to which you are adding the DHCP match class. style: form explode: true schema: type: integer format: int64 - name: matchCriteria in: query description: >- A string defining the match criteria. The value must be one of the constants listed in . style: form explode: true schema: type: string - name: name in: query description: The name of the DHCP match class. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the following properties and values:
  • description —a description of the match class.
  • matchOffset —the Match Offset value for the MatchClass. It refers to the point where the match should begin.
  • matchLength —the Match Length value for the Matchclass. It refers to the number of characters to match.
  • customMatchRawString —a raw string that maps directly to a data or boolean expression for DHCP_CLASS_CUSTOM_MATCH and DHCP_CLASS_CUSTOM_MATCH_IF constants. Use the syntax and grammar supported by the ISC’s DHCP daemon. End the string with a semicolon (;). If you omit the semicolon, one is automatically added when the condition is deployed.
    • matchOffset and matchLength only apply to the following five constants:
      • DHCP_CLASS_HARDWARE
      • DHCP_CLASS_CLIENT_ID
      • DHCP_CLASS_VENDOR_ID
      • DHCP_CLASS_AGENT_CIRCUIT_ID
      • DHCP_CLASS_AGENT_REMOTE_ID
    • You must specify matchOffset and matchLength together.
style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new DHCP match class added. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCPServiceDeploymentOption: post: tags: - dhcp_methods summary: addDHCPServiceDeploymentOption description: Adds DHCP service options. operationId: addDHCPServiceDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which you are adding the service option. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 service option you are adding. This name must be one of the constants listed in . If you do not configure the DDNS_UPDATE_STYLE service option, the default value is interim. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: value in: query description: >- The value you are assigning to the option. When adding the DDNS hostname option, you must specify the value in the format: [Type], [Position], [Data] for IP and MAC type, and [Type], [Data] for FIXED type. Where:
  • Type —type of DDNS hostname. The possible values are DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_IP, DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_MAC, or DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_FIXED.
  • Position —specify where you wish to add the data value to the IP or MAC address. The possible values are DHCPServiceOptionConstants.DDNS_HOSTNAME_POSITION_PREPEND, or DHCPServiceOptionConstants.DDNS_HOSTNAME_POSITION_APPEND. This is only required for IP or MAC type with Data.
  • Data —for IP and MAC address, this value is used to be prepended or appended to the IP address or MAC address. For FIXED type, this value must be specified and will be used for the DDNS hostname. This is optional for IP and MAC type.

When adding the DDNS update style, you must specify the value in the following format:

  • DHCPServiceOptionConstants.DDNS_UPDATE_STYLE_INTERIM
  • DHCPServiceOptionConstants.DDNS_UPDATE_STYLE_STANDARD

 Depending on the type of deployment option you are adding, the format of the value input might differ. For more information, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCPv4 service option. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCPSubClass: post: tags: - dhcp_methods summary: addDHCPSubClass description: Adds DHCP match class values. operationId: addDHCPSubClass parameters: - name: matchClassId in: query description: The object ID of the match class in which you are defining the DHCP match class value. style: form explode: true schema: type: integer format: int64 - name: matchValue in: query description: >- The value of the DHCP match value to be matched with the match class. The length of the match value must be equal to the length, in bytes, specified in the match class. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing:
  • description —a description of the match class.
style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new DHCP match class value. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDHCPVendorDeploymentOption: post: tags: - dhcp_methods summary: addDHCPVendorDeploymentOption description: Adds a DHCP vendor deployment option to specified objects. operationId: addDHCPVendorDeploymentOption parameters: - name: optionId in: query description: >- The object ID of the vendor option definition. All DHCP vendor client deployment options have a fixed option code of 60 and a unique option sub-code. The unique sub-code is set with the optionId value in the addVendorOptionDefinition method. style: form explode: true schema: type: integer format: int64 - name: parentId in: query description: >- The object ID of the parent object for the DHCP vendor deployment option. The parent object must not be a DNS object. Valid parent types are Configuration, IP4Block, IP4Network, IP4NetworkTemplate, IP4Addr, IP4DHCPRange, Server, MACAddr, and MACPool. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including user-defined fields. This value can be empty. If the DHCP vendor client deployment option is intended for use with a specific server, the object ID of the server must be specified in the properties string. style: form explode: true schema: type: string - name: value in: query description: >- The value for the option. The value should be appropriate for its option type. For example, if the option type is IP4 and allowMultiple is set as true in the vendor option definition, then the value of the DHCP vendor client deployment option should be multiple IPv4 addresses in a comma-separated list. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new DHCP vendor deployment option. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addVendorOptionDefinition: post: tags: - dhcp_methods summary: addVendorOptionDefinition description: Adds a vendor option definition to a vendor profile. operationId: addVendorOptionDefinition parameters: - name: allowMultiple in: query description: >- Determines whether or not the custom option requires multiple values. The default value is false.

In Perl script, only an empty string and 0 zero are considered as false; other values are considered as true. Therefore, a string containing the word “false” is considered to be true because the string is not empty. In Perl, set the allowMultipledata type to string and set the value to either true or false: SOAP::Data->type ('string') -> name ('allowMultiple') -> value ("false") -> attr ({xmlns => ''}) Or, set the allowMultipledata type to boolean. Set the value to either 0or an empty string to represent false. Set the value to any other text to represent true. SOAP::Data->type ('boolean') -> name ('allowMultiple') -> value (0) -> attr ({xmlns => ''})

style: form explode: true schema: type: boolean - name: description in: query description: A description of the vendor option. style: form explode: true schema: type: string - name: name in: query description: The name of the vendor option. style: form explode: true schema: type: string - name: optionId in: query description: >- The deployment option ID. This value must be within the range of 1 to 254. style: form explode: true schema: type: integer format: int64 - name: optionType in: query description: >- The option type. This value must be one of the types listed in . style: form explode: true schema: type: string - name: properties in: query description: >- Adds object properties, including user-defined fields. This value can be empty. style: form explode: true schema: type: string - name: vendorProfileId in: query description: The object ID of the vendor profile. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID of the new vendor option definition. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addVendorProfile: post: tags: - dhcp_methods summary: addVendorProfile description: Adds a vendor profile and returns the object ID for the new vendor profile. operationId: addVendorProfile parameters: - name: description in: query description: A description of the vendor profile. style: form explode: true schema: type: string - name: identifier in: query description: The Vendor Class Identifier. style: form explode: true schema: type: string - name: name in: query description: >- A descriptive name for the vendor profile. This name is not matched against DHCP functionality. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new vendor profile. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/deleteDHCP6ClientDeploymentOption: delete: tags: - dhcp_methods summary: deleteDHCP6ClientDeploymentOption description: Deletes DHCPv6 client options. operationId: deleteDHCP6ClientDeploymentOption parameters: - name: entityId in: query description: >- The database object ID for the entity from which this deployment option will be deleted. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv6 client option being deleted. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- The specific server or server group to which this option is deployed. To delete an option that has not been assigned to a server role, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDHCP6ServiceDeploymentOption: delete: tags: - dhcp_methods summary: deleteDHCP6ServiceDeploymentOption description: Deletes DHCPv6 service options. operationId: deleteDHCP6ServiceDeploymentOption parameters: - name: entityId in: query description: >- The object ID for the entity from which this deployment option is being deleted. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 service option being deleted. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which the option is deployed for the specified entity. To return an option that has not been assigned to a server role, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDHCPClientDeploymentOption: delete: tags: - dhcp_methods summary: deleteDHCPClientDeploymentOption description: Deletes DHCP client options. operationId: deleteDHCPClientDeploymentOption parameters: - name: entityId in: query description: >- The object ID for the entity from which the deployment option will be deleted. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 client option to be deleted. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- The specific server or server group to which this option is deployed. To delete an option that has not been assigned to a server, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDHCPServiceDeploymentOption: delete: tags: - dhcp_methods summary: deleteDHCPServiceDeploymentOption description: Deletes DHCP service options. operationId: deleteDHCPServiceDeploymentOption parameters: - name: entityId in: query description: >- The object ID for the entity from which this deployment option is being deleted. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 service option being deleted. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which the option is deployed for the specified entity. To retrieve an option that has not been assigned to a server role, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDHCPVendorDeploymentOption: delete: tags: - dhcp_methods summary: deleteDHCPVendorDeploymentOption description: Deletes a specified DHCP vendor deployment option. operationId: deleteDHCPVendorDeploymentOption parameters: - name: entityId in: query description: >- The object ID of the object to which the DHCP vendor deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: optionId in: query description: >- the object ID of the vendor option definition. All DHCP vendor client deployment options have a fixed option code of 60 and a unique option sub-code. The unique sub-code is set with the optionId value in the addVendorOptionDefinition method. style: form explode: true schema: type: integer format: int64 - name: serverId in: query description: >- The object ID of the server or server group where the DHCP vendor deployment option is used. If the option is generic, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/getDHCP6ClientDeploymentOption: get: tags: - dhcp_methods summary: getDHCP6ClientDeploymentOption description: >- Returns DHCPv6 client options assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDHCP6ClientDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv6 client option being added. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- The specific server or server group to which this option is deployed. To return an option that has not been assigned to a server role, set this value to zero. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the specified DHCPv6 client option object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getDHCP6ServiceDeploymentOption: get: tags: - dhcp_methods summary: getDHCP6ServiceDeploymentOption description: >- Returns DHCPv6 service options assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDHCP6ServiceDeploymentOption parameters: - name: entityId in: query description: >- The database object ID for the entity to which the deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv6 service option being added. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which the option is deployed for the specified entity. To retrieve an option that has not been assigned to a server role, set this value to zero. Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the requested DHCPv6 service option object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getDHCPClientDeploymentOption: get: tags: - dhcp_methods summary: getDHCPClientDeploymentOption description: >- Returns DHCPv4 client options assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDHCPClientDeploymentOption parameters: - name: entityId in: query description: >- The object ID for the entity to which the deployment option has been applied. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 client option being added. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- The specific server or server group to which this option is deployed. To return an option that has not been assigned to a server, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the specified DHCPv4 client option object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getDHCPServiceDeploymentOption: get: tags: - dhcp_methods summary: getDHCPServiceDeploymentOption description: >- Returns DHCP service options assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDHCPServiceDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which the deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DHCPv4 service option being retrieved. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which the option is deployed for the specified entity. To retrieve an option that has not been assigned to a server role, specify 0 as a value. Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the requested DHCPv4 service option object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getDHCPVendorDeploymentOption: get: tags: - dhcp_methods summary: getDHCPVendorDeploymentOption description: >- Retrieves a DHCP vendor deployment option assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDHCPVendorDeploymentOption parameters: - name: entityId in: query description: >- The object ID of the entity to which the DHCP vendor deployment option is assigned. This must be the ID of a configuration, IPv4 block, IPv4 network, IPv4 address, IPv4 DHCP rage, server, MAC address, or MAC pool. style: form explode: true schema: type: integer format: int64 - name: optionId in: query description: The object ID of the DHCP vendor option definition. style: form explode: true schema: type: integer format: int64 - name: serverId in: query description: >- The specific server or server group to which this option is deployed for the specified entity. To return an option that has not been assigned to a server, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an APIDeploymentOption for the DHCP vendor client deployment option. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getSharedNetworks: get: tags: - dhcp_methods summary: getSharedNetworks description: Returns multiple IPv4 networks linked to the given shared network tag. operationId: getSharedNetworks parameters: - name: tagId in: query description: >- The object ID of the tag that is linked with shared IPv4 networks. If tagId is invalid, an error will be returned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an array of entities of all the IPv4 networks linked to the given shared network tag. If no networks are found, returns an empty array. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/shareNetwork: put: tags: - dhcp_methods summary: shareNetwork description: Links an IPv4 network with a shared network tag. operationId: shareNetwork parameters: - name: networkId in: query description: >- The object ID of the IPv4 network that is being linked with a shared network tag. If networkId is invalid, an error will be returned. style: form explode: true schema: type: integer format: int64 - name: tagId in: query description: >- The object ID of the tag that is linked. If tagId is not valid, an error will be returned. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/unshareNetwork: put: tags: - dhcp_methods summary: unshareNetwork description: Unlinks the shared network tag from an IPv4 network. operationId: unshareNetwork parameters: - name: networkId in: query description: >- The object ID of the IPv4 network that is being unlinked from a shared network tag. If networkId is invalid, an error will be returned. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/updateDHCP6ClientDeploymentOption: put: tags: - dhcp_methods summary: updateDHCP6ClientDeploymentOption description: Updates DHCPv6 client options. operationId: updateDHCP6ClientDeploymentOption parameters: [] requestBody: description: >- The DHCPv6 client option object that is updated. The Name field of the DHCPv6 client deployment option object cannot be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCP6ClientDeploymentOptionRequest' - description: >- The DHCPv6 client option object that is updated. The Name field of the DHCPv6 client deployment option object cannot be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDHCP6ServiceDeploymentOption: put: tags: - dhcp_methods summary: updateDHCP6ServiceDeploymentOption description: Updates DHCPv6 service options. operationId: updateDHCP6ServiceDeploymentOption parameters: [] requestBody: description: >- The DHCPv6 service option object to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCP6ServiceDeploymentOptionRequest' - description: >- The DHCPv6 service option object to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '201': description: Returns the object ID for the new option. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDHCPClientDeploymentOption: put: tags: - dhcp_methods summary: updateDHCPClientDeploymentOption description: Updates DHCP client options. operationId: updateDHCPClientDeploymentOption parameters: [] requestBody: description: >- The DHCP client option object to be updated. The Name field of the DHCP client deployment option object cannot be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCPClientDeploymentOptionRequest' - description: >- The DHCP client option object to be updated. The Name field of the DHCP client deployment option object cannot be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDHCPServiceDeploymentOption: put: tags: - dhcp_methods summary: updateDHCPServiceDeploymentOption description: Updates DHCP service options. operationId: updateDHCPServiceDeploymentOption parameters: [] requestBody: description: >- The DHCP service option object to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCPServiceDeploymentOptionRequest' - description: >- The DHCP service option object to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDHCPVendorDeploymentOption: put: tags: - dhcp_methods summary: updateDHCPVendorDeploymentOption description: Updates the specified DHCP vendor deployment option. operationId: updateDHCPVendorDeploymentOption parameters: [] requestBody: description: >- APIDeploymentOption to be updated. This is what getDHCPVendorDeploymentOption returns. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCPVendorDeploymentOptionRequest' - description: >- APIDeploymentOption to be updated. This is what getDHCPVendorDeploymentOption returns. example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/addACL: post: tags: - dns_methods summary: addACL description: Adds an Access Control List (ACL) to a view. operationId: addACL parameters: - name: configurationId in: query description: The object ID of the configuration on which ACL need to be added. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the ACL. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the comma-separated list of options in the following format: aclValues=IP4Address, IP6Address, IP4Network’s CIDR, IP6Network’s CIDR, ACL’s name, TSIG key’s name, Predefined BIND ACL values where:
  • IP4Address —the IPv4 address.
  • IP6Address —the IPv6 address.
  • IP4Network’s CIDR —the CIDR notation defining the IPv4 network.
  • IP6Network’s CIDR —the CIDR notation defining the IPv6 network.
  • ACL’s name —the name of the ACL Example: acl aclName.
  • TSIG key’s name —the name of the TSIG key Example: key TSIGName.
  • Predefined BIND ACL values —Example: ‘none’, 'any', 'localhost', 'localnets' or 'All', 'None', 'Local Host', 'Local Networks'.
Use an exclamation mark (!) to exclude a certain option. For example, !none, !acl aclName, !10/ 24, etc. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new ACL object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addAliasRecord: post: tags: - dns_methods summary: addAliasRecord description: Adds alias records. operationId: addAliasRecord parameters: - name: absoluteName in: query description: >- The FQDN of the alias. If you are adding a record in a zone that is linked to an incremental naming policy, you must add a single hash (#) sign at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: linkedRecordName in: query description: The name of the record to which this alias will link. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view to which this record is being added. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new alias resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addBulkHostRecord: post: tags: - dns_methods summary: addBulkHostRecord description: Adds bulk host records using auto-increment from the specific starting address. operationId: addBulkHostRecord parameters: - name: absoluteName in: query description: >- The FQDN of the host record. If you are adding a record in a zone that is linked to an incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash # sign varies. style: form explode: true schema: type: string - name: networkId in: query description: >- The network receiving the available IP addresses. Each address is used for one host record. style: form explode: true schema: type: integer format: int64 - name: numberOfAddresses in: query description: The number of addresses. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: >- excludeDHCPRange = true/false. If true, then IP addresses within a DHCP range will be skipped. This argument can also contain user-defined fields. style: form explode: true schema: type: string - name: startAddress in: query description: The starting IPv4 address for getting the available addresses. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view to which you are adding the record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns an array of host record APIEntity objects based on available addresses and number of IP addresses required. If no addresses are available, an error will be shown. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/addDNSDeploymentOption: post: tags: - dns_methods summary: addDNSDeploymentOption description: Adds DNS options. operationId: addDNSDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which you are adding the deployment option. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DNS option you are adding. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: value in: query description: >- The value you are assigning to the option. Depending on the type of deployment option you are adding, the format of the value might differ. For more information, refer to . If you are adding a Reverse Zone Name Format, the following values are supported:
  • ReverseZoneFormatType.STARTIP_NETMASK_NET or "[start-ip]-[net-mask].[net].inaddr.arpa"
  • ReverseZoneFormatType.STARTIP_ENDIP_NET or "[start-ip]-[end-ip].[net].in-addr.arpa"
  • ReverseZoneFormatType.STARTIP_SLASH_NETMASK_NET or "[start-ip]/[netmask].[net].in-addr.arpa"
  • ReverseZoneFormatType.STARTIP_SLASH_ENDIP_NET or "[start-ip]/[end-ip].[net].inaddr.arpa"
  • ReverseZoneFormatType.CUSTOM + ReverseZoneFormatType.SEPARATOR + "[customformat-value]" or “custom:<custom-format-value>”
 style: form explode: true schema: type: string responses: '201': description: Returns long type and represents the database object ID of the newly added DNS deployment option. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addEnumNumber: post: tags: - dns_methods summary: addEnumNumber description: Adds ENUM numbers. operationId: addEnumNumber parameters: - name: enumZoneId in: query description: >- The object ID of the parent object for the ENUM number. The parent object for an ENUM number is always an ENUM zone. style: form explode: true schema: type: integer format: int64 - name: number in: query description: The ENUM phone number. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: >- Adds object properties and user-defined fields, including the data string, which includes service, URI, comment, and ttl values. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new ENUM number record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addEnumZone: post: tags: - dns_methods summary: addEnumZone description: Adds ENUM zones. operationId: addEnumZone parameters: - name: parentId in: query description: The object ID for the parent object of the ENUM zone. style: form explode: true schema: type: integer format: int64 - name: prefix in: query description: The number prefix for the ENUM zone. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new ENUM zone. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addExternalHostRecord: post: tags: - dns_methods summary: addExternalHostRecord description: Adds external host records. operationId: addExternalHostRecord parameters: - name: name in: query description: The FQDN of the host record. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: viewId in: query description: The object ID for the parent view to which you are adding the record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new external host record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addGenericRecord: post: tags: - dns_methods summary: addGenericRecord description: Adds generic records. operationId: addGenericRecord parameters: - name: absoluteName in: query description: >- The FQDN of the record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: rdata in: query description: >- The data for the resource record, in BIND format. For example, A records follow the format 10.0.0.4. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of record. Valid settings for this parameter are the generic resource record types supported in Address Manager: A6, AAAA, AFSDB, APL, CAA, CERT, DHCID, DNAME, DNSKEY, DS, ISDN, KEY, KX, LOC, MB, MG, MINFO, MR, NS, NSAP, PX, RP, RT, SINK, SSHFP, TLSA, WKS, and X25. style: form explode: true schema: type: string - name: viewId in: query description: The object ID for the parent view to which you are adding the record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new generic resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addHINFORecord: post: tags: - dns_methods summary: addHINFORecord description: Adds HINFO records. operationId: addHINFORecord parameters: - name: absoluteName in: query description: >- The FQDN of the HINFO record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: cpu in: query description: A string providing central processing unit information. style: form explode: true schema: type: string - name: os in: query description: A string providing operating system information. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view to which you are adding the HINFO record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new HINFO resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addHostRecord: post: tags: - dns_methods summary: addHostRecord description: >- Adds host records for IPv4 or IPv6 addresses. All addresses must be valid addresses. operationId: addHostRecord parameters: - name: absoluteName in: query description: >- The FQDN of the host record. If you are adding a record in a zone that is linked to an incremental naming policy, you must add a single hash (#) sign at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: addresses in: query description: A list of comma-separated IP addresses, for example, 10.0.0.5,130.4.5.2. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view to which this record is being added. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new host resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addMXRecord: post: tags: - dns_methods summary: addMXRecord description: Adds MX records. operationId: addMXRecord parameters: - name: absoluteName in: query description: >- The FQDN of the record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: linkedRecordName in: query description: The FQDN of the host record to which this MX record is linked. style: form explode: true schema: type: string - name: priority in: query description: >- Specifies which mail server to send clients to first when multiple matching MX records are present. Multiple MX records with equal priority values are referred to in a round-robin fashion. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view where you wish to add the MX record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new MX resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addNAPTRRecord: post: tags: - dns_methods summary: addNAPTRRecord description: Adds NAPTR records. operationId: addNAPTRRecord parameters: - name: absoluteName in: query description: >- The FQDN for the record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: flags in: query description: An optional parameter used to set flag values for the record. style: form explode: true schema: type: string - name: order in: query description: >- Specifies the order in which NAPTR records are read if several are present and are possible matches. The lower ordervalue takes precedence. style: form explode: true schema: type: integer format: int32 - name: preference in: query description: >- Specifies the order in which NAPTR records are read if the ordervalues are the same in multiple records. The lower preferencevalue takes precedence. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: regexp in: query description: >- A regular expression, enclosed in double quotation marks, used to transform the client data. If you do not specify a regular expression, you must specify a domain name in the replacement parameter. style: form explode: true schema: type: string - name: replacement in: query description: >- Specifies a domain name as an alternative to the regexp. This parameter replaces client data with a domain name. style: form explode: true schema: type: string - name: service in: query description: >- Specifies the service used for the NAPTR record. Valid settings for this parameter are listed in . style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view where you wish to add the record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new NAPTR resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addResourceRecord: post: tags: - dns_methods summary: addResourceRecord description: >- Add resource records. This method is a generic method for adding resource records of any kind by specifying the name, type, and rdata arguments. operationId: addResourceRecord parameters: - name: absoluteName in: query description: >- The absolute name of the record, specified as an FQDN. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: rdata in: query description: >- The data for the resource record in BIND format. For example, an A record in the format A 10.0.0.4. You can specify either a single IPv4 or IPv6 address for the record. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of record being added. Valid values for this parameter are the resource record types shown in Object Types:
  • AliasRecord
  • HINFORecord
  • HostRecord
  • MXRecord
  • TXTRecord
To add NAPTRRecord, SRVRecord, and GenericRecord, you must use addNAPTRRecord, addSRVRecord, and addGenericRecord methods respectively. style: form explode: true schema: type: string - name: viewId in: query description: The object ID for the parent view where you wish to add the resource record. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new resource record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addResponsePolicy: post: tags: - dns_methods summary: addResponsePolicy description: Adds a DNS response policy. operationId: addResponsePolicy parameters: - name: configurationId in: query description: The object ID of the configuration to which you are adding the response policy. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the DNS response policy you are adding. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing options, including comments and user-defined fields. If you configure a redirect response policy, you must also specify the redirectTarget property with the value set as a FQDN. For example: redirectTarget=redirect.example.com style: form explode: true schema: type: string - name: responsePolicyType in: query description: >- The type of response policy you are adding. The available values are BLACKLIST, BLACKHOLE, WHITELIST, and REDIRECT.The responsePolicyType values must be in CAPITAL letters. style: form explode: true schema: type: string - name: ttl in: query description: The time-to-live (TTL) value in seconds. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID of the new DNS response policy added. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addResponsePolicyItem: post: tags: - dns_methods summary: addResponsePolicyItem description: Adds a DNS response policy item under a specified local DNS response policy. operationId: addResponsePolicyItem parameters: - name: itemName in: query description: The FQDN of the response policy item. style: form explode: true schema: type: string - name: options in: query description: Reserved for future use. style: form explode: true schema: type: array items: type: string - name: policyId in: query description: >- The object ID of the parent local response policy to which the response policy item is being added. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID of the new DNS response policy added. headers: {} content: application/json: schema: type: boolean deprecated: false /v1/addSRVRecord: post: tags: - dns_methods summary: addSRVRecord description: Adds SRV records. operationId: addSRVRecord parameters: - name: absoluteName in: query description: >- The FQDN of the SRV record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: linkedRecordName in: query description: The FQDN of the host record to which this SRV record is linked. style: form explode: true schema: type: string - name: port in: query description: The TCP/UDP port on which the service is available. style: form explode: true schema: type: integer format: int32 - name: priority in: query description: >- Specifies which SRV record to use when multiple matching SRV records are present. The record with the lowest value takes precedence. style: form explode: true schema: type: integer format: int32 - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The object ID for the parent view where you wish to add the SRV record. style: form explode: true schema: type: integer format: int64 - name: weight in: query description: >- If two matching SRV records within a zone have equal priority, the weight value is checked. If the weight value for one object is higher than the other, the record with the highest weight has its resource records returned first. style: form explode: true schema: type: integer format: int32 responses: '201': description: Returns the object ID for the new SRV record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addStartOfAuthority: post: tags: - dns_methods summary: addStartOfAuthority description: Adds SOA records. operationId: addStartOfAuthority parameters: - name: email in: query description: >- Specifies the email address of the administrator for the zones to which the SOA applies. style: form explode: true schema: type: string - name: expire in: query description: >- Specifies the length of time that a slave server will use a non-updated set of zone data before it stops sending queries. This is specified as a number of seconds using a 32-bit integer. RFC 1912 recommends a value from 1209600 to 2419200 seconds or 2 to 4 weeks. style: form explode: true schema: type: integer format: int64 - name: minimum in: query description: >- Specifies the maximum amount of time that a negative cache response is held in cache. A negative cache response is a response to a DNS query that does not return an IP address a failed request. Until this value expires, queries for this DNS record return an error. The maximum value for this field is 10800 seconds, or 3 hours. style: form explode: true schema: type: integer format: int64 - name: parentId in: query description: The object ID of the parent object of the SOA record. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including comments and user-defined fields. The supported properties are time-to-live TTL, primary server mname and serial number format serialNumberFormat. To override the default TTL value for SOA records, use ObjectProperties.ttl=”<value>” of the properties string. style: form explode: true schema: type: string - name: refresh in: query description: >- The amount of time that a slave server waits before attempting to refresh zone files from the master server. This is specified in seconds using a 32-bit integer value. RFC 1912 recommends a value between 1200 and 4300 seconds. style: form explode: true schema: type: integer format: int64 - name: retry in: query description: >- Specifies the amount of time that the slave server should wait before re-attempting a zone transfer from the master server after the refresh value has expired. This is specified as a number of seconds using a 32-bit integer value. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new SOA record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addTXTRecord: post: tags: - dns_methods summary: addTXTRecord description: Adds TXT records. operationId: addTXTRecord parameters: - name: absoluteName in: query description: >- The FQDN of the text record. If you are adding a record in a zone that is linked to a incremental naming policy, you must add a single hash sign (#) at the appropriate location in the FQDN. Depending on the policy order value, the location of the single hash sign varies. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string - name: ttl in: query description: >- The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1. style: form explode: true schema: type: integer format: int64 - name: txt in: query description: The text data for the record. style: form explode: true schema: type: string - name: viewId in: query description: The object ID for the parent view to which the record is being added. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new TXT record. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addView: post: tags: - dns_methods summary: addView description: Adds DNS views. operationId: addView parameters: - name: configurationId in: query description: >- The object ID of the parent configuration in which this DNS view is located. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the view. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DNS view. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addZone: post: tags: - dns_methods summary: addZone description: >- Adds DNS zones. When using addZone, you can use dot (.) characters to create the top-level domain and subzones. operationId: addZone parameters: - name: absoluteName in: query description: >- The complete FQDN of the zone with no trailing dot, for example, example.com. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID for the parent object to which the zone is being added. For top-level domains, the parent object is a DNS view. For sub-zones, the parent object is a top-level domain or DNS zone. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including a flag for deployment, an optional network template association, and user-defined fields in the format: deployable=<true|false>|template=<template id>| <userField>=<userFieldValue> The deployable flag is false by default and is optional. To make the zone deployable, set the deployable flag to true. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DNS zone. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addZoneTemplate: post: tags: - dns_methods summary: addZoneTemplate description: Adds a DNS zone template. operationId: addZoneTemplate parameters: - name: name in: query description: The name of the DNS zone template. This value can be an empty string (""). style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent DNS view if adding a view-level zone template. The object ID of the configuration if adding a configuration-level zone template. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new DNS zone template. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/deleteDNSDeploymentOption: delete: tags: - dns_methods summary: deleteDNSDeploymentOption description: Deletes DNS options. operationId: deleteDNSDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which the deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DNS option being deleted. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which the option is assigned. To delete an option that has not been assigned to a server role, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteResponsePolicyItem: delete: tags: - dns_methods summary: deleteResponsePolicyItem description: >- Deletes a DNS response policy item under a specified local DNS response policy. operationId: deleteResponsePolicyItem parameters: - name: itemName in: query description: >- The FQDN of the response policy item. When deleting a response policy item, the exact FQDN of the response policy item must be used. style: form explode: true schema: type: string - name: options in: query description: Reserved for future use. style: form explode: true schema: type: array items: type: string - name: policyId in: query description: >- The object ID of the parent local response policy to which the response policy item is being deleted. style: form explode: true schema: type: integer format: int64 responses: '204': description: Returns 1 if the response policy item is successfully deleted and 0 if the response policy item does not exist. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/findResponsePoliciesWithItem: get: tags: - dns_methods summary: findResponsePoliciesWithItem description: Finds local DNS response policies with their associated response policy items. operationId: findResponsePoliciesWithItem parameters: - name: configurationId in: query description: >- The object ID of the configuration to which the local response policies are located.

To view a complete list of all local response policies under all configurations that have an associated response policy item, set the value of this parameter to 0.

style: form explode: true schema: type: integer format: int64 - name: itemName in: query description: >- The FQDN of the response policy item. The exact FQDN of the response policy item must be used when conducting a search. style: form explode: true schema: type: string - name: options in: query description: Reserved for future use. style: form explode: true schema: type: array items: type: string responses: '201': description: Returns a list of local response policies along with the associated response policy item under a specific configuration or all configurations. This is determined by the input provided for the configurationId parameter. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDNSDeploymentOption: get: tags: - dns_methods summary: getDNSDeploymentOption description: >- Retrieves all DNS options assigned for the object specified excluding the options inherited from the higher-level parent object. operationId: getDNSDeploymentOption parameters: - name: entityId in: query description: The object ID for the entity to which this deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: name in: query description: >- The name of the DNS option. This name must be one of the constants listed in . style: form explode: true schema: type: string - name: serverId in: query description: >- Specifies the server or server group to which this option is assigned. To retrieve an option that has not been assigned to a server role, set this value to 0 (zero). Omitting this parameter from the method call will result in an error. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an instance of the type APIDeploymentOption that represents the DNS deployment option or empty if none were found. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentOption' - description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. deprecated: false /v1/getHostRecordsByHint: get: tags: - dns_methods summary: getHostRecordsByHint description: Returns an array of objects with host record type. operationId: getHostRecordsByHint parameters: - name: count in: query description: >- Indicates the maximum of child objects that this method will return. The value must be less than or equal to 10. style: form explode: true schema: type: integer format: int32 - name: options in: query description: >- A string containing options. The supported options are hint and retrieveFields. Separate multiple options with a pipe character. For example: hint=^abc|retrieveFields=false If the hint option is not specified in the string, searching criteria will be based on the same as zone host record. The following wildcards are supported in the hint option.
  • ^ —matches the beginning of a string. For example: ^ex matches ex ample but not t ex t.
  • $ —matches the end of a string. For example: ple$ matches exam ple but not ple ase.
  • ^ $ —matches the exact characters between the two wildcards. For example: ^example$ only matches example.
  • ? —matches any one character. For example: ex?t matches exit.
  • * —matches one or more characters within a string. For example: ex*t matches exit and ex cellen t.
The default value for the retrieveFields option is set to false. If the option is set to true, user-defined field will be returned. If the options string does not contain retrieveFields, user-defined field will not be returned. style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of host record APIEntity objects. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getKSK: get: tags: - dns_methods summary: getKSK description: >- Returns a string containing all active Key Signing Keys (KSK) for a given entityId value in a specified output format with its start time and expire time, divided by a delimiter (|). The list of returned KSKs is sorted in descending order by expiry date. operationId: getKSK parameters: - name: entityId in: query description: >- The object ID of the entity associated with the KSK. The only supported entity types are zone, IPv4 block, and IPv4 network. style: form explode: true schema: type: integer format: int64 - name: format in: query description: >- The output format of the KSK of an entity. The value must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns a string containing up to two active KSK(s) of an entity. headers: {} content: application/json: schema: type: array items: type: string description: '' deprecated: false /v1/getNetworkLinkedProperties: get: tags: - dns_methods summary: getNetworkLinkedProperties description: >- Returns an array of IP addresses with linked records and the IP addresses that are assigned as DHCP Reserved, Static, or Gateway. operationId: getNetworkLinkedProperties parameters: - name: networkId in: query description: The object ID for the IPv4 network. style: form explode: true schema: type: integer format: int64 responses: '200': description: 'Returns an array of IP address APIEntity objects with their linked host records and the IP addresses that are assigned as DHCP Reserved, Static or Gateway. The output has the following format: hostId : hostName : zoneId : zoneName : viewId : viewName : hasAlias;.' headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getZonesByHint: get: tags: - dns_methods summary: getZonesByHint description: >- Returns an array of accessible zones of child objects for a given containerId value. operationId: getZonesByHint parameters: - name: containerId in: query description: >- The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object can be the configuration level. style: form explode: true schema: type: integer format: int64 - name: count in: query description: >- Indicates the maximum number of child objects that this method will return. The maximum number of child objects cannot exceed more than 10. style: form explode: true schema: type: integer format: int32 - name: options in: query description: >- A string containing options. The Option names available in the ObjectProperties are ObjectProperties.hint, ObjectProperties.accessRight, and ObjectProperties.overrideType. Multiple options can be separated by a pipe character. For example: hint=ab|overrideType=HostRecord|accessRight=ADD The values for ObjectProperties.hint option can be the prefix of a zone name. For example: String options = ObjectProperties.hint + "=abc|" The values for the ObjectProperties.accessRight and ObjectProperties.overrideType options must be one of the constants listed in and . For example: String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess + "|"+ ObjectProperties.overrideType + "=" + ObjectTypes.HostRecord; style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of zones based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/moveResourceRecord: put: tags: - dns_methods summary: moveResourceRecord description: Moves resource records between different zones that already exist. operationId: moveResourceRecord parameters: - name: destinationZone in: query description: >- Fully qualified domain name of the destination DNS zone to which the resource record will be moved. style: form explode: true schema: type: string - name: resourceRecordId in: query description: The object ID of the resource record to be moved. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/searchResponsePolicyItems: get: tags: - dns_methods summary: searchResponsePolicyItems description: >- Searches Response Policy items configured in local Response Policies or predefined BlueCat Security feed data. The search will return a list of all matching items in Address Manager across all configurations. operationId: searchResponsePolicyItems parameters: - name: count in: query description: >- The total number of results to be returned. The possible value is a positive integer ranging from 1 to 1000. style: form explode: true schema: type: integer format: int32 - name: keyword in: query description: >- The search string for which you wish to search.
  • ^ —matches the beginning of a string. For example: ^ex matches ex ample but not t ex t.
  • $ —matches the end of string. For example: ple$ matches exam ple but not ple ase.
  • * —matches zero or more characters within a string. For example: ex*t matches exit and ex cellen t.
style: form explode: true schema: type: string - name: properties in: query description: Reserved for future use. Use an empty string "" for now. style: form explode: true schema: type: string - name: scope in: query description: >- The scope in which the search is to be performed. The possible values are:
  • RPItemSearchScope.LOCAL —to search policy items configured in local Response Policies.
  • RPItemSearchScope.FEED —to search policy items configured in predefined BlueCat Security Feed data.
  • RPItemSearchScope.ALL —to search policy items configured in both local Response Policies and predefined BlueCat Security Feed data.
style: form explode: true schema: type: string - name: start in: query description: >- A starting number from where the search result will be returned. The possible value is a positive integer ranging from 0 to 999. For example, specifying 99 will return the search result from the 100th result to the maximum number that you specify with the count option. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of ResponsePolicySearchResult objects. Each object contains information of one Response Policy item found either in local Response Policies or BlueCat Security feed data. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ResponsePolicySearchResult' description: '' deprecated: false /v1/updateDNSDeploymentOption: put: tags: - dns_methods summary: updateDNSDeploymentOption description: Updates DNS options. operationId: updateDNSDeploymentOption parameters: [] requestBody: description: >- The object ID of the DNS option to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDNSDeploymentOptionRequest' - description: >- The object ID of the DNS option to be updated. Depending on the type of deployment option being updated, the format of the value might differ. For more information, refer to . example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/uploadResponsePolicyItems: post: tags: - dns_methods summary: uploadResponsePolicyItems description: >- Uploads one response policy file containing a list of fully qualified domain names (FQDNs). operationId: uploadResponsePolicyItems parameters: - name: parentId in: query description: >- The object ID of the parent response policy under which the response policy item file is being uploaded. style: form explode: true schema: type: integer format: int64 requestBody: content: multipart/form-data: encoding: {} schema: type: object properties: inputStream: type: string description: >- The file to be uploaded under the response policy. This file is passed to Address Manager as a byte array. This actual file size should be no more than 75 MB. format: binary body: type: string format: binary required: false responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/addRawDeploymentOption: post: tags: - generic_deployment_option_methods summary: addRawDeploymentOption description: >- Adds raw deployment options. Raw deployment options are added to DNS or DHCP services in a format that will be passed to the service when deployed. The SOAP version of this API has a different signature than the REST version. operationId: addRawDeploymentOption parameters: - name: parentId in: query description: The object ID for the entity to which you are adding the deployment option. style: form explode: true schema: type: integer format: int64 requestBody: description: >- Object containing information about the raw deployment option:
  • type - The type of option. The type must be one of the following values:
    • DNS_RAW
    • DHCP_RAW
    • DHCPV6_RAW
  • value -the raw option value. The maximum supported characters are 65,536. The raw option will be passed to the DNS or DHCP service on the managed server exactly as you enter here. Therefore, it is essential that you enter the data with the correct syntax.
  • properties -adds object properties, including associated server and server group, and user-defined fields.
content: application/json: schema: allOf: - $ref: '#/components/schemas/V1AddRawDeploymentOptionRequest' - description: >- Object containing information about the raw deployment option:
  • type - The type of option. The type must be one of the following values:
    • DNS_RAW
    • DHCP_RAW
    • DHCPV6_RAW
  • value -the raw option value. The maximum supported characters are 65,536. The raw option will be passed to the DNS or DHCP service on the managed server exactly as you enter here. Therefore, it is essential that you enter the data with the correct syntax.
  • properties -adds object properties, including associated server and server group, and user-defined fields.
example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '201': description: Returns the object ID for the newly added Raw option. headers: {} content: application/json: schema: type: number format: double application/xml: schema: type: number format: double xml: name: response attribute: false wrapped: false deprecated: false /v1/getDeploymentOptions: get: tags: - generic_deployment_option_methods summary: getDeploymentOptions description: Retrieves deployment options for Address Manager DNS and DHCP services. operationId: getDeploymentOptions parameters: - name: entityId in: query description: >- The object ID of the entity to which the DNS or DHCP deployment option is assigned. style: form explode: true schema: type: integer format: int64 - name: optionTypes in: query description: >- The type of deployment options. Multiple options can be separated by a | (pipe) character. This value must be one of the following items:
  • DNSOption
  • DNSRawOption
  • DHCPRawOption
  • DHCPV6RawOption
  • DHCPV4ClientOption
  • DHCPV6ClientOption
  • DHCPServiceOption
  • DHCPV6ServiceOption
  • VendorClientOption
  • StartOfAuthority
For complete list of Option Types and Object Types constants, refer to and .
  • If Invalid deployment option types or invalid strings are specified, the API execution will fail and return the error message: " Invalid deployment option found ". For example, if the user passes DHCPv6ClientOption for IPv4 networks, it will return this error message as DHCPv6 client options are not a valid for IPv4 networks.
  • If specified as an empty string "", all deployment options for the specified entity will be returned.
  • Depending on the type of DNS deployment option being retrieved, the format of the value might differ. For more information, refer to .
style: form explode: true schema: type: string - name: serverId in: query description: >- The specific server or server group to which options are deployed. The valid values are as follows:
  • >0 —returns only the options that are linked to the specified server ID.
  • <0 —returns all options regardless of the server ID specified.
  • =0 —returns only the options that are linked to all servers.
style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all deployment options assigned to the specified object including inherited options from higher level parent objects. If an option is inherited and overridden, then only the overriding option will be returned. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIDeploymentOption' description: '' deprecated: false /v1/updateRawDeploymentOption: put: tags: - generic_deployment_option_methods summary: updateRawDeploymentOption description: Updates raw deployment options. operationId: updateRawDeploymentOption parameters: [] requestBody: description: The DNS or DHCP raw option object to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateRawDeploymentOptionRequest' - description: The DNS or DHCP raw option object to be updated. example: id: 12345 type: '...' name: '...' value: '...' properties: '...' example: id: 12345 type: '...' name: '...' value: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/addEntity: post: tags: - generic_methods summary: addEntity description: >- A generic method for adding configurations, DNS zones, and DNS resource records. operationId: addEntity parameters: - name: parentId in: query description: >- The parent ID of the new entity. For configurations, always set the parentId value to 0 zero, which is the root element. style: form explode: true schema: type: integer format: int64 requestBody: description: >- The object configuration, including its name, sharedNetwork, and user-defined fields. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1AddEntityRequest' - description: >- The object configuration, including its name, sharedNetwork, and user-defined fields. example: id: 12345 name: '...' type: '...' properties: '...' example: id: 12345 name: '...' type: '...' properties: '...' required: false responses: '200': description: Returns the object ID of the newly created entity. headers: {} content: application/json: schema: type: number format: double application/xml: schema: type: number format: double xml: name: response attribute: false wrapped: false deprecated: false /v1/assignOrUpdateTemplate: post: tags: - generic_methods summary: assignOrUpdateTemplate description: Assigns, updates, or removes DNS zone and IPv4 network templates. operationId: assignOrUpdateTemplate parameters: - name: entityId in: query description: >- The object ID of the IPv4 network to which the network template is to be assigned or updated, or the object ID of the zone to which the zone template is to be assigned or updated. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing the following settings:
  • ObjectProperties.templateType —Specifies the type of template on which this operation is being performed.

    The possible values are ObjectProperties.IP4NetworkTemplateType Assigning or updating IP4NetworkTemplate on an IP4Network and ObjectProperties.zoneTemplateType Assigning or updating zoneTemplate on a DNS zone. This is mandatory.

Along with ObjectProperties.templateType, user can also specify the reapply mode for various properties of the template.

  • For Network template, the following additional parameters can also be specified:
    • ObjectProperties.gatewayReapplyMode
    • ObjectProperties.reservedAddressesReapplyMode
    • ObjectProperties.dhcpRangesReapplyMode
    • ObjectProperties.ipGroupsReapplyMode
    • ObjectProperties.optionsReapplyMode
  • For Zone Template, the following additional parameter can also be specified:
    • ObjectProperties.zoneTemplateReapplyMode
    The possible values for re-apply mode properties are:
    • ObjectProperties.templateReapplyModeUpdate
    • ObjectProperties.templateReapplyModeIgnore
    • ObjectProperties.templateReapplyModeOverwrite
    If the re-apply mode is not specified in the properties, the default ObjectProperties.templateReapplyModeIgnoremode is used.
If you are not using Java or Perl, refer to for the actual values.

style: form explode: true schema: type: string - name: templateId in: query description: >- The object ID of the DNS zone template or IPv4 network template. To remove a template, set this value to zero. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/customSearch: get: tags: - generic_methods summary: customSearch description: Search for an array of entities by specifying object properties. operationId: customSearch parameters: - name: count in: query description: >- The maximum number of objects to return. The value must be a positive value between 1 and 1000. style: form explode: true schema: type: integer format: int32 - name: filters in: query description: >- The list of properties on which the search will be based. The valid format is Field name=value. Refer to for details. The field name is case-sensitive.

In addition to the fields that are specified in the table, any user-defined fields will also be supported. The valid format for the Date type user-defined field value is DD-MMM-YYYY. You can also use partial formatting. For example, 10-Jan-2016, 10-Jan, Jan-2016 or 2016.

style: form explode: true schema: type: array items: type: string - name: options in: query description: >- The list of search options specifying the search behavior. Reserved for future use. style: form explode: true schema: type: array items: type: string - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The value must be a positive value. style: form explode: true schema: type: integer format: int32 - name: type in: query description: >- The object type that you wish to search. This must be one for the following object types:
  • IP4Block
  • IP4Network
  • IP4Addr
  • GenericRecord
  • HostRecord
  • Any other objects with user-defined fields
style: form explode: true schema: type: string responses: '200': description: Returns an array of APIEntities matching the specified object properties or returns an empty array. The APIEntity will at least contain Object Type, Object ID, Object Name, and Object Properties. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/delete: delete: tags: - generic_methods summary: delete description: Deletes an object using the generic delete method. operationId: delete parameters: - name: objectId in: query description: The ID for the object to be deleted. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. Object has been deleted. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteWithOptions: delete: tags: - generic_methods summary: deleteWithOptions description: >- Deletes objects that have options associated with their removal. When deleting dynamic resource records, you can choose not to dynamically deploy the changes to the DNS/DHCP Server. operationId: deleteWithOptions parameters: - name: objectId in: query description: The ID for the object to be deleted. style: form explode: true schema: type: integer format: int64 - name: options in: query description: >- A string containing the following delete options:
  • noServerUpdate —a Boolean value. This applies to the dynamic resource records. Set to true to update the record only in the Address Manager web interface. The change will not be deployed to the DNS server. The default value is false.
  • deleteOrphanedIPAddresses —a Boolean value. This applies to the delete operation on Host Records. Set to true to free IP addresses associated with a host record if no other host records are associated with the IP address. The default value is false.
style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/getEntities: get: tags: - generic_methods summary: getEntities description: Returns multiple entities for the specified parent ID. operationId: getEntities parameters: - name: count in: query description: Indicates the maximum number of child objects to return. style: form explode: true schema: type: integer format: int32 - name: parentId in: query description: The object ID of the parent object of the entities. style: form explode: true schema: type: integer format: int64 - name: start in: query description: Indicates where in the list of child objects to start returning entities. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: type in: query description: >- The type of object to be returned. This value must be one of the object types listed in . style: form explode: true schema: type: string responses: '200': description: Returns an array of entities. The array is empty if there are no matching entities. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getEntitiesByName: get: tags: - generic_methods summary: getEntitiesByName description: >- Returns an array of entities that match the specified parent, name, and object type. operationId: getEntitiesByName parameters: - name: count in: query description: The maximum number of objects to return. The default value is 10. style: form explode: true schema: type: integer format: int32 - name: name in: query description: The name of the entity. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the parent object of the entities to be returned. style: form explode: true schema: type: integer format: int64 - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: type in: query description: >- The type of object to be returned. This value must be one of the object types listed in . style: form explode: true schema: type: string responses: '200': description: Returns an array of entities. The array is empty if there are no matching entities. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getEntitiesByNameUsingOptions: get: tags: - generic_methods summary: getEntitiesByNameUsingOptions description: >- Returns an array of entities that match the specified name and object type. Searching behavior can be changed by using the options. operationId: getEntitiesByNameUsingOptions parameters: - name: count in: query description: The maximum number of objects to return. The default value is 10. style: form explode: true schema: type: integer format: int32 - name: name in: query description: The name of the entity. style: form explode: true schema: type: string - name: options in: query description: >- A string containing options. Currently the only available option is ObjectProperties.ignoreCase. By default, the value is set to false. Setting this option to true will ignore the case-sensitivity used while searching entities by name.

ObjectProperties.ignoreCase = [true | false]

style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the parent object of the entities to be returned. style: form explode: true schema: type: integer format: int64 - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: type in: query description: >- The type of object to be returned. This value must be one of the object types listed in . style: form explode: true schema: type: string responses: '200': description: Returns an array of entities. The array is empty if there are no matching entities. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getEntityByCIDR: get: tags: - generic_methods summary: getEntityByCIDR description: >- Returns an IPv4 Network object from the database by calling it using CIDR notation. operationId: getEntityByCIDR parameters: - name: cidr in: query description: CIDR notation defining the network for example, 10.10.10/24. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the network’s parent object. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of object returned: IP4Network. This must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns the specified IPv4 block object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getEntityById: get: tags: - generic_methods summary: getEntityById description: >- Returns objects from the database referenced by their database ID and with its properties fields populated. For more information about the available options, refer to in the section. operationId: getEntityById parameters: - name: id in: query description: The object ID of the target object. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the requested object from the database with its properties fields populated. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getEntityByName: get: tags: - generic_methods summary: getEntityByName description: Returns objects from the database referenced by their name field. operationId: getEntityByName parameters: - name: name in: query description: The name of the target object. style: form explode: true schema: type: string - name: parentId in: query description: The ID of the target object’s parent object. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of object returned by the method. This string must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns an array of entities. The array is empty if there are no matching entities. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getEntityByPrefix: get: tags: - generic_methods summary: getEntityByPrefix description: Returns an APIEntity for the specified IP block or network. operationId: getEntityByPrefix parameters: - name: containerId in: query description: >- The object ID of higher-level parent object IP block or configuration in which the IP block or network is located. style: form explode: true schema: type: integer format: int64 - name: prefix in: query description: The prefix value for the IP block or network. style: form explode: true schema: type: string - name: type in: query description: >- The type of object to be returned. This string must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns an APIEntity for the specified IPv6 block or network. The APIEntity is empty if the block or network does not exist. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getEntityByRange: get: tags: - generic_methods summary: getEntityByRange description: Returns an IPv4 DHCP range object by calling it using its range. operationId: getEntityByRange parameters: - name: address1 in: query description: An IP address defining the lowest address or start of the range. style: form explode: true schema: type: string - name: address2 in: query description: An IP address defining the highest address or end of the range. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the parent object of the DHCP range. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of object returned: DHCP4Range. This must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns the requested IPv4 block object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getLinkedEntities: get: tags: - generic_methods summary: getLinkedEntities description: >- Returns an array of entities containing the entities linked to a specified entity. The array is empty if there are no linked entities. operationId: getLinkedEntities parameters: - name: count in: query description: The maximum number of objects to return. style: form explode: true schema: type: integer format: int32 - name: entityId in: query description: The object ID of the entity for which to return linked entities. style: form explode: true schema: type: integer format: int64 - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: type in: query description: >- The type of linked entities which need to be returned. This value must be one of the types listed in .
  • While specifying a resource record as the entityId, if you want to find all the records CNAME, MX, or SRV records having links to this record, you can use RecordWithLink for the type parameter.
  • When specifying a MAC address as the entityId, this method returns the IPv4 address associated with the MAC address. When appropriate, leaseTimeand expiryTimeinformation also appears in the returned properties string.
 style: form explode: true schema: type: string responses: '200': description: Returns an array of entities. The array is empty if there are no linked entities. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getParent: get: tags: - generic_methods summary: getParent description: Returns the parent entity of a given entity. operationId: getParent parameters: - name: entityId in: query description: The entity ID of the parent object. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the APIEntity for the parent entity with its properties fields populated. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getSystemInfo: get: tags: - generic_methods summary: getSystemInfo description: Gets Address Manager system information. operationId: getSystemInfo parameters: [] responses: '200': description: Returns Address Manager system information. headers: {} content: application/json: schema: type: string application/xml: schema: type: string xml: name: response attribute: false wrapped: false deprecated: false /v1/linkEntities: put: tags: - generic_methods summary: linkEntities description: Establishes a link between two specified Address Manager entities. operationId: linkEntities parameters: - name: entity1Id in: query description: The object ID of the first entity in the pair of linked entities. style: form explode: true schema: type: integer format: int64 - name: entity2Id in: query description: The object ID of the second entity in the pair of linked entities. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/login: get: tags: - generic_methods summary: login description: >- Logs in as API user. You must use an API user account to access the Address Manager API. operationId: login parameters: - name: password in: query description: The password for the API user logging into Address Manager. style: form explode: true schema: type: string - name: username in: query description: >- The username for the API user created using the Address Manager user interface. style: form explode: true schema: type: string responses: '200': description: Returns the API authorization token. headers: {} content: application/json: schema: type: string application/xml: schema: type: string xml: name: response attribute: false wrapped: false deprecated: false /v1/loginWithOptions: get: tags: - generic_methods summary: loginWithOptions description: >- Logs in as an API user with the option to change the locale to Japanese or Simplified Chinese. Changing locale only affects the behavior of the getUserDefinedFields and updateBulkUdf methods. operationId: loginWithOptions parameters: - name: options in: query description: >- You can use one of the following options:
  • locale=ja-JA
  • locale=zh-CN
style: form explode: true schema: type: string - name: password in: query description: The password for the API user logging into Address Manager. style: form explode: true schema: type: string - name: username in: query description: >- The username for the API user created using the Address Manager user interface. style: form explode: true schema: type: string responses: '200': description: Returns the API authorization token. headers: {} content: application/json: schema: type: string application/xml: schema: type: string xml: name: response attribute: false wrapped: false deprecated: false /v1/logout: get: tags: - generic_methods summary: logout description: >- Logs out of the current API session. Once you have logged out, you must log in again to execute new API calls. operationId: logout parameters: [] responses: '200': description: Returns a message stating that you have successfully logged out. headers: {} content: application/json: schema: type: string application/xml: schema: type: string xml: name: response attribute: false wrapped: false deprecated: false /v1/searchByCategory: get: tags: - generic_methods summary: searchByCategory description: >- Returns an array of entities by searching for keywords associated with objects of a specified object category. operationId: searchByCategory parameters: - name: category in: query description: >- The entity category to be searched. This must be one of the entity categories listed in . style: form explode: true schema: type: string - name: count in: query description: The maximum number of objects to return. The default value is 10. style: form explode: true schema: type: integer format: int32 - name: keyword in: query description: The search keyword string. style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of entities matching the keyword text and the category type, or returns an empty array. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/searchByObjectTypes: get: tags: - generic_methods summary: searchByObjectTypes description: >- Returns an array of entities by searching for keywords associated with objects of a specified object type. You can search for multiple object types with a single method call. operationId: searchByObjectTypes parameters: - name: count in: query description: The maximum number of objects to return. The default value is 10. style: form explode: true schema: type: integer format: int32 - name: keyword in: query description: The search keyword string. style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 - name: types in: query description: >- The object types for which to search, specified in the format: "type1[,type2…]" The object type must be one of the types listed in . style: form explode: true schema: type: string responses: '200': description: Returns an array of entities matching the keyword text and the category type, or returns an empty array. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/unlinkEntities: put: tags: - generic_methods summary: unlinkEntities description: Removes the link between two specified Address Manager entities. operationId: unlinkEntities parameters: - name: entity1Id in: query description: The object ID of the first entity in the pair of linked entities. style: form explode: true schema: type: integer format: int64 - name: entity2Id in: query description: The object ID of the second entity in the pair of linked entities. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/update: put: tags: - generic_methods summary: update description: >- Updates entity objects. If you are updating the state of an IPv4 address, use the API method. operationId: update parameters: [] requestBody: description: >- The actual API entity passed as an entire object that has its mutable values updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateRequest' - description: >- The actual API entity passed as an entire object that has its mutable values updated. example: id: 12345 name: '...' type: '...' properties: '...' example: id: 12345 name: '...' type: '...' properties: '...' required: false responses: '204': description: None. Object has been updated. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateWithOptions: put: tags: - generic_methods summary: updateWithOptions description: >- Updates objects requiring a certain behavior that is not covered by the regular update method. This method only applies to CNAME, MX, and SRV records. operationId: updateWithOptions parameters: - name: options in: query description: >- A string containing the update options. Currently, only one option is supported: linkToExternalHost=boolean. If true, update will search for the external host record specified in linkedRecordName even if a host record with the same exists under the same DNS View. If the external host record is not present, it will throw an exception. If false, update will search for the host record specified in linkedRecordName. style: form explode: true schema: type: string requestBody: description: The actual API entity to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateWithOptionsRequest' - description: The actual API entity to be updated. example: id: 12345 name: '...' type: '...' properties: '...' example: id: 12345 name: '...' type: '...' properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/addAdditionalIPAddresses: post: tags: - ipam_methods summary: addAdditionalIPAddresses description: >- Adds additional IPv4 addresses and loopback addresses to the Services interface for DNS service. operationId: addAdditionalIPAddresses parameters: - name: ipsToAdd in: query description: >- The list of IP addresses you wish to add. You can specify multiple IP addresses with a separator. The supported format is [IP,serviceType|IP,serviceType]. For example, 10.0.0.10/32,loopback|11.0.0.3/24,service|12.0.0.3,loopback. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties. Currently there are no supported properties; this is reserved for future use. style: form explode: true schema: type: string - name: serverId in: query description: The database object ID of the server to which you will add the additional IP addresses. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/addDeviceInstance: post: tags: - ipam_methods summary: addDeviceInstance description: >- Adds a device instance. Use this method to provision new devices for the network. This method combines a number of existing API methods into one:
  • It assigns the next available, or manually defined, IP address.
  • It optionally adds a DNS host record and MAC address that are linked to the IP address.
  • It returns the property string containing the IP address, netmask, and gateway.
When configured with a DNS host record, addDeviceInstance updates the DNS server to immediately deploy the host record. operationId: addDeviceInstance parameters: - name: configName in: query description: >- Name of parent configuration. If the value is empty or cannot be found, an exception will be thrown. style: form explode: true schema: type: string - name: deviceName in: query description: IP address or device name of the new instance. This is reserved for future use. style: form explode: true schema: type: string - name: ipAddressMode in: query description: >- Accepted values are:
  • REQUEST_STATIC — Use to get the next available static IP address.
  • REQUEST_DHCP_RESERVED - Use to get the next available DHCP reserved IP address (reserved for future use).
  • PASS_VALUE - use to pass an existing IP address. Metadata values will only be updated to the newly assigned IP address only.
style: form explode: true schema: type: string - name: ipEntity in: query description: >- If ipAddressMode is REQUEST_STATIC or REQUEST_DHCP_RESERVED, this must be the network where the IP address will be provisioned from in the format of an IP address range in CIDR format or range.

If ipAddressMode is PASS_VALUE, this must be an IP address.

style: form explode: true schema: type: string - name: macAddressMode in: query description: >- Accepted values are:
  • REQUEST_VALUE - Reserved for future use.
  • PASS_VALUE - Use to manually provide the MAC address linked to the IP address.

If you specify an empty string, the MACEntity parameter will be ignored.

style: form explode: true schema: type: string - name: macEntity in: query description: >- If macAddressMode is PASS_VALUE, this must be a MAC address. If macAddressMode is REQUEST_VALUE, this is a MAC mask. style: form explode: true schema: type: string - name: options in: query description: >- The options string contains four properties: skip, offset, excludeDHCPRange, and allowDuplicateHosts.
  • skip —this is optional. It is applied to REQUEST_STATIC and REQUEST_DHCP_RESERVED for ipAddressMode. It is used to specify the IP address ranges or IP addresses to skip, separated by comma. A hyphen (–), not a dash (-), is used to separate the start and end addresses.
  • offset —this is optional. It is applied to REQUEST_VALUE for ipAddressMode. This is to specify from which address to start to assign IPv4 Address.
  • excludeDHCPRange —this specifies whether IP addresses in DHCP ranges should be excluded from assignment or not. It is applied to REQUEST_STATIC only for ipAddressMode. The value is either true or false; the default value is false. The value will always be set to true if the ipAddressMode is REQUEST_DHCP_RESERVED.
  • allowDuplicateHosts —this specifies whether the IP address can be added to an existing host record or not. The value is either true or false; the default value is false.
  • staticHost —specifies whether a static host or a dynamic host is created. The value is either true or false; the default value if false. The value “true” creates a dynamic host and the value “false” creates a static host.
The values for skip and offset must be IPv4 addresses and must appear in dotted octet notation. style: form explode: true schema: type: string - name: recordName in: query description: >- Name of the host record to add. This cannot be empty if both viewName and zoneName are specified and in use. The viewName, zoneName, and recordName parameters must be used together: the values must all be an empty string, or they must all be populated with specific values. If all three parameter values are an empty string, DNS objects will not be created but an IP address will be assigned from a network and linked to a MAC address. style: form explode: true schema: type: string - name: viewName in: query description: >- Name of parent view. Specify an empty string ("") for all viewName, zoneName, and recordName parameters to ignore DNS object creation. style: form explode: true schema: type: string - name: zoneName in: query description: >- Parent zone of the record. This must be specified and existing if the viewName parameter is an empty string and existing. Specify an empty string for all viewName, zoneName and recordName parameters to ignore DNS object creation. style: form explode: true schema: type: string responses: '201': description: Returns the property string containing IP address, netmask, and gateway. headers: {} content: application/json: schema: type: string deprecated: false /v1/addIP4BlockByCIDR: post: tags: - ipam_methods summary: addIP4BlockByCIDR description: Adds a new IPv4 Block using CIDR notation. operationId: addIP4BlockByCIDR parameters: - name: CIDR in: query description: The CIDR notation defining the block, for example, 10.10/16. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the target object’s parent object. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing options. For more information about the available options, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new IPv4 block. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4BlockByRange: post: tags: - ipam_methods summary: addIP4BlockByRange description: Adds a new IPv4 block defined by an address range. operationId: addIP4BlockByRange parameters: - name: end in: query description: An IP address defining the highest address or end of the block. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the target object’s parent object. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing options. For more information about the available options, refer to . style: form explode: true schema: type: string - name: start in: query description: An IP address defining the lowest address or start of the block. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new IPv4 block. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4IPGroupByRange: post: tags: - ipam_methods summary: addIP4IPGroupByRange description: Adds an IPv4 IP group by range bounds (start address and end address). operationId: addIP4IPGroupByRange parameters: - name: end in: query description: An end IP address of the IP group range. style: form explode: true schema: type: string - name: name in: query description: The name of the IP group. style: form explode: true schema: type: string - name: parentId in: query description: The object ID for the network where you wish to add the IP group. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including the user-defined fields. style: form explode: true schema: type: string - name: start in: query description: A start IP address of the IP group range. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new IPv4 IP group range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4IPGroupBySize: post: tags: - ipam_methods summary: addIP4IPGroupBySize description: Adds an IPv4 IP group by size. operationId: addIP4IPGroupBySize parameters: - name: name in: query description: The name of the IP group. style: form explode: true schema: type: string - name: parentId in: query description: The object ID for the network where you wish to add the IP group. style: form explode: true schema: type: integer format: int64 - name: positionRangeBy in: query description: >- A string specifying the position of the IP group range in the parent network. The value must be one of the constants listed in . This is optional. If specified, you must provide positionValue. style: form explode: true schema: type: string - name: positionValue in: query description: >- The offset value when using positionRangeBy.START_OFFSET or positionRangeBy.END_OFFSET. The start address of the IP group in the network when using positionRangeBy.START_ADDRESS. This is required only if you specify positionRangeBy. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: size in: query description: The number of addresses in the IP group. style: form explode: true schema: type: integer format: int32 responses: '201': description: Returns the object ID for the new IPv4 IP group range. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4Network: post: tags: - ipam_methods summary: addIP4Network description: Adds an IPv4 network using CIDR notation. operationId: addIP4Network parameters: - name: CIDR in: query description: The CIDR notation defining the network, for example, 10.10.10/24. style: form explode: true schema: type: string - name: blockId in: query description: The object ID of the new network’s parent IPv4 block. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing options. For more information about the available options, refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new IPv4 network. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4NetworkTemplate: post: tags: - ipam_methods summary: addIP4NetworkTemplate description: Add an IPv4 network template to the specified configuration. operationId: addIP4NetworkTemplate parameters: - name: configurationId in: query description: The object ID of the configuration where you wish to add the IPv4 template. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the IPv4 network template. style: form explode: true schema: type: string - name: properties in: query description: >- A string defining the IPv4 network template properties. For example, gateway=[gateway_offset]| reservedAddresses={type,definedBy, offset,size,direction,name,splitStaticAddresses} Refer to . style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new IPv4 network template. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP4ReconciliationPolicy: post: tags: - ipam_methods summary: addIP4ReconciliationPolicy description: Adds an IPv4 reconciliation policy. operationId: addIP4ReconciliationPolicy parameters: - name: name in: query description: The name of the policy. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent network of the policy. You can create IPv4 reconciliation policies at the configuration, IPv4 block, and IPv4 network levels. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing properties and values listed in . style: form explode: true schema: type: string responses: '201': description: Adds an IPv4 reconciliation policy. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP6Address: post: tags: - ipam_methods summary: addIP6Address description: Adds an IPv6 address to a specified IPv6 network. operationId: addIP6Address parameters: - name: address in: query description: >- The IPv6 address you wish to add. address and type must be consistent. For example, if the type is ObjectTypes.IP6Address, the address must be a string representing an IPv6 address. style: form explode: true schema: type: string - name: containerId in: query description: >- The object ID of the container where you wish to add the IPv6 address. This can be the object ID of a configuration, IPv6 block, or IPv6 network. The parent IPv6 network object must exist before you add an IPv6 address, otherwise an error will occur. style: form explode: true schema: type: integer format: int64 - name: name in: query description: Descriptive name for the IPv6 address. This value can be empty. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: type in: query description: >- The type of IPv6 address. This value must be one of the following: macAddress, IP6Address, or InterfaceID. As with the address parameter, address and type must be consistent. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new IPv6 address. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP6BlockByMACAddress: post: tags: - ipam_methods summary: addIP6BlockByMACAddress description: Adds an IPv6 block by specifying the MAC address of the server. operationId: addIP6BlockByMACAddress parameters: - name: macAddress in: query description: >- The MAC address of the server in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: name in: query description: Descriptive name for the IPv6 block. This value can be empty. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent object of the new IPv6 block. The parent object must be another IPv6 block. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. This value can be empty. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new IPv6 block. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP6BlockByPrefix: post: tags: - ipam_methods summary: addIP6BlockByPrefix description: Adds an IPv6 block be specifying the prefix for the block. operationId: addIP6BlockByPrefix parameters: - name: name in: query description: Descriptive name for the IPv6 block. This value can be empty. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent object of the new IPv6 block. The parent object may be a configuration or another IPv6 block. style: form explode: true schema: type: integer format: int64 - name: prefix in: query description: The IPv6 prefix for the new block. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. This value can be empty. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new IPv6 block. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addIP6NetworkByPrefix: post: tags: - ipam_methods summary: addIP6NetworkByPrefix description: Adds an IPv6 network be specifying the prefix for the network. operationId: addIP6NetworkByPrefix parameters: - name: name in: query description: Descriptive name for the IPv6 network. This value can be empty. style: form explode: true schema: type: string - name: parentId in: query description: The object ID of the IPv6 block in which the new IPv6 network will be located. style: form explode: true schema: type: integer format: int64 - name: prefix in: query description: The IPv6 prefix for the new network. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including user-defined fields. This value can be empty. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the new IPv6 network. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addParentBlock: post: tags: - ipam_methods summary: addParentBlock description: >- Adds a parent block. Creates an IPv4 or IPv6 block from a list of IPv4 or IPv6 blocks or networks. All blocks and networks must have the same parent but it does not need to be contiguous. operationId: addParentBlock parameters: [] requestBody: description: An array containing the object IDs of IPv4 or IPv6 blocks or networks. content: application/json: schema: type: array items: type: integer format: int32 description: An array containing the object IDs of IPv4 or IPv6 blocks or networks. required: false responses: '201': description: Returns the object ID for the new IPv4 or IPv6 parent block. This method does not create a name for the new block. headers: {} content: application/json: schema: type: number format: double application/xml: schema: type: number format: double xml: name: response attribute: false wrapped: false deprecated: false /v1/addParentBlockWithProperties: post: tags: - ipam_methods summary: addParentBlockWithProperties description: >- Adds a parent block with properties. Creates an IPv4 or IPv6 block with a name from a list of IPv4 or IPv6 blocks or networks. All blocks and networks must have the same parent but it does not need to be contiguous. operationId: addParentBlockWithProperties parameters: - name: properties in: query description: >- A string containing the following option:
  • name -the name of the new IPv4 or IPv6 block to be created.
style: form explode: true schema: type: string requestBody: description: An array containing the object IDs of IPv4 or IPv6 blocks or networks. content: application/json: schema: type: array items: type: integer format: int32 description: An array containing the object IDs of IPv4 or IPv6 blocks or networks. required: false responses: '201': description: Returns the object ID for the new IPv4 or IPv6 parent block. headers: {} content: application/json: schema: type: number format: double application/xml: schema: type: number format: double xml: name: response attribute: false wrapped: false deprecated: false /v1/applyIP4NetworkTemplate: post: tags: - ipam_methods summary: applyIP4NetworkTemplate description: Applies IPv4 network templates. operationId: applyIP4NetworkTemplate parameters: - name: networkId in: query description: >- The object ID of the IPv4 network. If the value is zero, the template is applied to all networks. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing the following properties and values:
  • applyToNonConflictedNetworksOnly - Boolean value: true or false. If set to true, the template is applied to a non-conflicted network. The default value is false.
  • applyDeploymentOptions - Boolean value: true or false. If set to true, applies deployment options defined from the template to the linked network. The default value is false.
  • applyReservedAddresses - Boolean value: true or false. If set to true, applies the reserved IPv4 addresses defined from the template to the linked network. The default value is false.
  • applyGateway - Boolean value: true or false. If set to true, applies the gateway to the linked network. The default value is false.
  • applyDHCPRanges - Boolean value: true or false. If set to true, applies the DHCP ranges defined from the template to the linked network. The default value is false.
  • applyIPGroups - Boolean value: true or false. If set to true, applies the IP groups defined from the template to the linked network. The default value is false.
  • conflictResolutionOption - ObjectProperties.networkSettings or ObjectProperties.templateSettings. Available only if applyDeploymentOptions is true and applyToNonConflictedNetworksOnly is false. The default value is networkSettings.
  • convertOrphanedIPAddressesTo - ObjectProperties.convertOrphanedIPAddressesTo.

    The possible values are:

    • STATIC
    • DHCP RESERVED Default value
    • UNASSIGNED
      • If the option value is incorrect, the default value is applied.
      • If the option name is incorrect, the option will be ignored. Therefore, orphaned IP addresses will be updated to the default value.
Refer to . style: form explode: true schema: type: string - name: templateId in: query description: The object ID of the IPv4 template. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the task ID of the network template apply task as a string. headers: {} content: application/json: schema: type: string deprecated: false /v1/assignIP4Address: post: tags: - ipam_methods summary: assignIP4Address description: Assigns a MAC address and other properties to an IPv4 address. operationId: assignIP4Address parameters: - name: action in: query description: >- This parameter must be set to one of the constants shown in . style: form explode: true schema: type: string - name: configurationId in: query description: The object ID of the configuration in which the IPv4 address is located. style: form explode: true schema: type: integer format: int64 - name: hostInfo in: query description: >- A string containing host information for the address in the following format: hostname,viewId,reverseFlag,sameAsZoneFlag[, hostname,viewId,reverseFlag,sameAsZoneFlag,...] Where:
  • hostname - The FQDN of the host record to be added.
  • viewId - The object ID of the view under which this host should be created.
  • reverseFlag - The flag indicating if a reverse record should be created. The possible values are true or false.
  • sameAsZoneFlag - The flag indicating if record should be created as same as zone record. The possible values are true or false.

The comma-separated parameters may be repeated in the order shown above. The string must not end with a comma.

style: form explode: true schema: type: string - name: ip4Address in: query description: The IPv4 address. style: form explode: true schema: type: string - name: macAddress in: query description: >- The MAC address to assign to the IPv4 address. The MAC address can be specified in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the following property, including user-defined fields:
  • ptrs —a string containing the list of unmanaged external host records to be associated with the IPv4 address in the format: viewId,exHostFQDN[, viewId,exHostFQDN,...] You can assign External Host records to an IPv4 address using the following method: EntityProperties props = new EntityProperties; props.addProperty ObjectProperties.ptrs, "123,exHostFQDN.com,456,exHostFQDN.net" long addressId = service.assignIP4Address configurationId, IPv4Address, macAddressStr, hostInfo, IPAssignmentActionValues.MAKE_STATIC, props.getPropertiesString;
  • name —name of the IPv4 address.
  • locationCode —the hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1. The code is case-sensitive. It must be all UPPER CASE letters. The country code and child location code should be alphanumeric strings.
  • allowDuplicateHost (optional) —duplicate hostname check option. There are three possible values for this property:
    • Enable—set to enable the property and refuse duplicate hostnames.
    • Disable—set to disable the property and allow duplicate hostnames. Disable is the default value for allowDuplicateHost.
    • Inherit—set to make the hostname use the option specified in the higher-level parent object.
style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the newly assigned IPv4 address. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/assignIP4NetworkTemplate: post: tags: - ipam_methods summary: assignIP4NetworkTemplate description: Assigns IPv4 network templates. operationId: assignIP4NetworkTemplate parameters: - name: networkId in: query description: The object ID of the IPv4 network. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing the following property and value:
  • overrideAssignedTemplate - true or false. If set to true, the previous assigned template is overriden. The default value is false.
Refer to . style: form explode: true schema: type: string - name: templateId in: query description: The object ID of the IPv4 template. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/assignIP6Address: post: tags: - ipam_methods summary: assignIP6Address description: Assigns an IPv6 address to a MAC address and host. operationId: assignIP6Address parameters: - name: action in: query description: >- Determines how to assign the address. Valid values are MAKE_STATIC or MAKE_DHCP_RESERVED. style: form explode: true schema: type: string - name: address in: query description: >- The IPv6 address to be assigned. The address must be created with addIP6Address before it can be assigned. For more information, refer to . The address must be a string representing an IPv6 address. style: form explode: true schema: type: string - name: containerId in: query description: >- The object ID of the container in which the IPv6 address is being assigned. This can be the object ID of a configuration, IPv6 block, or IPv6 network. The parent IPv6 network object must exist before adding an IPv6 address, otherwise an error will occur. style: form explode: true schema: type: integer format: int64 - name: hostInfo in: query description: >- The host information for the IPv6 address. This value can be empty. The hostInfo string uses the following format: viewId, hostname, ifSameAsZone, ifReverseMapping

Where viewId is the object ID of the DNS view; hostname is the name of DNS zone for the address; ifSameAsZone is a Boolean value, with true indicating that the name of the resource record should be the same as the host; ifReverseMapping is a Boolean value, with true indicating that a reverse record should be created.

Shown here is an example of a hostInfo string: 2030445,www.example.com,false,true style: form explode: true schema: type: string - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the following property, including user-defined fields:
  • ptrs —a string containing the list of unmanaged external host records to be associated with the IPv6 address in the format: viewId,exHostFQDN[, viewId,exHostFQDN,...] You can assign External Host records to an IPv6 address using the following method: EntityProperties props = new EntityProperties; props.addProperty ObjectProperties.ptrs, "123,exHostFQDN.com,456,exHostFQDN.net" long addressId = service.assignIP4Address configurationId, IPv6Address, macAddressStr, hostInfo, IPAssignmentActionValues.MAKE_STATIC, props.getPropertiesString;
  • name —name of the IPv6 address.
  • reserveUsing —defines the type of reservation, if through Client DUID or MAC Address. Applicable only for DHCP Reserved IP Addresses. If this value is not defined, the system deafults to Client DUID. You must set this parameter to one of the constants shown in .
  • DUID —DHCPv6 unique identifier.
  • locationCode —the hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1. The code is case-sensitive. It must be all UPPER CASE letters. The county code and child location code should be alphanumeric strings.
This value can be empty. style: form explode: true schema: type: string responses: '201': description: Returns true if the IPv6 address is successfully assigned; returns false if the address is not successfully assigned. headers: {} content: application/json: schema: type: boolean deprecated: false /v1/assignNextAvailableIP4Address: post: tags: - ipam_methods summary: assignNextAvailableIP4Address description: >- Assign the next available IPv4 address. Assigns a MAC address and other properties to the next available and unallocated IPv4 address within a configuration, block, or network. operationId: assignNextAvailableIP4Address parameters: - name: action in: query description: >- This parameter must be set to one of the constants shown in . style: form explode: true schema: type: string - name: configurationId in: query description: The object ID of the configuration in which the IPv4 address is located. style: form explode: true schema: type: integer format: int64 - name: hostInfo in: query description: >- A string containing host information for the address in the following format: hostname,viewId,reverseFlag,sameAsZoneFlag[, hostname,viewId,reverseFlag,sameAsZoneFlag,...] Where:
  • hostname - The FQDN of the host record to be added.
  • viewId - The object ID of the view under which this host should be created.
  • reverseFlag - The flag indicating if a reverse record should be created. The possible values are true or false.
  • sameAsZoneFlag - The flag indicating if record should be created as same as zone record. The possible values are true or false.

The comma-separated parameters may be repeated in the order shown above. The string must not end with a comma.

style: form explode: true schema: type: string - name: macAddress in: query description: >- The MAC address to assign to the IPv4 address. The MAC address can be specified in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the configuration, block, or network in which to look for the next available address. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing the following property, including user-defined fields:
  • ptrs —a string containing the list of unmanaged external host records to be associated with the IPv4 address in the format: viewId,exHostFQDN[, viewId,exHostFQDN,...] You can assign External Host records to an IPv4 address using the following method: EntityProperties props = new EntityProperties; props.addProperty ObjectProperties.ptrs, "123,exHostFQDN.com,456,exHostFQDN.net" long addressId = service.assignIP4Address configurationId, IPv4Address, macAddressStr, hostInfo, IPAssignmentActionValues.MAKE_STATIC, props.getPropertiesString;
  • name —name of the IPv4 address.
  • locationCode —the hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates CA= Canada TOR=Toronto OF1=Office 1. The code is case-sensitive. It must be all UPPER CASE letters. The county code and child location code should be alphanumeric strings.
  • skip —This is optional. Use to specify the IP address ranges or IP addresses to skip. You can specify multiple IP addresses separated by comma. To specify the range between the start and end addresses, use a hyphen (-). For example, skip=192.0.2.128-192.0.2.222,192.0.2.223
  • offset —This is optional. Use to specify from which address to start to assign IPv4 address. For example, offset=192.0.2.100
  • excludeDHCPRange — true or false. To specify whether IP addresses in DHCP ranges should be excluded from assignment. The default value is false. For example, offset=192.0.2.100 excludeDHCPRange=true
  • allowDuplicateHost (optional) —duplicate hostname check option. There are three possible values for this property:
    • Enable—set to enable the property and refuse duplicate hostnames.
    • Disable—set to disable the property and allow duplicate hostnames. Disable is the default value for allowDuplicateHost.
    • Inherit—set to make the hostname use the option specified in the higher-level parent object.
style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the newly assigned IPv4 address. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/changeStateIP4Address: put: tags: - ipam_methods summary: changeStateIP4Address description: >- Converts the state of an address from and between Reserved, DHCP Reserved, and Static, or DHCP Allocated to DHCP Reserved. operationId: changeStateIP4Address parameters: - name: addressId in: query description: The database ID of the address object. style: form explode: true schema: type: integer format: int64 - name: macAddress in: query description: >- Optional and only needed, if the target requires it. For example, MAKE_DHCP_RESERVED style: form explode: true schema: type: string - name: targetState in: query description: >- One of MAKE_STATIC, MAKE_RESERVED, MAKE_DHCP_RESERVED. All of these constants are defined in the Java Class IPAssignmentActionValues or in the API.pm file for Perl. style: form explode: true schema: type: string responses: '204': description: Converts an IP address from its current state to a target state; statically assigned, DHCP reserved, or logically reserved (non-DHCP). For example, this method can convert an IP address from a logical reservation to a static assignment or vise versa. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/clearIP6Address: delete: tags: - ipam_methods summary: clearIP6Address description: Clears a specified IPv6 address assignment. operationId: clearIP6Address parameters: - name: addressId in: query description: The object ID of the IPv6 address to be deleted. style: form explode: true schema: type: integer format: int64 responses: '204': description: Returns true to indicate that the IPv6 address has been cleared, or returns false if the operation was unsuccessful. headers: {} content: application/json: schema: type: boolean deprecated: false /v1/deleteDeviceInstance: delete: tags: - ipam_methods summary: deleteDeviceInstance description: >- Deletes either the IP address or MAC address (and all related DNS entries including host records, PTR records, or DHCP reserved addresses) on both the Address Manager and DNS/DHCP Server based on the IPv4 address or a MAC address supplied. operationId: deleteDeviceInstance parameters: - name: configName in: query description: >- Name of parent configuration. If the value is empty or cannot be found, an exception will be thrown. style: form explode: true schema: type: string - name: identifier in: query description: >- IP address or MAC address. If the value is empty or cannot be found, an exception will be thrown. Relevant IP addresses, host records and MAC addresses liked to multiple entities will be updated. Relevant IP addresses, host records and MAC addresses liked to a single entity will be deleted. style: form explode: true schema: type: string - name: options in: query description: Currently empty. This parameter is reserved for future use. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/getAdditionalIPAddresses: get: tags: - ipam_methods summary: getAdditionalIPAddresses description: >- Returns IPv4 addresses and loopback addresses added to the Service interface for DNS services. operationId: getAdditionalIPAddresses parameters: - name: adonisID in: query description: >- The database object ID of the server on which additional services IP address have been added. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The supported property is:
  • serviceType —type of service for which a list of IP addresses will be retrieved. Available types are AdditionalIPServiceType.SERVICE and AdditionalIPServiceType.LOOPBACK. If serviceType is not provided, all additional IP addresses of the services interface will be returned.
style: form explode: true schema: type: string responses: '200': description: 'Returns the list of additional IP addresses configured on the server in the format: [IP,serviceType|IP,serviceType]. For example, 10.0.0.10/32,loopback|11.0.0.3/24,service|12.0.0.3/32,loopback.' headers: {} content: application/json: schema: type: string deprecated: false /v1/getAliasesByHint: get: tags: - ipam_methods summary: getAliasesByHint description: Returns an array of CNAMEs with linked record name. operationId: getAliasesByHint parameters: - name: count in: query description: >- indicates the maximum of child objects that this method will return. The value must be less than or equal to 10. style: form explode: true schema: type: integer format: int32 - name: options in: query description: >- a string containing options. The supported options are hint and retrieveFields. Separate multiple options with a pipe character. For example: hint=^abc|retrieveFields=false If the hint option is not specified in the string, searching criteria will be based on the same as zone alias. The following wildcards are supported in the hint option.
  • ^ —matches the beginning of a string. For example: ^ex matches ex ample but not t ex t.
  • $ —matches the end of a string. For example: ple$ matches exam ple but not ple ase.
  • ^ $ —matches the exact characters between the two wildcards. For example: ^example$ only matches example.
  • ? —matches any one character. For example: ex?t matches ex i t.
  • * —matches one or more characters within a string. For example: ex*t matches exit and ex cellen t.
The default value for the retrieveFields option is set to false. If the option is set to true, user-defined field will be returned. If the options string does not contain retrieveFields, user-defined field will not be returned. style: form explode: true schema: type: string - name: start in: query description: >- indicates where in the list of objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of Alias APIEntity objects. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDevice: get: tags: - ipam_methods summary: getDiscoveredDevice description: >- Returns the object ID of the discovered device by running an IPv4 reconciliation policy. operationId: getDiscoveredDevice parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the object ID of the discovered device. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getDiscoveredDeviceArpEntries: get: tags: - ipam_methods summary: getDiscoveredDeviceArpEntries description: >- Returns all ARP entries of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceArpEntries parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all ARP entries of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDeviceHosts: get: tags: - ipam_methods summary: getDiscoveredDeviceHosts description: >- Returns all hosts of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceHosts parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all hosts of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDeviceInterfaces: get: tags: - ipam_methods summary: getDiscoveredDeviceInterfaces description: >- Returns all interfaces of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceInterfaces parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all interfaces of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDeviceMacAddressEntries: get: tags: - ipam_methods summary: getDiscoveredDeviceMacAddressEntries description: >- Returns all MAC address entries of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceMacAddressEntries parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all MAC address entries of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDeviceNetworks: get: tags: - ipam_methods summary: getDiscoveredDeviceNetworks description: >- Returns all networks of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceNetworks parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all networks of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDeviceVlans: get: tags: - ipam_methods summary: getDiscoveredDeviceVlans description: >- Returns all VLANs of a specific device discovered by running an IPv4 reconciliation policy. operationId: getDiscoveredDeviceVlans parameters: - name: deviceId in: query description: The object ID of the discovered device. style: form explode: true schema: type: integer format: int64 - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns all Vlans of a specific device. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getDiscoveredDevices: get: tags: - ipam_methods summary: getDiscoveredDevices description: >- Returns a list of discovered Layer 2 or Layer 3 devices by running an IPv4 reconciliation policy specified. operationId: getDiscoveredDevices parameters: - name: policyId in: query description: The object ID for the IPv4 reconciliation policy. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an array of discovered Layer 2 or Layer 3 devices. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getIP4Address: get: tags: - ipam_methods summary: getIP4Address description: Returns the details for the requested IPv4 address object. operationId: getIP4Address parameters: - name: address in: query description: The IPv4 address. style: form explode: true schema: type: string - name: containerId in: query description: >- The object ID for the configuration, block, network, or DHCP range in which this address is located. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the requested IPv4 Address object from the database. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getIP4NetworksByHint: get: tags: - ipam_methods summary: getIP4NetworksByHint description: >- Returns an array of IPv4 networks found under a given container object. You can filter the networks can using the ObjectProperties.hint, ObjectProperties.accessRight, and ObjectProperties.overrideType options. operationId: getIP4NetworksByHint parameters: - name: containerId in: query description: >- The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object is the configuration level. style: form explode: true schema: type: integer format: int64 - name: count in: query description: >- Indicates the maximum number of child objects that this method will return. The maximum number of child objects that can be returned is 10. style: form explode: true schema: type: integer format: int32 - name: options in: query description: >- A string containing options. The option names available in the ObjectProperties are ObjectProperties.hint, ObjectProperties.accessRight, and ObjectProperties.overrideType. Separate multiple options with a pipe character. For example: hint=ab|overrideType=HostRecord|accessRight=ADD The values for the ObjectProperties.hint option can be the prefix of the IP address for a network or the name of a network.
  • Example 1

    The following example will match networks that have the network ID starting with 192.168. For example, 192.168.0.0/24 or 192.168.1.0/24. String options = ObjectProperties.hint + “=198.168|”

  • Example 2

    The following example will match networks that have a name starting with “abc”. For example, “abc”, “abc123” or “abcdef”. String options = ObjectProperties.hint + “=abc|”

Matching networks to a network ID Example 1 will take precedence over matching networks to a name Example 2. The values for the ObjectProperties.accessRight and ObjectProperties.overrideType options must be one of the constants listed in and . For example: String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess + "|"+ ObjectProperties.overrideType + "=" + ObjectTypes.HostRecord; style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of IPv4 networks based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getIP6Address: get: tags: - ipam_methods summary: getIP6Address description: Returns an APIEntity for the specified IPv6 address. operationId: getIP6Address parameters: - name: address in: query description: The IPv6 address. style: form explode: true schema: type: string - name: containerId in: query description: >- The object ID of the container in which the IPv6 address is located. The container can be a configuration, an IPv6 block, or an IPv6 network. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an APIEntity for the specified IPv6 address. The APIEntity is empty of the IPv6 address does not exist. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getIP6ObjectsByHint: get: tags: - ipam_methods summary: getIP6ObjectsByHint description: >- Returns an array of IPv6 objects found under a given container object. The networks can be filtered by using ObjectProperties.hint and ObjectProperties.accessRight options. Currently, it only supports IPv6 networks. operationId: getIP6ObjectsByHint parameters: - name: containerId in: query description: >- The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object is the configuration level. style: form explode: true schema: type: integer format: int64 - name: count in: query description: >- Indicates the maximum number of child objects that this method will return. style: form explode: true schema: type: integer format: int32 - name: objectType in: query description: >- The type of object containing the IPv6 network. Currently, it only supports ObjectTypes.IP6Network. style: form explode: true schema: type: string - name: options in: query description: >- A string containing options. The Option names available in ObjectProperties are ObjectProperties.hint and ObjectProperties.accessRight.

Multiple options can be separated by a pipe | character. For example: hint=ab| accessRight=ADD The values for the ObjectProperties.hint option can be the prefix of the IP address for a network or the name of a network.

  • Example 1

    The following example will match networks that have the network ID starting with 2000::. For example, 2000::/64. String options = ObjectProperties.hint + “=2000::|”

  • Example 2

    The following example will match networks that have a name starting with “abc”. For example, “abc”, “abc123” or “abcdef”. String options = ObjectProperties.hint + “=abc|”

Matching networks to a network ID Example 1 will take precedence over matching networks to a name Example 2.

The values for the ObjectProperties.accessRight option must be one of the constants listed in and . For example: String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess;

style: form explode: true schema: type: string - name: start in: query description: >- Indicates where in the list of objects to start returning objects. The list begins at an index of 0. style: form explode: true schema: type: integer format: int32 responses: '200': description: Returns an array of IPv6 objects based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getIPRangedByIP: get: tags: - ipam_methods summary: getIPRangedByIP description: >- Returns the DHCP range containing the specified IPv4 or IPv6 address. Use this method to find the configuration, IPv4 or IPv6 block, network, or DHCP range containing a specified address. You can specify the type of object to be returned, or you can leave the type of object empty to find the most direct container for the object. operationId: getIPRangedByIP parameters: - name: address in: query description: An IPv4 or IPv6 address. style: form explode: true schema: type: string - name: containerId in: query description: >- The object ID of the container in which the IPv4 or IPv6 address is located. This can be a configuration, IPv4 or IPv6 block, network, or DHCP range. Specify the configuration if you don't know the block, network, or range in which the address is located. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of object containing the IP address. Specify ObjectTypes.IP4Block or ObjectTypes.IP6Block, ObjectTypes.IP4Network or ObjectTypes.IP6Network, or ObjectTypes.DHCP4Range or ObjectTypes.DHCP6Range to find the block, network, or range containing the IPv4 or IPv6 address. Specify an empty string "" to return the most direct container for the IPv4 or IPv6 address. style: form explode: true schema: type: string responses: '200': description: Returns an APIEntity for the object containing the specified address. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getLinkedNetworkConflicts: get: tags: - ipam_methods summary: getLinkedNetworkConflicts description: >- Get a list of deployment options that conflict with the associated networks or network that are linked to the IPv4 network template. operationId: getLinkedNetworkConflicts parameters: - name: networkId in: query description: >- The database object ID of the network that is linked to the IPv4 network template. Setting a value of zero returns all conflicting networks linked to the template. style: form explode: true schema: type: integer format: int64 - name: templateId in: query description: The object ID of the IPv4 network template. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns a list of conflicting network ranges and deployment options in JSON format. headers: {} content: application/json: schema: type: string deprecated: false /v1/getMaxAllowedRange: get: tags: - ipam_methods summary: getMaxAllowedRange description: >- Finds the maximum possible address range to which the existing IPv4 DHCP range can be extended. This method only supports the IPv4 DHCP range. operationId: getMaxAllowedRange parameters: - name: rangeId in: query description: The object ID of the IPv4 DHCP range. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the possible start address and end address for the specified IPv4 DHCP range object in the form of array of length 2. headers: {} content: application/json: schema: type: array items: type: string description: '' deprecated: false /v1/getNextAvailableIP4Address: get: tags: - ipam_methods summary: getNextAvailableIP4Address description: >- Returns the IPv4 address for the next available (unallocated) address within a configuration, block, or network. operationId: getNextAvailableIP4Address parameters: - name: parentId in: query description: >- The object ID for configuration, block, or network in which to look for the next available address. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the next available IPv4 address in an existing network as a string. headers: {} content: application/json: schema: type: string deprecated: false /v1/getNextAvailableIP4Network: get: tags: - ipam_methods summary: getNextAvailableIP4Network description: >- Returns the object ID for the next available (unused) network within a configuration or block. operationId: getNextAvailableIP4Network parameters: - name: autoCreate in: query description: >- This Boolean value indicates whether the next available network should be created if it does not exist. style: form explode: true schema: type: boolean - name: isLargerAllowed in: query description: >- This Boolean value indicates whether to return larger networks than those specified with the size parameter. style: form explode: true schema: type: boolean - name: parentId in: query description: The object ID of the network’s parent object. style: form explode: true schema: type: integer format: int64 - name: size in: query description: >- The size of the network, expressed as a power of 2. The size represents the number of hosts on the network. For example, if you are to find or create a /24 network, the size would be 256. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the object ID for the existing next available IPv4 network or, if the next available network did not exist and autoCreate was set to true, the newly created IPv4 network. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/getNextAvailableIP6Address: get: tags: - ipam_methods summary: getNextAvailableIP6Address description: Returns the next available IPv6 address within an IPv6 block or network. operationId: getNextAvailableIP6Address parameters: - name: parentId in: query description: >- The object ID of IPv6 block or network where to look for the next available IPv6 address. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The properties string contains the following properties (the properties are separated by "|"):
  • startOffset - This is optional. Specifies from which offset to retrieve the available IPv6 address. The valid values range from 0 to 2 ^ 63 (2 to the power of 63).
  • skip - This is optional. Specifies the IPv6 address ranges or IPv6 addresses to skip, separated by a comma.
  • includeDHCPRanges - This is optional. A boolean that specifies whether DHCP ranges should be included when retrieving the next available IPv6 address. The default value is false.
  • numberOfAddresses - This is optional. The number of requested IPv6 addresses. The default value is 1. The valid values are from 1 to 100. All IPv6 addresses will be returned from a single network.
style: form explode: true schema: type: string responses: '200': description: Returns the next available IPv6 address in an existing network as a string of one IPv6 address or a comma separated list of IPv6 addresses if more than one address is requested. headers: {} content: application/json: schema: type: string deprecated: false /v1/getNextAvailableIPRange: get: tags: - ipam_methods summary: getNextAvailableIPRange description: >- Returns the object ID for the next available (unused) block or network within a configuration or block. operationId: getNextAvailableIPRange parameters: - name: parentId in: query description: >- The object ID of the parent object under which the next available range resides configuration or block. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The string containing the following properties and values:
  • reuseExisting — True or False. This Boolean value indicates whether to search existing empty networks to find the available IP range of specified size.
  • isLargerAllowed — True or False. This Boolean value indicates whether to return larger networks than those specified with the sizeparameter.
  • autoCreate — True or False. This Boolean value indicates whether the next available IP range should be created in the parent object if it does not exist.
  • traversalMethod —This parameter identifies the appropriate search algorithm to find the suitable object. The possible values are:
    • TraversalMethodology.NO_TRAVERSAL NO_TRAVERSAL —will attempt to find the next range directly under the specified parent object. It will not search through to the lower level objects.
    • TraversalMethodology.DEPTH_FIRST DEPTH_FIRST —will attempt to find the next range under the specified object by iteratively through its children one by one. After exploring the object recursively for its child ranges, it will move to the next child object.
    • TraversalMethodology.BREADTH_FIRST BREADTH_FIRST —will attempt to find the next range under the specified object by iterative levels. It will first find the range immediately below the specified parent object. If not found, then it will attempt to find the range under all the first child objects.
style: form explode: true schema: type: string - name: size in: query description: The size of the range, expressed as a power of 2. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of the range object to be fetched. Currently IPv4 block and network are supported. style: form explode: true schema: type: string responses: '200': description: Returns the object ID for the existing next available IPv4 range or, if the next available IP range does not exist and autoCreate was set to true, the newly created IPv4 range. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/getNextAvailableIPRanges: get: tags: - ipam_methods summary: getNextAvailableIPRanges description: >- Returns the object IDs for the next available (unused) blocks or networks within a configuration or block. operationId: getNextAvailableIPRanges parameters: - name: count in: query description: >- The number of networks to be found. If the number of networks count is greater than 1:
  • isLargerAllowed and traversalMethod properties will not be applicable.
  • The DEPTH_FIRST methodology will be used to search objects.
 style: form explode: true schema: type: integer format: int32 - name: parentId in: query description: >- The object ID of the parent object under which the next available range resides configuration or block. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The string containing the following properties and values:
  • reuseExisting — True or False. This Boolean value indicates whether to search existing empty networks to find the available IP range of specified size.
  • isLargerAllowed — True or False. This Boolean value indicates whether to return larger networks than those specified with the sizeparameter.
  • autoCreate — True or False. This Boolean value indicates whether the next available IP range should be created in the parent object if it does not exist.
  • traversalMethod —This parameter identifies the appropriate search algorithm to find the suitable object. The possible values are:
    • TraversalMethodology.DEPTH_FIRST DEPTH_FIRST —will attempt to find the next range under the specified object by iteratively through its children one by one. After exploring the object recursively for its child ranges, it will move to the next child object.
If a value is not provided for the following parameters: reuseExisting and autoCreate, the default values will be as follows: reuseExisting = false and autoCreate = true. style: form explode: true schema: type: string - name: size in: query description: The size of the range, expressed as a power of 2. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of the range object to be fetched. Currently only IPv4 network is supported. style: form explode: true schema: type: string responses: '200': description: Returns consecutive matching IPv4 range object IDs. If the next available ranges do not exist and you have set the autoCreate property to true, new IPv4 ranges will be created and their object IDs will be returned. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/getNextIP4Address: get: tags: - ipam_methods summary: getNextIP4Address description: >- Returns the next available IP addresses in octet notation under specified circumstances. operationId: getNextIP4Address parameters: - name: parentId in: query description: The network or configuration Id. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- The property string contains three properties; skip, offset and excludeDHCPRange. The values for skip and offset must be IPv4 addresses and must appear in dotted octet notation.
  • skip - This is optional. It is used to specify the IP address ranges or IP addresses to skip, separated by comma. A hyphen (-), not a dash is used to separate the start and end addresses. Do not use the skip property if the parentId is a configuration Id. If you do, an error message appears, ‘Skip is not allowed for configuration level’.
  • offset - This is optional. This is to specify from which address to start to assign IPv4 Address.
  • excludeDHCPRange - This specifies whether IP addresses in DHCP ranges should be excluded from assignment. The value is either true or false, default value is false. skip=10.10.10.128-10.10.11.200,10.10.11.210| offset=10.10.10.100|excludeDHCPRange=true|
style: form explode: true schema: type: string responses: '200': description: Returns the IPv4 address in octet notation. headers: {} content: application/json: schema: type: string deprecated: false /v1/getTemplateTaskStatus: get: tags: - ipam_methods summary: getTemplateTaskStatus description: Gets the IPv4 template task status when the template is applied. operationId: getTemplateTaskStatus parameters: - name: taskId in: query description: The task ID of the IPv4 network template. style: form explode: true schema: type: string responses: '200': description: Returns a JSON string that contains the template status. headers: {} content: application/json: schema: type: string deprecated: false /v1/isAddressAllocated: get: tags: - ipam_methods summary: isAddressAllocated description: >- Queries a MAC address to determine if the address has been allocated to an IP address. operationId: isAddressAllocated parameters: - name: configurationId in: query description: >- The object ID of the parent configuration in which the MAC address resides. style: form explode: true schema: type: integer format: int64 - name: ipAddress in: query description: The IPv4 DHCP allocated address to be checked against the MAC address. style: form explode: true schema: type: string - name: macAddress in: query description: >- The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value. style: form explode: true schema: type: string responses: '200': description: Returns a Boolean value indicating whether the address is allocated. headers: {} content: application/json: schema: type: boolean deprecated: false /v1/mergeBlocksWithParent: post: tags: - ipam_methods summary: mergeBlocksWithParent description: >- Merges specified IPv4 blocks into a single block. The blocks must all have the same parent and must be contiguous. Blocks whose parent object is the configuration cannot contain networks. operationId: mergeBlocksWithParent parameters: [] requestBody: description: An array containing a list of IPv4 block IDs. content: application/json: schema: type: array items: type: integer format: int32 description: An array containing a list of IPv4 block IDs. required: false responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/mergeSelectedBlocksOrNetworks: post: tags: - ipam_methods summary: mergeSelectedBlocksOrNetworks description: >- Merges specified IPv4 blocks or IPv4 networks into a single IPv4 block or IPv4 network. The list of objects to be merged must all be of the same type (for example, all blocks or all networks). The objects must all have the same parent and must be contiguous. operationId: mergeSelectedBlocksOrNetworks parameters: - name: blockOrNetworkToKeep in: query description: >- The ID of the IPv4 block or IPv4 network that will retain its identity after the merge. style: form explode: true schema: type: integer format: int64 requestBody: description: An array containing a list of IPv4 block or network IDs. content: application/json: schema: type: array items: type: integer format: int32 description: An array containing a list of IPv4 block or network IDs. required: false responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/moveIPObject: put: tags: - ipam_methods summary: moveIPObject description: >- Moves an IPv4 block, IPv4 network, IPv4 address, IPv6 block, or IPv6 network to a new IPv4 or IPv6 address. operationId: moveIPObject parameters: - name: address in: query description: The new address for the object. style: form explode: true schema: type: string - name: objectId in: query description: >- The ID of the object to be moved. Currently IPv4 blocks, IPv4 networks, IPv4 addresses, IPv6 blocks and IPv6 networks are supported. style: form explode: true schema: type: integer format: int64 - name: options in: query description: >- A string containing the noServerUpdate option.
  • noServerUpdate - A boolean value. If set to true, instant dynamic host record changes will not be performed on DNS/DHCP Servers when moving an IPv4 address object.
noServerUpdate works only for an IPv4 address object. style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/reapplyTemplate: post: tags: - ipam_methods summary: reapplyTemplate description: >- Reapplies DNS zone templates. The template must already be applied to an object before you can re-apply or remove it. operationId: reapplyTemplate parameters: - name: properties in: query description: >- A string containing the following settings:
  • The properties value must include ObjectProperties.templateType with the value of ObjectProperties.zoneTemplateType.
  • If the re-apply mode is not specified in the properties, the default ObjectProperties.templateReapplyModeIgnore mode is used.
  • The available re-apply modes include:
    • ObjectProperties.templateReapplyModeUpdate
    • ObjectProperties.templateReapplyModeIgnore
    • ObjectProperties.templateReapplyModeOverwrite
  • ObjectProperties.templateReapplyModeOverwrite is not applicable for Gateway and Reserved Addresses. Use ObjectProperties.templateReapplyModeUpdate instead to update.
  • ObjectProperties.templateReapplyModeUpdate is not applicable for Reserved DHCP Ranges, IP Groups and Zone Templates. Use ObjectProperties.templateReapplyModeOverwrite instead to update.
  • Both ObjectProperties.templateReapplyModeUpdate and ObjectProperties.templateReapplyModeOverwrite are applicable for Deployment Options.
 style: form explode: true schema: type: string - name: templateId in: query description: The object ID of the DNS zone template to be assigned or updated. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/reassignIP6Address: post: tags: - ipam_methods summary: reassignIP6Address description: Reassigns an existing IPv6 address to a new IPv6 address. operationId: reassignIP6Address parameters: - name: destination in: query description: >- The destination of the reassigned address. You can specify this as an IPv6 address or as a MAC address from which the new IPv6 address can be calculated. Specify the MAC address in the format nnnnnnnnnnnn or nn-nn-nn-nn-nn-nn, where nn is a hexadecimal value. style: form explode: true schema: type: string - name: oldAddressId in: query description: The object ID of the current IPv6 address. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID of the reassigned IPv6 address. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/removeAdditionalIPAddresses: delete: tags: - ipam_methods summary: removeAdditionalIPAddresses description: >- Removes additional IPv4 addresses and loopback addresses from the Services interface. operationId: removeAdditionalIPAddresses parameters: - name: ipsToRemove in: query description: >- The list of IP addresses to be removed. You can specify multiple IP addresses with a separator (|). The supported format is [IP,serviceType| IP,serviceType]. For example, 10.0.0.10/32,loopback| 11.0.0.3/24,service| 12.0.0.3,loopback. style: form explode: true schema: type: string - name: properties in: query description: >- Adds object properties. Currently there is no supported properties. Reserved for future use. style: form explode: true schema: type: string - name: serverId in: query description: >- The database object ID of the server from which additional services IP addresses need to be removed. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/resizeRange: put: tags: - ipam_methods summary: resizeRange description: >- Changes the size of an IPv4 block, IPv4 network, DHCPv4 range, IPv6 block, or IPv6 network. operationId: resizeRange parameters: - name: objectId in: query description: >- The ID of the object to be resized. Currently IPv4 block, IPv4 network, DHCPv4 range, IPv6 block, and IPv6 network are supported. style: form explode: true schema: type: integer format: int64 - name: options in: query description: >- A string containing the following options:
  • ObjectProperties.convertOrphanedIPAddressesTo This option applies only to DHCPv4 range.

    The possible values are:

    • STATIC
    • DHCP_RESERVED
    • UNALLOCATED

    For example: service.resizeRange <rangeID>, <"ipAddressStart-ipAddressEnd">, "convertOrphanedIPAddressesTo=<value>";

    • If the value is an empty string "", the default is DHCP_RESERVED.
    • If the option value is incorrect, an exception will be thrown.
    • If the option name is incorrect, the option will be ignored. Therefore, orphaned IP addresses will remain as assigned.

style: form explode: true schema: type: string - name: range in: query description: >- The new size for the object to be resized.

For the IPv4 block, IPv4 network or DHCPv4 range, specify the size in CIDR notation or as an address range in the ipAddressStart-ipAddressEnd format.

For the IPv6 block or IPv6 network, specify the size in Starting address/Size format.

style: form explode: true schema: type: string responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/splitIP4Network: post: tags: - ipam_methods summary: splitIP4Network description: Splits an IPv4 network into the specified number of networks. operationId: splitIP4Network parameters: - name: networkId in: query description: The database object ID of the network that you are splitting. style: form explode: true schema: type: integer format: int64 - name: numberOfParts in: query description: The number of networks you wish to split the network into. Valid values are 2, 4, 8, 16, 32, 64, 128, 256, 512, or 1024. style: form explode: true schema: type: integer format: int32 - name: options in: query description: >- A string containing the following options:
  • assignDefaultGateway—a Boolean value. If set to true, a gateway will be created by using the default gateway value which is the first IP address in the network. If set to false, no gateway will be created. The default value is true.
  • overwriteConflicts—a Boolean value. If set to true, any conflicts within the split IPv4 network will be removed. The default value is false.
  • preserveGateway—a Boolean value. If set to true, the gateway in the original network will be preserved. The default value is true.
    • For the above options only true and false are accepted. These values are case sensitive. Other values such as TRUE, FALSE, True, False, tRue, xxxx, 123, etc., will not be accepted.
  • template—a network template ID. The default value is zero (0) which means no network template will be used. Specify a network template ID if you wish to apply one.
style: form explode: true schema: type: string responses: '201': description: Returns an array of networks created after splitting the network. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/splitIP6Range: post: tags: - ipam_methods summary: splitIP6Range description: >- Splits an IPv6 block or network into the specified number of blocks or networks. operationId: splitIP6Range parameters: - name: numberOfParts in: query description: >- The number of the blocks or networks into which the block or network will be split. Valid values are 2, 4, 8, 16, 32, 64, 128, 256, 512, or 1024. style: form explode: true schema: type: integer format: int32 - name: options in: query description: No options available. Reserved for future use. style: form explode: true schema: type: string - name: rangeId in: query description: The database object ID of the block or network that is being split. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns an array of IPv6 blocks or networks created after splitting the block or network. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIEntity' description: '' deprecated: false /v1/unassignIP4NetworkTemplate: post: tags: - ipam_methods summary: unassignIP4NetworkTemplate description: Unassigns IPv4 network templates. operationId: unassignIP4NetworkTemplate parameters: - name: networkId in: query description: The object ID of the IPv4 network. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string - name: templateId in: query description: The object ID of the IPv4 template. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/isMigrationRunning: get: tags: - migration_methods summary: isMigrationRunning description: >- Returns true or false to indicate if the migration service is running. Specify a filename to determine if the specified file is migrating. Specify an empty string ("") to determine if any migration files are migrating or queued for migration. operationId: isMigrationRunning parameters: - name: filename in: query description: >- The filename of the XML file in the data/migration/incoming directory. Do not include a path in the filename. This value can be empty. style: form explode: true schema: type: string responses: '200': description: Returns a Boolean value indicating if the specified file is currently migrating. When an empty string is specified for the filename, returns a true if there are any migration files queued for migration or currently migrating. headers: {} content: application/json: schema: type: boolean deprecated: false /v1/migrateFile: post: tags: - migration_methods summary: migrateFile description: >- Migrates the specified XML file into Address Manager. The file must reside in the /data/migration/incoming directory on the Address Manager server. operationId: migrateFile parameters: - name: filename in: query description: >- The filename of the XML file in the data/migration/incoming directory. Do not include a path in the filename. style: form explode: true schema: type: string responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/addDHCPDeploymentRole: post: tags: - server_deployment_methods summary: addDHCPDeploymentRole description: Adds a DHCP deployment role to a specified object. operationId: addDHCPDeploymentRole parameters: - name: entityId in: query description: The object ID for the object to which you are adding the deployment role. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing options including:
  • inherited—either true or false;indicates whether or not the deployment role was inherited.
  • secondaryServerInterfaceId—the object ID of the secondary server interface for a DHCP failover.
style: form explode: true schema: type: string - name: serverInterfaceId in: query description: The object ID of the server interface to which you are adding the role. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of DHCP role to be added. The type must be one of those listed in . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DHCP server role object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addDNSDeploymentRole: post: tags: - server_deployment_methods summary: addDNSDeploymentRole description: Adds a DNS deployment role to a specified object. operationId: addDNSDeploymentRole parameters: - name: entityId in: query description: The object ID for the object to which you are adding the deployment role. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including the View associated with this DNS deployment role and user-defined fields. style: form explode: true schema: type: string - name: serverInterfaceId in: query description: The object ID of the server interface to which you are adding the role. style: form explode: true schema: type: integer format: int64 - name: type in: query description: >- The type of DNS role you are adding. The type must be one of those listed in . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new DNS server role object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addServer: post: tags: - server_deployment_methods summary: addServer description: Adds servers to Address Manager. operationId: addServer parameters: - name: configurationId in: query description: The object ID of the configuration to which you wish to add the server. style: form explode: true schema: type: integer format: int64 - name: defaultInterfaceAddress in: query description: The physical IP address for the server within Address Manager. style: form explode: true schema: type: string - name: fullHostName in: query description: The DNS FQDN by which the server is referenced. style: form explode: true schema: type: string - name: name in: query description: The name of the server within Address Manager. style: form explode: true schema: type: string - name: profile in: query description: >- The server capability profile. The profile describes the type of server or appliance being added and determines the services that can be deployed to this server. This must be one of the constants found in . style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the following options:
  • connected —either true or false; indicates whether or not to connect to a server. In order to add and configure multi-port DNS/DHCP Servers, this option must be set to true. If false, other interface property options will be ignored.
  • upgrade —indicates whether or not to apply the latest version of DNS/DHCP Server software once the appliance is under Address Manager control. The value is either true or false by default, true.
  • password —the server password by default, bluecat.
  • servicesIPv4Address —IPv4 address used only for services traffic such as DNS, DHCP, DHCPv6, and TFTP. If dedicated management is enabled, this option must be specified.
  • servicesIPv4Netmask —IPv4 netmask used only for services traffic such as DNS, DHCP, DHCPv6, and TFTP. If dedicated management is enabled, this option must be specified.
  • servicesIPv6Address —IPv6 address used only for services traffic such as DNS, DHCP, DHCPv6, and TFTP. This is optional.
  • servicesIPv6Subnet —IPv6 subnet used only for services traffic such as DNS, DHCP, DHCPv6, and TFTP. This is optional.
  • xhaIPv4Address —IPv4 address used for XHA. This is optional.
  • xhaIPv4Netmask —IPv4 netmask used for XHA. This is optional.
  • redundancyScenario —networking redundancy scenarios. The possible values are ACTIVE_BACKUP Failover and IEEE_802_3AD Load Balancing.
For DNS/DHCP Servers without multi-port support, the interface-related property options will be ignored. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new server. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addTFTPDeploymentRole: post: tags: - server_deployment_methods summary: addTFTPDeploymentRole description: Adds a TFTP deployment role to a specified object. operationId: addTFTPDeploymentRole parameters: - name: entityId in: query description: The object ID for the object to which you wish to add the TFTP deployment role. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including user-defined fields. style: form explode: true schema: type: string - name: serverId in: query description: The object ID of the server interface to which you wish to add the TFTP deployment role. style: form explode: true schema: type: integer format: int64 responses: '201': description: Returns the object ID for the new TFTP deployment role object. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/deleteDHCPDeploymentRole: delete: tags: - server_deployment_methods summary: deleteDHCPDeploymentRole description: Deletes DHCP deployment roles. operationId: deleteDHCPDeploymentRole parameters: - name: entityId in: query description: >- The object ID for the object from which the deployment role is to be deleted. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: >- The object ID of the server interface from which the deployment roles is to be deleted. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDNSDeploymentRole: delete: tags: - server_deployment_methods summary: deleteDNSDeploymentRole description: Deletes a specified DNS deployment role. operationId: deleteDNSDeploymentRole parameters: - name: entityId in: query description: >- The object ID for the object from which this DNS deployment role is to be deleted. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: >- The object ID of the server interface to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deleteDNSDeploymentRoleForView: delete: tags: - server_deployment_methods summary: deleteDNSDeploymentRoleForView description: >- Deletes the DNS deployment role assigned to view-level objects in the IP space for ARPA zones. operationId: deleteDNSDeploymentRoleForView parameters: - name: entityId in: query description: >- The object ID for the object from which this DNS deployment role is to be deleted. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: >- The object ID of the server interface to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The view from which the DNS deployment role is to be deleted. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deployServer: post: tags: - server_deployment_methods summary: deployServer description: Deploys servers. When you invoke this method, the server is immediately deployed. operationId: deployServer parameters: - name: serverId in: query description: The object ID of the server you are deploying. style: form explode: true schema: type: integer format: int64 responses: '201': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deployServerConfig: post: tags: - server_deployment_methods summary: deployServerConfig description: Deploys specific configuration(s) to a particular server. operationId: deployServerConfig parameters: - name: properties in: query description: >- A string containing property names. The property names available in the ObjectProperties are ObjectProperties.services, and ObjectProperties.forceDNSFullDeployment. Multiple options can be separated by a pipe (|) character. For example: ObjectProperties.services=DNS| forceDNSFullDeployment=true The values for properties are:
  • services —the name of the valid service configuration that needs to be deployed. These are the valid values for the services: DNS, DHCP, DHCPv6, and TFTP.
  • forceDNSFullDeployment —a boolean value. Set to true to perform a full DNS deployment. Omit this parameter from the method call to perform a differential deployment.
style: form explode: true schema: type: string - name: serverId in: query description: The database object ID of the server that will immediately be deployed. style: form explode: true schema: type: integer format: int64 responses: '201': description: Deploys specific configuration(s) to a particular server. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/deployServerServices: post: tags: - server_deployment_methods summary: deployServerServices description: Deploys specific service(s) to a particular server. operationId: deployServerServices parameters: - name: serverId in: query description: >- The database object ID of the server for which deployment services to be deployed. style: form explode: true schema: type: integer format: int64 - name: services in: query description: >-

The name of the valid services to be deployed. Specify multiple services using a comma(,). The valid format is services=DNS,DHCP,TFTP

style: form explode: true schema: type: string responses: '201': description: Deploys specific service(s) to a particular server. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/getDHCPDeploymentRole: get: tags: - server_deployment_methods summary: getDHCPDeploymentRole description: Retrieves the DHCP deployment role assigned to a specified object. operationId: getDHCPDeploymentRole parameters: - name: entityId in: query description: The object ID for the object to which the deployment role is assigned. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: The object ID of the server interface to which the role is assigned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the DHCP deployment role assigned to the specified object, or returns an empty APIDeploymentRol if no role is defined. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentRole' - description: >- Manages the deployment roles that control the services provided by Address Manager-managed servers. These objects support the standard object functions. deprecated: false /v1/getDNSDeploymentRole: get: tags: - server_deployment_methods summary: getDNSDeploymentRole description: Retrieves a DNS deployment role from a specified object. operationId: getDNSDeploymentRole parameters: - name: entityId in: query description: >- The object ID for the object to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: >- The object ID of the server interface to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns a DNS deployment role from the specified object, or returns an empty APIDeploymentRole if no role is defined. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentRole' - description: >- Manages the deployment roles that control the services provided by Address Manager-managed servers. These objects support the standard object functions. deprecated: false /v1/getDNSDeploymentRoleForView: get: tags: - server_deployment_methods summary: getDNSDeploymentRoleForView description: >- Retrieves the DNS deployment role assigned to a view-level objects in the IP space for ARPA zones. operationId: getDNSDeploymentRoleForView parameters: - name: entityId in: query description: >- The object ID for the object to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 - name: serverInterfaceId in: query description: >- The object ID of the server interface to which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 - name: viewId in: query description: The view in which the DNS deployment role is assigned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns the requested APIDeploymentRole object. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIDeploymentRole' - description: >- Manages the deployment roles that control the services provided by Address Manager-managed servers. These objects support the standard object functions. deprecated: false /v1/getDeploymentRoles: get: tags: - server_deployment_methods summary: getDeploymentRoles description: >- Returns the DNS and DHCP deployment roles associated with the specified object. For DNS views and zones, getDeploymentRoles returns DNS deployment roles. For IP address space objects, such as IPv4 blocks and networks, IPv6 blocks and networks, DHCP classes, and MAC pools, getDeploymentRoles returns DNS and DHCP deployment roles. operationId: getDeploymentRoles parameters: - name: entityId in: query description: >- The object ID for a DNS view, DNS zone, IPv4 block or network, IPv6 block or network, DHCP class, or MAC pool. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an array of APIDeploymentRole objects representing the deployment roles associated with the specified object. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIDeploymentRole' description: '' deprecated: false /v1/getDeploymentTaskStatus: get: tags: - server_deployment_methods summary: getDeploymentTaskStatus description: >- Returns the deployment status of the deployment task that was created using the selectiveDeploy API method. operationId: getDeploymentTaskStatus parameters: - name: deploymentTaskToken in: query description: >- The string token value that is returned from the selectiveDeploy} API method. style: form explode: true schema: type: string responses: '200': description: Returns a string value of the overall deployment status and the deployment status of individual entities. headers: {} content: application/json: schema: type: string deprecated: false /v1/getServerDeploymentRoles: get: tags: - server_deployment_methods summary: getServerDeploymentRoles description: Returns a list of all deployment roles associated with the server. operationId: getServerDeploymentRoles parameters: - name: serverId in: query description: The object ID of the server with which deployment roles are associated. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns a list of all deployment roles associated with the server. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIDeploymentRole' description: '' deprecated: false /v1/getServerDeploymentStatus: get: tags: - server_deployment_methods summary: getServerDeploymentStatus description: Returns the deployment status of the server. operationId: getServerDeploymentStatus parameters: - name: properties in: query description: The valid value is empty. style: form explode: true schema: type: string - name: serverId in: query description: The object ID of the server whose deployment status needs to be checked. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns status code for deployment of a particular server. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/getServerForRole: get: tags: - server_deployment_methods summary: getServerForRole description: Returns a list of all servers associated with the specified deployment role. operationId: getServerForRole parameters: - name: roleId in: query description: The object ID for the deployment role whose servers are to be returned. style: form explode: true schema: type: integer format: int64 responses: '200': description: Returns an APIEntity object representing the servers associated with the specified deployment role. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APIEntity' - description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . deprecated: false /v1/moveDeploymentRoles: put: tags: - server_deployment_methods summary: moveDeploymentRoles description: >- Moves all DNS and DHCP deployment roles from a server to the specified interface of another server. operationId: moveDeploymentRoles parameters: - name: moveDhcpRoles in: query description: >- If set to true, DHCP roles will be moved to the target server interface. style: form explode: true schema: type: boolean - name: moveDnsRoles in: query description: >- If set to true, DNS roles will be moved to the target server interface. style: form explode: true schema: type: boolean - name: options in: query description: This is reserved for future use. style: form explode: true schema: type: string - name: sourceServerId in: query description: The object ID of the server that contains the roles. style: form explode: true schema: type: integer format: int64 - name: targetServerInterfaceId in: query description: >- The object ID of the server interface of the server to which the roles are to be moved. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/quickDeploy: post: tags: - server_deployment_methods summary: quickDeploy description: >- Instantly deploys changes you made to DNS resource records since the last full or quick deployment. This method only applies to DNS resource records that you have changed and does not deploy any other data. operationId: quickDeploy parameters: - name: entityId in: query description: >- The object ID of the DNS zone or network for which deployment service needs to be deployed. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing the services option. It can also be empty.
  • services —the name of the valid service that need to be deployed. The only valid service name for quick deployment is DNS. Any other service names will throw an error.
style: form explode: true schema: type: string responses: '201': description: Instantly deploys changes to DNS resource records made since the last full deployment or quick deployment. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/replaceServer: put: tags: - server_deployment_methods summary: replaceServer description: Replaces a server. operationId: replaceServer parameters: - name: defaultInterface in: query description: Management interface address for the server. style: form explode: true schema: type: string - name: hostName in: query description: The DNS FQDN by which the server is referenced. style: form explode: true schema: type: string - name: name in: query description: Name of the server to be replaced. style: form explode: true schema: type: string - name: password in: query description: The server password by default, bluecat. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing the following options:
  • servicesIPv4Address —IPv4 address used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated management is enabled, this option must be specified. If dedicated management is disabled, this address must be the same as defaultInterfaceAddress which is management interface address.
  • servicesIPv4Netmask —IPv4 netmask used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated management is enabled, this option must be specified. If dedicated management is disabled, this netmask address must be the same as the management interface netmask address.
  • servicesIPv6Address —IPv6 address used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. This is optional.
  • servicesIPv6Subnet —IPv6 subnet used only for services traffic such as DNS, DHCP, DHCPv6 and TFTP. This is optional.
  • xhaIPv4Address —IPv4 address used for XHA. This is optional.
  • xhaIPv4Netmask —IPv4 netmask used for XHA. This is optional.
  • redundancyScenario —networking redundancy scenarios. The possible values are ACTIVE_BACKUP Failover and IEEE_802_3AD Load Balancing.
  • resetServices —allows you to replace the DNS/DHCP Server while maintaining existing configurations for DNS, DHCP, and TFTP services. Define this option only if you have modified the IPv4 or IPv6 addresses of the Services interface or wish to reset configurations for DNS, DHCP, and TFTP services on the DNS/DHCP Server. The value is either true or false by default, false.
For DNS/DHCP Servers without multi-port support, the interface-related property options will be ignored. Resetting DNS/DHCP Servers will result in a service outage. This service outage will last until you have deployed services to the replacement system. Only reset DNS/DHCP Server services if you are replacing the DNS/DHCP Server with a new appliance of a different type or reconfiguring the IPv4 or IPv6 addresses of the Services interface on the appliance. BlueCat recommends that you schedule a maintenance window before performing a reset of DNS/DHCP Server services. style: form explode: true schema: type: string - name: serverId in: query description: The object ID of the server that needs to be replaced. style: form explode: true schema: type: integer format: int64 - name: upgrade in: query description: >- Flag indicating that server needs to be upgraded or not. True means server needs to be upgraded. style: form explode: true schema: type: boolean responses: '204': description: Replaces the server using the existing server ID. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/selectiveDeploy: post: tags: - server_deployment_methods summary: selectiveDeploy description: >- Selectively deploys—creates a differential deployment task to deploy changes made to specific DNS entities, such as resource records, to a managed DNS/DHCP Server. operationId: selectiveDeploy parameters: - name: properties in: query description: >- A string containing the following deployment options:
  • scope —a string value. This property defines whether the deployment task includes objects that are related to the defined DNS resource records. The scope can be one of the following values:
    • related (default value) —deploys the DNS resource records defined in the entityIds list including DNS resource records that are related to those entities. For more information on additional entities that are deployed when the related scope is defined, refer to .
    • specific —deploys only the DNS resource records that are defined in the entityIds list.
  • batchMode —an enum value. This property batches selective deployment tasks. The scope can be one of the following values:
    • disabled (default value) —disables the batching of selective deployment tasks.
    • batch_by_server —enables the batching of selective deployment tasks.
    The batching of selective deployment tasks is dependent on the following conditions:
    • The tasks are from the same server.
    • Each deployment task that is configured for batching must have batchMode set to batch_by_server.
    • The batched deployment contains less than 100 resource records.
  • continueOnFailure —a boolean value. This property specifies the mode of operation on a failed resource record. If set to false, deployment stops when a record fails. If set to true, deployment continues when a record fails and moves to the next record. The default value is true if batchMode is set to batch_by_server, otherwise the default value is false.
  • dynamicRecords —an enum value. This property defines how dynamic records are handled with selective deployment tasks. The value can be one of the following:
    • fail (default value) —the selective deployment task fails when a dynamic record is encountered.
    • skip —skips dynamic records by removing them from the list of entity IDs before the selective deployment task is performed.If you perform a selective deployment where all entities are dynamic and you define the skip option, all records will be removed from the selective deployment task and the deployment fails with the following message:Verify input error.: Empty entity id input
    • makestatic —dynamic records are updated to static records before the selective deployment task is performed. This has no effect on related records that are deployed using the related scope.If you define the makestatic option and the selective deployment task fails for any reason, the updated records are not rolled back and remain static records.
style: form explode: true schema: type: string requestBody: description: >- A list of entity IDs that specify the DNS entities to deploy. Currently, only DNS resource records are supported. Restrictions:
  • You can only deploy a maximum of 100 DNS entities per selective deployment API call.
  • You cannot deploy dynamic records.
  • You cannot deploy external host records.
  • You cannot deploy resource records if they belong to multiple DNS/DHCP Servers.
 content: application/json: schema: type: array items: type: integer format: int32 description: >- A list of entity IDs that specify the DNS entities to deploy. Currently, only DNS resource records are supported. Restrictions:
  • You can only deploy a maximum of 100 DNS entities per selective deployment API call.
  • You cannot deploy dynamic records.
  • You cannot deploy external host records.
  • You cannot deploy resource records if they belong to multiple DNS/DHCP Servers.
 required: false responses: '201': description: Returns a token string value of the deployment task. headers: {} content: application/json: schema: type: string application/xml: schema: type: string xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDHCPDeploymentRole: put: tags: - server_deployment_methods summary: updateDHCPDeploymentRole description: Updates a DHCP deployment role. operationId: updateDHCPDeploymentRole parameters: [] requestBody: description: The DHCP deployment role object to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDHCPDeploymentRoleRequest' - description: The DHCP deployment role object to be updated. example: id: 12345 type: '...' service: '...' entityId: 12345 serverInterfaceId: 12345 properties: '...' example: id: 12345 type: '...' service: '...' entityId: 12345 serverInterfaceId: 12345 properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/updateDNSDeploymentRole: put: tags: - server_deployment_methods summary: updateDNSDeploymentRole description: Updates a specified DNS deployment role. operationId: updateDNSDeploymentRole parameters: [] requestBody: description: The DNS deployment role object to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateDNSDeploymentRoleRequest' - description: The DNS deployment role object to be updated. example: id: 12345 type: '...' service: '...' entityId: 12345 serverInterfaceId: 12345 properties: '...' example: id: 12345 type: '...' service: '...' entityId: 12345 serverInterfaceId: 12345 properties: '...' required: false responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/addTFTPFile: post: tags: - tftp_methods summary: addTFTPFile description: Adds TFTP files. operationId: addTFTPFile parameters: - name: name in: query description: The name of the TFTP file. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent object of the TFTP file. The parent will always be a TFTP folder. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- Adds object properties, including user-defined fields and description properties. style: form explode: true schema: type: string - name: version in: query description: The version of the file. This parameter is optional. style: form explode: true schema: type: string requestBody: content: multipart/form-data: encoding: {} schema: type: object properties: inputStream: type: string description: >- The file to be uploaded and distributed to clients by TFTP. The file is passed to Address Manager as a byte array. format: binary body: type: string format: binary required: false responses: '201': description: Returns the object ID for the new TFTP file. headers: {} content: application/json: schema: type: number format: double application/xml: schema: type: number format: double xml: name: response attribute: false wrapped: false deprecated: false /v1/addTFTPFolder: post: tags: - tftp_methods summary: addTFTPFolder description: Adds TFTP folders. operationId: addTFTPFolder parameters: - name: name in: query description: The name of the TFTP folder. style: form explode: true schema: type: string - name: parentId in: query description: >- The object ID of the parent object of the TFTP folder. The parent is either a TFTP group or another TFTP folder object. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new TFTP folder. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addTFTPGroup: post: tags: - tftp_methods summary: addTFTPGroup description: Adds TFTP groups. operationId: addTFTPGroup parameters: - name: configurationId in: query description: The object ID of the configuration where you wish to add the TFTP group. style: form explode: true schema: type: integer format: int64 - name: name in: query description: The name of the TFTP group. style: form explode: true schema: type: string - name: properties in: query description: Adds object properties, including comments and user-defined fields. style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the new TFTP group. headers: {} content: application/json: schema: type: number format: double deprecated: false /v1/addUserDefinedField: post: tags: - udf_methods summary: addUserDefinedField description: Adds user-defined fields. operationId: addUserDefinedField parameters: - name: type in: query description: >- The type of object the user-defined field belongs to. This must be one of the constants listed in . style: form explode: true schema: type: string requestBody: description: The user-defined field assigned to an object. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1AddUserDefinedFieldRequest' - description: The user-defined field assigned to an object. example: name: '...' displayName: '...' type: '...' defaultValue: '...' validatorProperties: '...' properties: '...' predefinedValues: '...' required: true hideFromSearch: true example: name: '...' displayName: '...' type: '...' defaultValue: '...' validatorProperties: '...' properties: '...' predefinedValues: '...' required: true hideFromSearch: true required: false responses: '201': description: Creates the user-defined fields. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/deleteUserDefinedField: delete: tags: - udf_methods summary: deleteUserDefinedField description: Deletes user-defined fields. operationId: deleteUserDefinedField parameters: - name: name in: query description: The internal name of the user-defined field. style: form explode: true schema: type: string - name: type in: query description: >- The type of object the user-defined field belongs to. This must be one of the constants listed in . style: form explode: true schema: type: string responses: '204': description: Deletes the user-defined fields. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/getUserDefinedFields: get: tags: - udf_methods summary: getUserDefinedFields description: Returns the user-defined fields information. operationId: getUserDefinedFields parameters: - name: requiredFieldsOnly in: query description: >- Specifies whether all user-defined fields of the object type will be returned or not. If set to true, only required fields will be returned. style: form explode: true schema: type: boolean - name: type in: query description: >- The type of object the user-defined field belongs to. This must be one of the constants listed in . style: form explode: true schema: type: string responses: '200': description: Returns the user-defined fields information. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/APIUserDefinedField' description: '' deprecated: false /v1/updateBulkUdf: post: tags: - udf_methods summary: updateBulkUdf description: Updates values of various user-defined fields (UDFs) for different objects. operationId: updateBulkUdf parameters: - name: properties in: query description: Reserved for future use. style: form explode: true schema: type: string requestBody: content: multipart/form-data: encoding: {} schema: type: object properties: inputStream: type: string description: >- The file to be used to update UDFs. The file is passed to Address Manager as a byte array that is the stream of the CSV file contents. The file must follow the following pattern:
  • EntityId - The object ID of the entity on which the UDF needs to be updated. You must enter this into the first column.
  • UDFName - The actual name of the UDF that needs to be updated. You must enter this into the second column.
  • newUDFValue - The new value of the UDF which needs to be updated on the entity. You must enter this into the third column.
  • The file format should be CSV.
  • The file should not contain any header.
  • The data should start from the first line.
  • To include any special characters, users need to escape the data.
 format: binary body: type: string format: binary required: false responses: '201': description: Returns a CSV file containing the respective line number in the input CSV file and the reason for the failure identified by the system. headers: {} content: application/json: schema: type: array items: type: number description: '' format: double application/xml: schema: type: array items: type: number xml: name: response attribute: false wrapped: false description: '' format: double xml: attribute: false wrapped: false deprecated: false /v1/updateUserDefinedField: put: tags: - udf_methods summary: updateUserDefinedField description: Updates user-defined fields. operationId: updateUserDefinedField parameters: - name: type in: query description: >- The type of object the user-defined field belongs to. This must be one of the constants listed in . style: form explode: true schema: type: string requestBody: description: The user-defined field assigned to an object. content: application/json: schema: allOf: - $ref: '#/components/schemas/V1UpdateUserDefinedFieldRequest' - description: The user-defined field assigned to an object. example: name: '...' displayName: '...' type: '...' defaultValue: '...' validatorProperties: '...' properties: '...' predefinedValues: '...' required: true hideFromSearch: true example: name: '...' displayName: '...' type: '...' defaultValue: '...' validatorProperties: '...' properties: '...' predefinedValues: '...' required: true hideFromSearch: true required: false responses: '204': description: Updates the user-defined fields. headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/cleanBrokenTrustRelationship: post: tags: - undocumented summary: cleanBrokenTrustRelationship description: This is an internal API used by Address Manager services. It's not intended for users. operationId: cleanBrokenTrustRelationship parameters: - name: ipsToRemove in: query description: '' style: form explode: true schema: type: array items: type: string responses: '201': description: '' headers: {} content: application/json: schema: type: string format: binary application/xml: schema: type: string format: binary xml: name: response attribute: false wrapped: false deprecated: false /v1/configureReplication: post: tags: - undocumented summary: configureReplication description: This API has been deprecated and is no longer supported. operationId: configureReplication parameters: - name: compressReplication in: query description: '' style: form explode: true schema: type: boolean - name: properties in: query description: '' style: form explode: true schema: type: string - name: replicationBreakThreshold in: query description: '' style: form explode: true schema: type: integer format: int64 - name: replicationQueueThreshold in: query description: '' style: form explode: true schema: type: integer format: int64 - name: standbyServer in: query description: '' style: form explode: true schema: type: string responses: '201': description: '' headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/exchangeKeyBundles: post: tags: - undocumented summary: exchangeKeyBundles description: This is an internal API used by Address Manager services. It's not intended for users. operationId: exchangeKeyBundles parameters: [] requestBody: description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TrustKeyBundle' description: '' required: false responses: '201': description: '' headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TrustKeyBundle' description: '' deprecated: false /v1/moveIP4Object: put: tags: - undocumented summary: moveIP4Object description: This API has been deprecated and is no longer supported. operationId: moveIP4Object parameters: - name: address in: query description: '' style: form explode: true schema: type: string - name: objectId in: query description: '' style: form explode: true schema: type: integer format: int64 responses: '204': description: '' headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/breakXHAPair: post: tags: - xha_methods summary: breakXHAPair description: Breaks an xHA pair and returns each server to its original stand-alone state. operationId: breakXHAPair parameters: - name: breakInProteusOnly in: query description: >- Either true or false, to determine whether or not the xHA pair breaks in the Address Manager interface only. This argument breaks the xHA pair in Address Manager, even if the xHA settings are not removed on the actual servers. style: form explode: true schema: type: boolean - name: xHAServerId in: query description: The object ID of the xHA server. style: form explode: true schema: type: integer format: int64 responses: '201': description: Breaks an xHA pair. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/createXHAPair: post: tags: - xha_methods summary: createXHAPair description: Creates an xHA pair. operationId: createXHAPair parameters: - name: activeServerId in: query description: The object ID of the active DNS/DHCP Server. style: form explode: true schema: type: integer format: int64 - name: activeServerNewIPv4Address in: query description: >- The new IPv4 address for the active server. This is the physical interface of the active server used during creation of the pair. The original IP address of the active server is assigned to the virtual interface. style: form explode: true schema: type: string - name: configurationId in: query description: The object ID of the configuration in which the xHA servers are located. style: form explode: true schema: type: integer format: int64 - name: passiveServerId in: query description: The object ID of the passive DNS/DHCP Server. style: form explode: true schema: type: integer format: int64 - name: properties in: query description: >- A string containing options listed in . style: form explode: true schema: type: string responses: '201': description: Returns the object ID for the xHA pair created. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/editXHAPair: put: tags: - xha_methods summary: editXHAPair description: Updates the xHA pair created. operationId: editXHAPair parameters: - name: name in: query description: The name of the xHA server being updated. style: form explode: true schema: type: string - name: properties in: query description: >- A string containing options listed in . style: form explode: true schema: type: string - name: xHAServerId in: query description: The object ID of the xHA server. style: form explode: true schema: type: integer format: int64 responses: '204': description: None. headers: {} content: application/json: schema: type: string format: binary deprecated: false /v1/failoverXHA: put: tags: - xha_methods summary: failoverXHA description: Performs a manual xHA failover. operationId: failoverXHA parameters: - name: xHAServerId in: query description: The object ID of the xHA server. style: form explode: true schema: type: integer format: int64 responses: '204': description: Performs a manual xHA failover. headers: {} content: application/json: schema: type: string format: binary deprecated: false components: schemas: APIAccessRight: title: APIAccessRight type: object properties: entityId: type: integer description: >- The database ID of the object to which the access right applies. This value must be greater than 0. format: int64 userId: type: integer description: >- The database ID of the owner of the access right. This value must be greater than 0. format: int64 value: type: string description: >- The default access right (HIDE, VIEW, ADD, CHANGE, or FULL). This field cannot be null. overrides: type: string description: >- Indicates the types that are to be overridden in the access right in the format objectType=accessRightValue where objectType is the same object type used in APIEntity and accessRightValue is one of HIDE, VIEW, ADD, CHANGE or FULL. Multiple override elements are separated by a | (pipe) character. properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. description: This class controls Access Right objects. example: entityId: 12345 userId: 12345 value: '...' overrides: '...' properties: '...' APIData: title: APIData type: object properties: name: type: string description: >- The name of the probe to collect data. Values are NETWORK_BLOOM or LEASE_COUNT_PER_DATE. properties: type: string description: >- A string containing extra properties for the object in the format attribute: value. description: API Data with a timestamp. example: name: '...' properties: '...' APIDeploymentOption: title: APIDeploymentOption type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. description: >- Deployment options configure both DHCP and DNS services on the network. They are available as DHCP client and service options, including standard DNS options. Deployment options support the standard object functions. example: id: 12345 type: '...' name: '...' value: '...' properties: '...' APIDeploymentRole: title: APIDeploymentRole type: object properties: id: type: integer description: The database ID of the deployment role in Address Manager. format: int64 type: type: string description: >- The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE, SLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD MASTER). This field cannot be null. service: type: string description: DNS, DHCP, or TFTP. This field cannot be null. entityId: type: integer description: >- The database ID of the entity. This value must be greater than 0. format: int64 serverInterfaceId: type: integer description: >- The database ID of the sever interface. This value must be greater than 0. format: int64 properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. This field can be null if used for forward space. A ViewId property must be provided to assign DNS Roles to a Network or Block for a particular DNS View (reverse space). Multiple properties are separated by a | (pipe) character. description: >- Manages the deployment roles that control the services provided by Address Manager-managed servers. These objects support the standard object functions. example: id: 12345 type: '...' service: '...' entityId: 12345 serverInterfaceId: 12345 properties: '...' APIEntity: title: APIEntity type: object properties: id: type: integer description: The database ID of the object in Address Manager. format: int64 name: type: string description: The field name, which might be null. type: type: string description: >- The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). properties: type: string description: >- A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. description: >- This class represents all entities except options, roles, and access rights. It manages all other types by passing the values for the object as a delimited properties string of name–value pairs. The properties for each object are listed in . example: id: 12345 name: '...' type: '...' properties: '...' APIUserDefinedField: title: APIUserDefinedField type: object properties: name: type: string description: The internal name of the user-defined field. displayName: type: string description: >- The name of the user-defined field that appears to users in the Address Manager interface. type: type: string description: >- The type of the user-defined field. Types are available as constants in the UserDefinedFieldType class. For available constants, refer to . defaultValue: type: string description: The default value for the user-defined field. validatorProperties: type: string description: >- The validation properties for the user-defined field. Property names are available as constants in the UserDefinedFieldValidatorProperties class. For available constants, refer to . properties: type: string description: >- The following property can be used:
  • locales=en-US,ja-JP,zh-CN
You must enable the supported locales in the global settings of the Address Manager user interface before you can use them within UDFs. predefinedValues: type: string description: >- The preset values for the user-defined field separated by a | (pipe) character and ending with a pipe character. For example, value1|value2|. required: type: boolean description: >- The boolean value. If set to true, users must enter data in the field. renderAsRadioButton: type: boolean description: This has been deprecated. hideFromSearch: type: boolean description: >- The boolean value. If set to true, the user-defined field is hidden from the search. description: >- User-defined fields can be added to each of the Address Manager object types. This class allows API users to query and gather user-defined fields information for a specified object type. example: name: '...' displayName: '...' type: '...' defaultValue: '...' validatorProperties: '...' properties: '...' predefinedValues: '...' required: true hideFromSearch: true ResponsePolicySearchResult: title: ResponsePolicySearchResult type: object properties: name: type: string description: The name of the Response Policy item. policyType: type: string description: >- The type of response policy. For example, whitelist, blacklist, redirect or blackhole. parentIds: type: string description: >- Comma-separated values of the parent Response Policy or RP Zone object(s) ID. If policy item is associated with a Response Policy, it is the Response Policy object ID. If policy item is associated with BlueCat Security feed data, it is the RP Zone object ID. category: type: string description: >- The name of the BlueCat Security feed category associated with the policy item. For example, Malicious, Spam or Botnet command and control. For local response policy items, this will be null. configId: type: integer description: >- The object ID of the parent configuration in which the Response Policy item is configured. format: int64 description: >- Represents the Response Policy items that are configured either in local Response Policies or BlueCat Security feed data. example: name: '...' policyType: '...' parentIds: '...' category: '...' configId: 12345 TrustKeyBundle: title: TrustKeyBundle type: object properties: IP: type: string sshUser: type: string hostPublicKey: type: string hostPublicKeyGeneratedTimestamp: type: number userPublicKey: type: string userPublicKeyGeneratedTimestamp: type: number example: IP: '...' ip: '...' sshUser: '...' hostPublicKey: '...' hostPublicKeyGeneratedTimestamp: 12345 userPublicKey: '...' userPublicKeyGeneratedTimestamp: 12345 APIAccessRight1: title: APIAccessRight1 type: object properties: entityId: type: integer description: >- The database ID of the object to which the access right applies. This value must be greater than 0. format: int64 xml: namespace: '' attribute: false wrapped: false overrides: type: string description: >- Indicates the types that are to be overridden in the access right in the format objectType=accessRightValue where objectType is the same object type used in APIEntity and accessRightValue is one of HIDE, VIEW, ADD, CHANGE or FULL. Multiple override elements are separated by a | (pipe) character. xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. xml: namespace: '' attribute: false wrapped: false userId: type: integer description: >- The database ID of the owner of the access right. This value must be greater than 0. format: int64 xml: namespace: '' attribute: false wrapped: false value: type: string description: >- The default access right (HIDE, VIEW, ADD, CHANGE, or FULL). This field cannot be null. xml: namespace: '' attribute: false wrapped: false APIData1: title: APIData1 type: object properties: name: type: string description: >- The name of the probe to collect data. Values are NETWORK_BLOOM or LEASE_COUNT_PER_DATE. xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- A string containing extra properties for the object in the format attribute: value. xml: namespace: '' attribute: false wrapped: false APIDeploymentOption1: title: APIDeploymentOption1 type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 xml: namespace: '' attribute: false wrapped: false name: type: string description: The name of the option. xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. xml: namespace: '' attribute: false wrapped: false type: type: string description: >- The option type listed in Option Types. This field cannot be null. xml: namespace: '' attribute: false wrapped: false value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. xml: namespace: '' attribute: false wrapped: false APIDeploymentRole1: title: APIDeploymentRole1 type: object properties: entityId: type: integer description: >- The database ID of the entity. This value must be greater than 0. format: int64 xml: namespace: '' attribute: false wrapped: false id: type: integer description: The database ID of the deployment role in Address Manager. format: int64 xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. This field can be null if used for forward space. A ViewId property must be provided to assign DNS Roles to a Network or Block for a particular DNS View (reverse space). Multiple properties are separated by a | (pipe) character. xml: namespace: '' attribute: false wrapped: false serverInterfaceId: type: integer description: >- The database ID of the sever interface. This value must be greater than 0. format: int64 xml: namespace: '' attribute: false wrapped: false service: type: string description: DNS, DHCP, or TFTP. This field cannot be null. xml: namespace: '' attribute: false wrapped: false type: type: string description: >- The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE, SLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD MASTER). This field cannot be null. xml: namespace: '' attribute: false wrapped: false APIEntity1: title: APIEntity1 type: object properties: id: type: integer description: The database ID of the object in Address Manager. format: int64 xml: namespace: '' attribute: false wrapped: false name: type: string description: The field name, which might be null. xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. xml: namespace: '' attribute: false wrapped: false type: type: string description: >- The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). xml: namespace: '' attribute: false wrapped: false APITrustBundle: title: APITrustBundle type: object properties: establishedTime: type: string xml: namespace: '' attribute: false wrapped: false hostKey: type: string xml: namespace: '' attribute: false wrapped: false ip: type: string xml: namespace: '' attribute: false wrapped: false pubKey: type: string xml: namespace: '' attribute: false wrapped: false APITrustBundleFinalSetting: title: APITrustBundleFinalSetting type: object properties: error: type: string xml: namespace: '' attribute: false wrapped: false errorCode: type: integer format: int32 xml: namespace: '' attribute: false wrapped: false responceCode: type: string xml: namespace: '' attribute: false wrapped: false APIUserDefinedField1: title: APIUserDefinedField1 type: object properties: defaultValue: type: string description: The default value for the user-defined field. xml: namespace: '' attribute: false wrapped: false displayName: type: string description: >- The name of the user-defined field that appears to users in the Address Manager interface. xml: namespace: '' attribute: false wrapped: false hideFromSearch: type: boolean description: >- The boolean value. If set to true, the user-defined field is hidden from the search. xml: namespace: '' attribute: false wrapped: false name: type: string description: The internal name of the user-defined field. xml: namespace: '' attribute: false wrapped: false predefinedValues: type: string description: >- The preset values for the user-defined field separated by a | (pipe) character and ending with a pipe character. For example, value1|value2|. xml: namespace: '' attribute: false wrapped: false properties: type: string description: >- The following property can be used:
  • locales=en-US,ja-JP,zh-CN
You must enable the supported locales in the global settings of the Address Manager user interface before you can use them within UDFs. xml: namespace: '' attribute: false wrapped: false renderAsRadioButton: type: boolean description: This has been deprecated. xml: namespace: '' attribute: false wrapped: false required: type: boolean description: >- The boolean value. If set to true, users must enter data in the field. xml: namespace: '' attribute: false wrapped: false type: type: string description: >- The type of the user-defined field. Types are available as constants in the UserDefinedFieldType class. For available constants, refer to . xml: namespace: '' attribute: false wrapped: false validatorProperties: type: string description: >- The validation properties for the user-defined field. Property names are available as constants in the UserDefinedFieldValidatorProperties class. For available constants, refer to . xml: namespace: '' attribute: false wrapped: false ResponsePolicySearchResult1: title: ResponsePolicySearchResult1 type: object properties: category: type: string description: >- The name of the BlueCat Security feed category associated with the policy item. For example, Malicious, Spam or Botnet command and control. For local response policy items, this will be null. xml: namespace: '' attribute: false wrapped: false configId: type: integer description: >- The object ID of the parent configuration in which the Response Policy item is configured. format: int64 xml: namespace: '' attribute: false wrapped: false name: type: string description: The name of the Response Policy item. xml: namespace: '' attribute: false wrapped: false parentIds: type: string description: >- Comma-separated values of the parent Response Policy or RP Zone object(s) ID. If policy item is associated with a Response Policy, it is the Response Policy object ID. If policy item is associated with BlueCat Security feed data, it is the RP Zone object ID. xml: namespace: '' attribute: false wrapped: false policyType: type: string description: >- The type of response policy. For example, whitelist, blacklist, redirect or blackhole. xml: namespace: '' attribute: false wrapped: false V1AddEntityRequest: title: V1AddEntityRequest type: object properties: id: type: integer description: The database ID of the object in Address Manager. format: int64 name: type: string description: The field name, which might be null. type: type: string description: >- The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). properties: type: string description: >- A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. V1AddRawDeploymentOptionRequest: title: V1AddRawDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1AddUserDefinedFieldRequest: title: V1AddUserDefinedFieldRequest type: object properties: name: type: string description: The internal name of the user-defined field. displayName: type: string description: >- The name of the user-defined field that appears to users in the Address Manager interface. type: type: string description: >- The type of the user-defined field. Types are available as constants in the UserDefinedFieldType class. For available constants, refer to . defaultValue: type: string description: The default value for the user-defined field. validatorProperties: type: string description: >- The validation properties for the user-defined field. Property names are available as constants in the UserDefinedFieldValidatorProperties class. For available constants, refer to . properties: type: string description: >- The following property can be used:
  • locales=en-US,ja-JP,zh-CN
You must enable the supported locales in the global settings of the Address Manager user interface before you can use them within UDFs. predefinedValues: type: string description: >- The preset values for the user-defined field separated by a | (pipe) character and ending with a pipe character. For example, value1|value2|. required: type: boolean description: >- The boolean value. If set to true, users must enter data in the field. renderAsRadioButton: type: boolean description: This has been deprecated. hideFromSearch: type: boolean description: >- The boolean value. If set to true, the user-defined field is hidden from the search. V1UpdateRequest: title: V1UpdateRequest type: object properties: id: type: integer description: The database ID of the object in Address Manager. format: int64 name: type: string description: The field name, which might be null. type: type: string description: >- The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). properties: type: string description: >- A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. V1UpdateDHCP6ClientDeploymentOptionRequest: title: V1UpdateDHCP6ClientDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDHCP6ServiceDeploymentOptionRequest: title: V1UpdateDHCP6ServiceDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDHCPClientDeploymentOptionRequest: title: V1UpdateDHCPClientDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDHCPDeploymentRoleRequest: title: V1UpdateDHCPDeploymentRoleRequest type: object properties: id: type: integer description: The database ID of the deployment role in Address Manager. format: int64 type: type: string description: >- The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE, SLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD MASTER). This field cannot be null. service: type: string description: DNS, DHCP, or TFTP. This field cannot be null. entityId: type: integer description: >- The database ID of the entity. This value must be greater than 0. format: int64 serverInterfaceId: type: integer description: >- The database ID of the sever interface. This value must be greater than 0. format: int64 properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. This field can be null if used for forward space. A ViewId property must be provided to assign DNS Roles to a Network or Block for a particular DNS View (reverse space). Multiple properties are separated by a | (pipe) character. V1UpdateDHCPServiceDeploymentOptionRequest: title: V1UpdateDHCPServiceDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDHCPVendorDeploymentOptionRequest: title: V1UpdateDHCPVendorDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDNSDeploymentOptionRequest: title: V1UpdateDNSDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateDNSDeploymentRoleRequest: title: V1UpdateDNSDeploymentRoleRequest type: object properties: id: type: integer description: The database ID of the deployment role in Address Manager. format: int64 type: type: string description: >- The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE, SLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD MASTER). This field cannot be null. service: type: string description: DNS, DHCP, or TFTP. This field cannot be null. entityId: type: integer description: >- The database ID of the entity. This value must be greater than 0. format: int64 serverInterfaceId: type: integer description: >- The database ID of the sever interface. This value must be greater than 0. format: int64 properties: type: string description: >- A string containing extra properties for the object in the format attribute=value. This field can be null if used for forward space. A ViewId property must be provided to assign DNS Roles to a Network or Block for a particular DNS View (reverse space). Multiple properties are separated by a | (pipe) character. V1UpdateRawDeploymentOptionRequest: title: V1UpdateRawDeploymentOptionRequest type: object properties: id: type: integer description: The database ID of the option in Address Manager. format: int64 type: type: string description: >- The option type listed in Option Types. This field cannot be null. name: type: string description: The name of the option. value: type: string description: >- The single or multiple field value of the option; multiple values are comma-separated. This field cannot be null. properties: type: string description: >- A string containing additional properties. This is used for user-defined fields on most objects, but also passes some values that do not have their own specific parameter. V1UpdateUserDefinedFieldRequest: title: V1UpdateUserDefinedFieldRequest type: object properties: name: type: string description: The internal name of the user-defined field. displayName: type: string description: >- The name of the user-defined field that appears to users in the Address Manager interface. type: type: string description: >- The type of the user-defined field. Types are available as constants in the UserDefinedFieldType class. For available constants, refer to . defaultValue: type: string description: The default value for the user-defined field. validatorProperties: type: string description: >- The validation properties for the user-defined field. Property names are available as constants in the UserDefinedFieldValidatorProperties class. For available constants, refer to . properties: type: string description: >- The following property can be used:
  • locales=en-US,ja-JP,zh-CN
You must enable the supported locales in the global settings of the Address Manager user interface before you can use them within UDFs. predefinedValues: type: string description: >- The preset values for the user-defined field separated by a | (pipe) character and ending with a pipe character. For example, value1|value2|. required: type: boolean description: >- The boolean value. If set to true, users must enter data in the field. renderAsRadioButton: type: boolean description: This has been deprecated. hideFromSearch: type: boolean description: >- The boolean value. If set to true, the user-defined field is hidden from the search. V1UpdateWithOptionsRequest: title: V1UpdateWithOptionsRequest type: object properties: id: type: integer description: The database ID of the object in Address Manager. format: int64 name: type: string description: The field name, which might be null. type: type: string description: >- The class name of the object. For example, a configuration object has a type equal to Configuration. This field cannot be null. A list of types is part of the API client (Java and Perl). properties: type: string description: >- A string that contains properties for the object in attribute=value format, with each separated by a | (pipe) character. For example, a host record object may have a properties field such as ttl=123|comments=my comment|. This field can be null. tags: - name: bam_object_methods - name: data_collection_methods - name: dhcp_methods - name: dns_methods - name: generic_deployment_option_methods - name: generic_methods - name: ipam_methods - name: migration_methods - name: server_deployment_methods - name: tftp_methods - name: udf_methods - name: undocumented - name: xha_methods