\nThe comma-separated parameters may be repeated in the order shown above.\nThe string must not end with a comma.\n
",
"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\nspecified in the format .",
"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\nor MAKE_DHCP_RESERVED.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "address",
"in": "query",
"description": "The IPv6 address to be assigned. The address\nmust be created with addIP6Address before it can be\nassigned. For more information, refer to\n. The address must be a string\nrepresenting 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\nassigned. This can be the object ID of a configuration, IPv6 block, or\nIPv6 network. The parent IPv6 network object must exist before adding an\nIPv6 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\nhostInfo string uses the following format:\nviewId, hostname, ifSameAsZone,\nifReverseMapping\n\nWhere viewId is the object ID of the DNS view;\nhostname is the name of DNS zone for the address;\nifSameAsZone is a Boolean value, with true\nindicating that the name of the resource record should be the same as the\nhost; ifReverseMapping is a Boolean value, with true\nindicating that a reverse record should be created.\n
\nShown here is an example of a hostInfo string:\n2030445,www.example.com,false,true",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "macAddress",
"in": "query",
"description": "The MAC address in the format nnnnnnnnnnnn,\nnn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn\nis a hexadecimal value.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "properties",
"in": "query",
"description": "A string containing the following property, including user-defined\nfields:\n\n\n- ptrs —a string containing the list of unmanaged external host\nrecords to be associated with the IPv6 address in the format:\n
viewId,exHostFQDN[, viewId,exHostFQDN,...] You can assign\nExternal Host records to an IPv6 address using the following method:\nEntityProperties props = new EntityProperties;\nprops.addProperty\nObjectProperties.ptrs, \"123,exHostFQDN.com,456,exHostFQDN.net\"\nlong addressId = service.assignIP4Address\nconfigurationId, IPv6Address, macAddressStr, hostInfo, IPAssignmentActionValues.MAKE_STATIC, props.getPropertiesString;\n \n\n- name —name of the IPv6 address.
\n\n- reserveUsing —defines the type of reservation, if\nthrough Client DUID or MAC Address. Applicable only for DHCP Reserved IP\nAddresses. If this value is not defined, the system deafults to Client\nDUID. You must set this parameter to one of the constants shown in\n.
\n\n- DUID —DHCPv6 unique identifier.
\n\n- locationCode —the hierarchical location code consists\nof a set of 1 to 3 alpha-numeric strings separated by a space. The first\ntwo characters indicate a country, followed by next three characters\nwhich indicate a city in UN/LOCODE. New custom locations created under a\nUN/LOCODE city are appended to the end of the hierarchy. For example,\nCA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1.\nThe code is case-sensitive. It must be all UPPER CASE letters. The\ncounty code and child location code should be alphanumeric\nstrings.
\n
\nThis 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.\n\nAssigns a MAC address and other properties to the next available and\nunallocated 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\nformat: hostname,viewId,reverseFlag,sameAsZoneFlag[,\nhostname,viewId,reverseFlag,sameAsZoneFlag,...] Where:\n\n\n- hostname - The FQDN of the host\nrecord to be added.
\n\n- viewId - The object ID of the view under which this\nhost should be created.
\n\n- reverseFlag - The flag indicating if a reverse record\nshould be created. The possible values are true or false.
\n\n- sameAsZoneFlag - The flag indicating if record should\nbe created as same as zone record. The possible values are true or\nfalse.
\n
\n\nThe comma-separated parameters may be repeated in the order shown above.\nThe string must not end with a comma.\n
",
"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\nspecified in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn,\nor 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\nfor 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\nfields:\n\n\n- ptrs —a string containing the list of unmanaged external host\nrecords to be associated with the IPv4 address in the format:\n
viewId,exHostFQDN[, viewId,exHostFQDN,...] You can assign\nExternal Host records to an IPv4 address using the following method:\nEntityProperties props = new EntityProperties;\nprops.addProperty\nObjectProperties.ptrs, \"123,exHostFQDN.com,456,exHostFQDN.net\"\nlong addressId = service.assignIP4Address\nconfigurationId, IPv4Address, macAddressStr, hostInfo, IPAssignmentActionValues.MAKE_STATIC, props.getPropertiesString; \n\n- name —name of the IPv4 address.
\n\n- locationCode —the hierarchical location code consists\nof a set of 1 to 3 alpha-numeric strings separated by a space. The first\ntwo characters indicate a country, followed by next three characters\nwhich indicate a city in UN/LOCODE. New custom locations created under a\nUN/LOCODE city are appended to the end of the hierarchy. For example,\nCA TOR OF1 indicates CA= Canada TOR=Toronto OF1=Office 1.\nThe code is case-sensitive. It must be all UPPER CASE letters. The\ncounty code and child location code should be alphanumeric\nstrings.
\n\n- skip —This is optional. Use to specify the IP address\nranges or IP addresses to skip. You can specify multiple IP addresses\nseparated by comma. To specify the range between the start and end\naddresses, use a hyphen (-). For example,\n
skip=192.0.2.128-192.0.2.222,192.0.2.223 \n\n- offset —This is optional. Use to specify from which\naddress to start to assign IPv4 address. For example,\n
offset=192.0.2.100 \n\n- excludeDHCPRange — true or\nfalse. To specify whether IP addresses in DHCP ranges\nshould be excluded from assignment. The default value is\nfalse. For example,
offset=192.0.2.100\nexcludeDHCPRange=true \n- allowDuplicateHost (optional) —duplicate hostname check\noption. There are three possible values for this property:\n
\n- Enable—set to enable the property and refuse duplicate\nhostnames.
\n- Disable—set to disable the property and allow duplicate\nhostnames. Disable is the default value for\nallowDuplicateHost.
\n- Inherit—set to make the hostname use the option specified in\nthe higher-level parent object.
\n
\n \n
",
"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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"deprecated": false
}
},
"/v1/changeStateIP4Address": {
"put": {
"tags": [
"ipam_methods"
],
"summary": "changeStateIP4Address",
"description": "Converts the state of an address from and between Reserved, DHCP Reserved,\nand 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,\nMAKE_DHCP_RESERVED",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "targetState",
"in": "query",
"description": "One of MAKE_STATIC, MAKE_RESERVED,\nMAKE_DHCP_RESERVED. All of these constants are defined in the\nJava Class IPAssignmentActionValues or in the API.pm file\nfor 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\nincluding host records, PTR records, or DHCP reserved addresses) on both the\nAddress Manager and DNS/DHCP Server based on the IPv4 address or a MAC\naddress supplied.",
"operationId": "deleteDeviceInstance",
"parameters": [
{
"name": "configName",
"in": "query",
"description": "Name of parent configuration. If the value is empty or cannot be found,\nan 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\nexception will be thrown. Relevant IP addresses, host records and MAC\naddresses liked to multiple entities will be updated. Relevant IP\naddresses, host records and MAC addresses liked to a single entity will\nbe 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\nfor DNS services.",
"operationId": "getAdditionalIPAddresses",
"parameters": [
{
"name": "adonisID",
"in": "query",
"description": "The database object ID of the server on which additional services IP\naddress have been added.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "properties",
"in": "query",
"description": "The supported property is:\n\n\n- serviceType —type of service for which a list of IP\naddresses will be retrieved. Available types are\nAdditionalIPServiceType.SERVICE and\nAdditionalIPServiceType.LOOPBACK. If serviceType is not provided,\nall additional IP addresses of the services interface will be\nreturned.
\n
",
"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\nvalue 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\nretrieveFields. Separate multiple options with a pipe\ncharacter. For example: hint=^abc|retrieveFields=false If\nthe hint option is not specified in the string, searching criteria will\nbe based on the same as zone alias. The following wildcards are supported\nin the hint option.\n\n\n- ^ —matches the beginning of a string. For example: ^ex\nmatches ex ample but not t ex t.
\n\n- $ —matches the end of a string. For example: ple$\nmatches exam ple but not ple ase.
\n\n- ^ $ —matches the exact characters between the two wildcards.\nFor example: ^example$ only matches example.
\n\n- ? —matches any one character. For example: ex?t matches\nex i t.
\n\n- * —matches one or more characters within a string. For\nexample: ex*t matches exit and ex cellen t.
\n
\nThe default value for the retrieveFields option is set to\nfalse. If the option is set to true,\nuser-defined field will be returned. If the options string does not\ncontain retrieveFields, user-defined field will not be\nreturned.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"description": "indicates where in the list of objects to start returning objects. The\nlist 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\nreconciliation 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"deprecated": false
}
},
"/v1/getDiscoveredDeviceArpEntries": {
"get": {
"tags": [
"ipam_methods"
],
"summary": "getDiscoveredDeviceArpEntries",
"description": "Returns all ARP entries of a specific device discovered by running an IPv4\nreconciliation 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\nreconciliation 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\nreconciliation 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\nIPv4 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\nreconciliation 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\nreconciliation 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\nreconciliation 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\nwhich 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"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\nnetworks can using the ObjectProperties.hint,\nObjectProperties.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\nobject in the parent object hierarchy. The highest parent object is the\nconfiguration 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\nreturn. 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\nObjectProperties are ObjectProperties.hint,\nObjectProperties.accessRight, and\nObjectProperties.overrideType. Separate multiple options with a\npipe character. For example:\nhint=ab|overrideType=HostRecord|accessRight=ADD The values\nfor the ObjectProperties.hint option can be the prefix of the IP\naddress for a network or the name of a network.\n\n\n- Example 1\n
\nThe following example will match networks that have the network ID\nstarting with 192.168. For example, 192.168.0.0/24 or 192.168.1.0/24.\nString options = ObjectProperties.hint + “=198.168|”\n
\n \n\n- Example 2\n
\nThe following example will match networks that have a name starting with\n“abc”. For example, “abc”, “abc123” or “abcdef”.\nString options = ObjectProperties.hint + “=abc|”\n
\n \n
\nMatching networks to a network ID Example 1 will take precedence\nover matching networks to a name Example 2. The values for the\nObjectProperties.accessRight and\nObjectProperties.overrideType options must be one of the constants\nlisted in\n\nand .\nFor example:\nString options = ObjectProperties.accessRight + \"=\" + AccessRightValues.AddAccess +\n\"|\"+ 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\nlist 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\ncontainer 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"deprecated": false
}
},
"/v1/getIP6ObjectsByHint": {
"get": {
"tags": [
"ipam_methods"
],
"summary": "getIP6ObjectsByHint",
"description": "Returns an array of IPv6 objects found under a given container object. The\nnetworks can be filtered by using ObjectProperties.hint and\nObjectProperties.accessRight options. Currently, it only supports IPv6\nnetworks.",
"operationId": "getIP6ObjectsByHint",
"parameters": [
{
"name": "containerId",
"in": "query",
"description": "The object ID for the container object. It can be the object ID of any\nobject in the parent object hierarchy. The highest parent object is the\nconfiguration 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\nreturn.",
"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\nsupports ObjectTypes.IP6Network.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "options",
"in": "query",
"description": "A string containing options. The Option names available in\nObjectProperties are ObjectProperties.hint and\nObjectProperties.accessRight.\n\nMultiple options can be separated by a\n\npipe | character. For example: hint=ab|\naccessRight=ADD The values for the\nObjectProperties.hint option can be the prefix of the IP address\nfor a network or the name of a network.\n\n
\n- Example 1\n
\nThe following example will match networks that have the network ID\nstarting with 2000::. For example, 2000::/64.\nString options = ObjectProperties.hint + “=2000::|”\n
\n \n\n- Example 2\n
\nThe following example will match networks that have a name starting with\n“abc”. For example, “abc”, “abc123” or “abcdef”.\nString options = ObjectProperties.hint + “=abc|”\n
\n \n
\nMatching networks to a network ID Example 1 will take precedence\nover matching networks to a name Example 2.\n\n\nThe values for the ObjectProperties.accessRight option must be one\nof the constants listed in\n\nand .\nFor example:\nString options = ObjectProperties.accessRight + \"=\" + AccessRightValues.AddAccess;\n
",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"description": "Indicates where in the list of objects to start returning objects. The\nlist 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\nthis method to find the configuration, IPv4 or IPv6 block, network, or DHCP\nrange containing a specified address. You can specify the type of object to\nbe returned, or you can leave the type of object empty to find the most\ndirect 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\nlocated. This can be a configuration, IPv4 or IPv6 block, network, or\nDHCP range. Specify the configuration if you don't know the block,\nnetwork, 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\nObjectTypes.IP4Block or ObjectTypes.IP6Block,\nObjectTypes.IP4Network or ObjectTypes.IP6Network, or\nObjectTypes.DHCP4Range or ObjectTypes.DHCP6Range to find\nthe block, network, or range containing the IPv4 or IPv6 address. Specify\nan empty string\n\n\"\" 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"deprecated": false
}
},
"/v1/getLinkedNetworkConflicts": {
"get": {
"tags": [
"ipam_methods"
],
"summary": "getLinkedNetworkConflicts",
"description": "Get a list of deployment options that conflict with the associated networks\nor 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\ntemplate. Setting a value of zero returns all conflicting networks linked to the\ntemplate.",
"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\nrange 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\na 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\nthe 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\nconfiguration or block.",
"operationId": "getNextAvailableIP4Network",
"parameters": [
{
"name": "autoCreate",
"in": "query",
"description": "This Boolean value indicates whether the next available network should be\ncreated 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\nspecified 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\nthe number of hosts on the network. For example, if you are to find or\ncreate 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\nthe 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 \"|\"):\n\n\n- startOffset - This is optional. Specifies from which offset to\nretrieve the available IPv6 address. The valid values range from 0 to 2 ^ 63\n(2 to the power of 63).
\n\n- skip - This is optional. Specifies the IPv6 address ranges or IPv6 addresses to skip,\nseparated by a comma.
\n\n- includeDHCPRanges - This is optional. A boolean that specifies whether DHCP ranges should be included\nwhen retrieving the next available IPv6 address. The default value is false.
\n\n- numberOfAddresses - This is optional. The number of requested IPv6 addresses.\nThe default value is 1. The valid values are from 1 to 100.\nAll IPv6 addresses will be returned from a single network.
\n
",
"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\na configuration or block.",
"operationId": "getNextAvailableIPRange",
"parameters": [
{
"name": "parentId",
"in": "query",
"description": "The object ID of the parent object under which the next available range\nresides 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:\n\n\n- reuseExisting — True or False. This\nBoolean value indicates whether to search existing empty networks to find\nthe available IP range of specified size.
\n\n- isLargerAllowed — True or False. This\nBoolean value indicates whether to return larger networks than those\nspecified with the sizeparameter.
\n\n- autoCreate — True or False. This\nBoolean value indicates whether the next available IP range should be\ncreated in the parent object if it does not exist.
\n\n- traversalMethod —This parameter identifies the\nappropriate search algorithm to find the suitable object. The possible\nvalues are:\n\n
\n- TraversalMethodology.NO_TRAVERSAL\n\nNO_TRAVERSAL —will attempt to find the next range directly under the\nspecified parent object. It will not search through to the lower level\nobjects.
\n\n- TraversalMethodology.DEPTH_FIRST\n\nDEPTH_FIRST —will attempt to find the next range under the specified\nobject by iteratively through its children one by one. After exploring\nthe object recursively for its child ranges, it will move to the next\nchild object.
\n\n- TraversalMethodology.BREADTH_FIRST\n\nBREADTH_FIRST —will attempt to find the next range under the\nspecified object by iterative levels. It will first find the range\nimmediately below the specified parent object. If not found, then it will\nattempt to find the range under all the first child objects.
\n
\n \n
",
"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\nnetwork 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"deprecated": false
}
},
"/v1/getNextAvailableIPRanges": {
"get": {
"tags": [
"ipam_methods"
],
"summary": "getNextAvailableIPRanges",
"description": "Returns the object IDs for the next available (unused) blocks or networks\nwithin a configuration or block.",
"operationId": "getNextAvailableIPRanges",
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of networks to be found.\nIf the number of networks count\nis greater than 1:\n\n\n- isLargerAllowed and traversalMethod properties will not be\napplicable.
\n\n- The DEPTH_FIRST methodology will be used to search objects.
\n
\n",
"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\nresides 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:\n\n\n- reuseExisting — True or False. This\nBoolean value indicates whether to search existing empty networks to find\nthe available IP range of specified size.
\n\n- isLargerAllowed — True or False. This\nBoolean value indicates whether to return larger networks than those\nspecified with the sizeparameter.
\n\n- autoCreate — True or False. This\nBoolean value indicates whether the next available IP range should be\ncreated in the parent object if it does not exist.
\n\n- traversalMethod —This parameter identifies the\nappropriate search algorithm to find the suitable object. The possible\nvalues are:\n\n
\n- TraversalMethodology.DEPTH_FIRST\n\nDEPTH_FIRST —will attempt to find the next range under the specified\nobject by iteratively through its children one by one. After exploring\nthe object recursively for its child ranges, it will move to the next\nchild object.
\n
\n \n
\nIf a value is not provided for the following parameters:\nreuseExisting and autoCreate, the default values will be as follows:\nreuseExisting = 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\nis 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\ncircumstances.",
"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,\noffset and excludeDHCPRange. The values for\nskip and offset must be IPv4 addresses and must appear in\ndotted octet notation.\n\n\n- skip - This is optional. It is used to specify the IP address\nranges or IP addresses to skip, separated by comma. A hyphen (-), not a\ndash is used to separate the start and end addresses. Do not use\nthe skip property if the parentId is a configuration Id.\nIf you do, an error message appears, ‘Skip is not allowed for\nconfiguration level’.
\n\n- offset - This is optional. This is to specify from which\naddress to start to assign IPv4 Address.
\n\n\n- excludeDHCPRange - This specifies whether IP addresses\nin DHCP ranges should be excluded from assignment. The value is either\ntrue or false, default value is\nfalse.
skip=10.10.10.128-10.10.11.200,10.10.11.210|\noffset=10.10.10.100|excludeDHCPRange=true| \n
",
"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\naddress.",
"operationId": "isAddressAllocated",
"parameters": [
{
"name": "configurationId",
"in": "query",
"description": "The object ID of the parent configuration in which the MAC address\nresides.",
"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\nnn: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\nthe same parent and must be contiguous. Blocks whose parent object is the\nconfiguration 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\nIPv4 network. The list of objects to be merged must all be of the same type\n(for example, all blocks or all networks). The objects must all have the same\nparent 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\nafter 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\nto 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,\nIPv4 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.\n\n\n- noServerUpdate - A boolean value. If set to\ntrue, instant dynamic host record changes will not be\nperformed on DNS/DHCP Servers when moving an IPv4 address object.
\n
\nnoServerUpdate works only for an IPv4 address\nobject.",
"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\nobject before you can re-apply or remove it.",
"operationId": "reapplyTemplate",
"parameters": [
{
"name": "properties",
"in": "query",
"description": "A string containing the following settings:\n\n\n- The properties value must include\nObjectProperties.templateType with the value of\nObjectProperties.zoneTemplateType.
\n\n- If the re-apply mode is not specified in the properties, the default\nObjectProperties.templateReapplyModeIgnore mode is used.
\n\n- The available re-apply modes include:\n\n
\n- ObjectProperties.templateReapplyModeUpdate
\n\n- ObjectProperties.templateReapplyModeIgnore
\n\n- ObjectProperties.templateReapplyModeOverwrite
\n
\n \n
\n\n\n\n- ObjectProperties.templateReapplyModeOverwrite is not\napplicable for Gateway and Reserved Addresses. Use\nObjectProperties.templateReapplyModeUpdate instead to update.
\n\n- ObjectProperties.templateReapplyModeUpdate is not applicable\nfor Reserved DHCP Ranges, IP Groups and Zone\nTemplates. Use ObjectProperties.templateReapplyModeOverwrite\ninstead to update.
\n\n- Both ObjectProperties.templateReapplyModeUpdate and\nObjectProperties.templateReapplyModeOverwrite are applicable for\nDeployment Options.
\n
\n",
"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\nIPv6 address or as a MAC address from\nwhich the new IPv6 address can be calculated. Specify the MAC address\nin the format nnnnnnnnnnnn or nn-nn-nn-nn-nn-nn,\nwhere 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\ninterface.",
"operationId": "removeAdditionalIPAddresses",
"parameters": [
{
"name": "ipsToRemove",
"in": "query",
"description": "The list of IP addresses to be removed. You can specify multiple IP\naddresses with a separator (|). The supported format is [IP,serviceType| IP,serviceType]. For\nexample, 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.\nReserved 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\naddresses 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\nIPv6 network.",
"operationId": "resizeRange",
"parameters": [
{
"name": "objectId",
"in": "query",
"description": "The ID of the object to be resized. Currently IPv4 block, IPv4 network,\nDHCPv4 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:\n\n\n- ObjectProperties.convertOrphanedIPAddressesTo This\noption applies only to DHCPv4 range.\n
\nThe possible values are:\n\n
\n- STATIC
\n\n- DHCP_RESERVED
\n\n- UNALLOCATED
\n
\n\n\nFor example: service.resizeRange\n<rangeID>, <\"ipAddressStart-ipAddressEnd\">, \"convertOrphanedIPAddressesTo=<value>\";\n\n
\n- If the value is an empty string\n\n\"\", the default is DHCP_RESERVED.
\n\n- If the option value is incorrect, an exception will be thrown.
\n\n- If the option name is incorrect, the option will be ignored.\nTherefore, orphaned IP addresses will remain as assigned.
\n
\n\n \n
",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "range",
"in": "query",
"description": "The new size for the object to be resized.\n\nFor the IPv4 block, IPv4 network or DHCPv4 range, specify the size in\nCIDR notation or as an address range in the\nipAddressStart-ipAddressEnd format.\n
\n\nFor the IPv6 block or IPv6 network, specify the size in Starting\naddress/Size format.\n
",
"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:\n\n\n- assignDefaultGateway—a Boolean value. If set to\ntrue, a gateway will be created by using the default\ngateway value which is the first IP address in the network. If set to\nfalse, no gateway will be created. The default value is\ntrue.
\n\n- overwriteConflicts—a Boolean value. If set to\ntrue, any conflicts within the split IPv4 network will be\nremoved. The default value is false.
\n\n- preserveGateway—a Boolean value. If set to\ntrue, the gateway in the original network will be\npreserved. The default value is true.\n\n
\n- For the above options only true and\nfalse are accepted. These values are case sensitive. Other\nvalues such as TRUE, FALSE, True, False,\ntRue, xxxx, 123, etc., will not be\naccepted.
\n
\n \n\n- template—a network template ID. The default value is zero (0) which\nmeans no network template will be used. Specify a network template ID if\nyou wish to apply one.
\n
",
"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\nnetworks.",
"operationId": "splitIP6Range",
"parameters": [
{
"name": "numberOfParts",
"in": "query",
"description": "The number of the blocks or networks into which the block or network will\nbe 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.\nSpecify a filename to determine if the specified file is migrating. Specify\nan empty string (\"\") to determine if any migration files are migrating or\nqueued for migration.",
"operationId": "isMigrationRunning",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The filename of the XML file in the data/migration/incoming directory. Do\nnot 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\nreside in the /data/migration/incoming directory on the Address Manager\nserver.",
"operationId": "migrateFile",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The filename of the XML file in the data/migration/incoming directory. Do\nnot 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:\n\n\n- inherited—either true or false;indicates whether or not the\ndeployment role was inherited.
\n\n- secondaryServerInterfaceId—the object ID of the\nsecondary server interface for a DHCP failover.
\n
",
"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\nin .",
"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\ndeployment 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\n.",
"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\nor appliance being added and determines the services that can be deployed\nto 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:\n\n\n- connected —either true or false;\nindicates whether or not to connect to a server. In order to add and\nconfigure multi-port DNS/DHCP Servers, this option must be set to true.\nIf false, other interface property options will be ignored.
\n\n- upgrade —indicates whether or not to apply the latest version\nof DNS/DHCP Server software once the appliance is under Address Manager\ncontrol. The value is either true or false\n\nby default, true.
\n\n- password —the server password by default, bluecat.
\n\n- servicesIPv4Address —IPv4 address used only for\nservices traffic such as DNS, DHCP, DHCPv6, and TFTP. If dedicated\nmanagement is enabled, this option must be specified.
\n\n- servicesIPv4Netmask —IPv4 netmask used only for\nservices traffic such as DNS, DHCP, DHCPv6, and TFTP. If dedicated\nmanagement is enabled, this option must be specified.
\n\n- servicesIPv6Address —IPv6 address used only for\nservices traffic such as DNS, DHCP, DHCPv6, and TFTP. This is\noptional.
\n\n- servicesIPv6Subnet —IPv6 subnet used only for services\ntraffic such as DNS, DHCP, DHCPv6, and TFTP. This is optional.
\n\n- xhaIPv4Address —IPv4 address used for XHA. This is\noptional.
\n\n- xhaIPv4Netmask —IPv4 netmask used for XHA. This is\noptional.
\n\n- redundancyScenario —networking redundancy scenarios.\nThe possible values are ACTIVE_BACKUP Failover and IEEE_802_3AD\nLoad Balancing.
\n
\nFor DNS/DHCP Servers without multi-port support, the\ninterface-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\ndeleted.",
"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\nto 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\ndeleted.",
"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\nassigned.",
"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\nspace 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\ndeleted.",
"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\nassigned.",
"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\nObjectProperties are ObjectProperties.services, and\nObjectProperties.forceDNSFullDeployment. Multiple options can be\nseparated by a pipe (|) character. For example:\nObjectProperties.services=DNS|\nforceDNSFullDeployment=true The values for properties are:\n\n\n- services —the name of the valid service configuration that\nneeds to be deployed. These are the valid values for the services: DNS,\nDHCP, DHCPv6, and TFTP.
\n\n- forceDNSFullDeployment —a boolean value. Set to\ntrue to perform a full DNS deployment. Omit this parameter\nfrom the method call to perform a differential deployment.
\n
",
"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\ndeployed.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "services",
"in": "query",
"description": "\nThe name of the valid services to be deployed. Specify multiple services\nusing a comma(,). The valid format is services=DNS,DHCP,TFTP\n
",
"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": {
"$ref": "#/components/schemas/APIDeploymentRole"
}
}
}
}
},
"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\nassigned.",
"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\nassigned.",
"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": {
"$ref": "#/components/schemas/APIDeploymentRole"
}
}
}
}
},
"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\nspace for ARPA zones.",
"operationId": "getDNSDeploymentRoleForView",
"parameters": [
{
"name": "entityId",
"in": "query",
"description": "The object ID for the object to which the DNS deployment role is\nassigned.",
"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\nassigned.",
"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": {
"$ref": "#/components/schemas/APIDeploymentRole"
}
}
}
}
},
"deprecated": false
}
},
"/v1/getDeploymentRoles": {
"get": {
"tags": [
"server_deployment_methods"
],
"summary": "getDeploymentRoles",
"description": "Returns the DNS and DHCP deployment roles associated with the specified\nobject. For DNS views and zones, getDeploymentRoles returns DNS deployment\nroles. For IP address space objects, such as IPv4 blocks and networks, IPv6\nblocks and networks, DHCP classes, and MAC pools, getDeploymentRoles\nreturns 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\nor 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\nthe selectiveDeploy API method.",
"operationId": "getDeploymentTaskStatus",
"parameters": [
{
"name": "deploymentTaskToken",
"in": "query",
"description": "The string token value that is returned from the\nselectiveDeploy} 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": {
"$ref": "#/components/schemas/APIEntity"
}
}
}
}
},
"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\ninterface of another server.",
"operationId": "moveDeploymentRoles",
"parameters": [
{
"name": "moveDhcpRoles",
"in": "query",
"description": "If set to true, DHCP roles will be moved to the target\nserver 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\nserver 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\nare 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\nsince the last full or quick deployment. This method only applies to DNS\nresource 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\nneeds 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\nempty.\n\n\n- services —the name of the valid service that need to be\ndeployed. The only valid service name for quick deployment is\nDNS. Any other service names will throw an error.
\n
",
"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:\n\n\n- servicesIPv4Address —IPv4 address used only for\nservices traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated\nmanagement is enabled, this option must be specified. If dedicated\nmanagement is disabled, this address must be the same as\ndefaultInterfaceAddress which is management interface address.
\n\n- servicesIPv4Netmask —IPv4 netmask used only for\nservices traffic such as DNS, DHCP, DHCPv6 and TFTP. If dedicated\nmanagement is enabled, this option must be specified. If dedicated\nmanagement is disabled, this netmask address must be the same as the\nmanagement interface netmask address.
\n\n- servicesIPv6Address —IPv6 address used only for\nservices traffic such as DNS, DHCP, DHCPv6 and TFTP. This is\noptional.
\n\n- servicesIPv6Subnet —IPv6 subnet used only for services\ntraffic such as DNS, DHCP, DHCPv6 and TFTP. This is optional.
\n\n- xhaIPv4Address —IPv4 address used for XHA. This is\noptional.
\n\n- xhaIPv4Netmask —IPv4 netmask used for XHA. This is\noptional.
\n\n- redundancyScenario —networking redundancy scenarios.\nThe possible values are ACTIVE_BACKUP Failover and IEEE_802_3AD\nLoad Balancing.
\n\n- resetServices —allows you to replace the DNS/DHCP\nServer while maintaining existing configurations for DNS, DHCP, and TFTP\nservices. Define this option only if you have modified the IPv4 or IPv6\naddresses of the Services interface or wish to reset configurations for\nDNS, DHCP, and TFTP services on the DNS/DHCP Server. The value is either\ntrue or false by default, false.
\n
\nFor DNS/DHCP Servers without multi-port support, the\ninterface-related property options will be ignored.\nResetting DNS/DHCP Servers will result in a service outage. This\nservice outage will last until you have deployed services to the\nreplacement system. Only reset DNS/DHCP Server services if you are\nreplacing the DNS/DHCP Server with a new appliance of a different type\nor reconfiguring the IPv4 or IPv6 addresses of the Services interface\non the appliance. BlueCat recommends that you schedule a maintenance\nwindow 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\nserver 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\nentities, 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:\n\n\n- scope —a string value. This property defines whether the\ndeployment task includes objects that are related to the defined DNS\nresource records. The scope can be one of the following values:\n\n
\n- related (default value) —deploys the DNS resource records\ndefined in the entityIds list including DNS resource records that are\nrelated to those entities. For more information on additional entities\nthat are deployed when the related scope is defined, refer to\n.
\n\n- specific —deploys only the DNS resource records that are\ndefined in the entityIds list.
\n
\n \n
\n\n\n- batchMode —an enum value. This property batches selective\ndeployment tasks. The scope can be one of the following values:\n\n
\n- disabled (default value)\n\n\n—disables the batching of selective deployment tasks.
\n\n- batch_by_server —enables the batching of selective deployment\ntasks.
\n
\nThe batching of selective deployment tasks is dependent on the\nfollowing conditions:\n\n\n- The tasks are from the same server.
\n\n- Each deployment task that is configured for batching must have\nbatchMode set to batch_by_server.
\n\n- The batched deployment contains less than 100 resource records.
\n
\n \n
\n\n\n- continueOnFailure —a boolean value. This property specifies\nthe mode of operation on a failed resource record. If set to false,\ndeployment stops when a record fails. If set to true,\ndeployment continues when a record fails and moves to the next record.\nThe default value is true if batchMode is set to\nbatch_by_server, otherwise the default value is false.
\n
\n\n\n- dynamicRecords —an enum value. This\nproperty defines how dynamic records are handled\nwith selective deployment tasks. The value can be\none of the following:
\n- fail (default value) —the selective\ndeployment task fails when a dynamic record is\nencountered.
\n- skip —skips dynamic records by removing\nthem from the list of entity IDs before the\nselective deployment task is performed.If\nyou perform a selective deployment where all\nentities are dynamic and you define the\nskip option, all records will be removed\nfrom the selective deployment task and the\ndeployment fails with the following\nmessage:
Verify input error.: Empty entity id input\n \n- makestatic —dynamic records are updated\nto static records before the selective deployment\ntask is performed. This has no effect on related\nrecords that are deployed using the related\nscope.If you define the makestatic\noption and the selective deployment task fails for\nany reason, the updated records are not rolled\nback and remain static records.
\n \n
",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A list of entity IDs that specify the DNS entities to deploy. Currently,\nonly DNS resource records are supported. Restrictions:\n\n\n- You can only deploy a maximum of 100 DNS entities per selective\ndeployment API call.
\n\n- You cannot deploy dynamic records.
\n\n- You cannot deploy external host records.
\n\n- You cannot deploy resource records if they belong to multiple\nDNS/DHCP Servers.
\n
\n",
"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,\nonly DNS resource records are supported. Restrictions:\n\n\n- You can only deploy a maximum of 100 DNS entities per selective\ndeployment API call.
\n\n- You cannot deploy dynamic records.
\n\n- You cannot deploy external host records.
\n\n- You cannot deploy resource records if they belong to multiple\nDNS/DHCP Servers.
\n
\n"
}
}
},
"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/APIDeploymentRole"
},
{
"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/APIDeploymentRole"
},
{
"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\nalways 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\ndescription 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\npassed 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\neither 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\nthe constants listed in\n.",
"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/APIUserDefinedField"
},
{
"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\nthe constants listed in\n.",
"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\nreturned 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\nthe constants listed in\n.",
"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\nas a byte array that is the stream of the CSV file contents. The file\nmust follow the following pattern:\n\n\n- EntityId - The object ID of the entity on which the UDF needs\nto be updated. You must enter this into the first column.
\n\n- UDFName - The actual name of the UDF that needs to be updated.\nYou must enter this into the second column.
\n\n- newUDFValue - The new value of the UDF which needs to\nbe updated on the entity. You must enter this into the third\ncolumn.
\n
\n\n\n\n- The file format should be CSV.
\n\n- The file should not contain any header.
\n\n- The data should start from the first line.
\n\n- To include any special characters, users need to escape the\ndata.
\n
\n",
"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\nthe constants listed in\n.",
"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/APIUserDefinedField"
},
{
"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\nor not the xHA pair breaks in the Address Manager interface only. This\nargument breaks the xHA pair in Address Manager, even if the xHA settings\nare 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\ninterface of the active server used during creation of the pair. The\noriginal IP address of the active server is assigned to the virtual\ninterface.",
"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\n.",
"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\n.",
"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\napplies. This value must be greater than 0.",
"format": "int64"
},
"userId": {
"type": "integer",
"description": "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"format": "int64"
},
"value": {
"type": "string",
"description": "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null."
},
"overrides": {
"type": "string",
"description": "Indicates the types that are to be overridden in the\naccess right in the format\nobjectType=accessRightValue where\nobjectType is the same object type used in\nAPIEntity and accessRightValue is one of HIDE, VIEW,\nADD, CHANGE or FULL. Multiple override elements are\nseparated by a | (pipe) character."
},
"properties": {
"type": "string",
"description": "A string containing extra properties for the object in\nthe 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\nNETWORK_BLOOM or LEASE_COUNT_PER_DATE."
},
"properties": {
"type": "string",
"description": "A string containing extra properties for the object in\nthe 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\nTypes. 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;\nmultiple values are comma-separated. This field cannot be\nnull."
},
"properties": {
"type": "string",
"description": "A string containing additional properties. This is used\nfor user-defined fields on most objects, but also passes\nsome values that do not have their own specific\nparameter."
}
},
"description": "Deployment options configure both DHCP and DNS services on the network. They are\navailable as DHCP client and service options, including standard DNS options.\nDeployment 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,\nSLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD\nMASTER). 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\nthan 0.",
"format": "int64"
},
"serverInterfaceId": {
"type": "integer",
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"format": "int64"
},
"properties": {
"type": "string",
"description": "A string containing extra properties for the object in\nthe format