{
"id": "@itentialopensource/adapter-bluecat",
"type": "Adapter",
"export": "Bluecat",
"title": "Bluecat",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "addACL",
"summary": "Adds an Access Control List (ACL) to a view.",
"description": "Adds an Access Control List (ACL) to a view.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration on which ACL need to be added.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the ACL.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the comma-separated list of options in the following\nformat:\n aclValues=IP4Address, IP6Address, IP4Network’s CIDR, IP6Network’s CIDR, ACL’s name,\nTSIG...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addACL"
},
"task": true
},
{
"name": "addAliasRecord",
"summary": "Adds alias records.",
"description": "Adds alias records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the alias. If you are adding a record in a zone that is\nlinked to an incremental naming policy, you must add a single hash (#) sign\nat the appropriate locatio...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "linkedRecordName",
"type": "string",
"info": "The name of the record to which this alias will link.: string",
"required": false,
"schema": {
"title": "linkedRecordName",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record. To ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which this record is being added.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addAliasRecord"
},
"task": true
},
{
"name": "addBulkHostRecord",
"summary": "Adds bulk host records using auto-increment from the specific starting address.",
"description": "Adds bulk host records using auto-increment from the specific starting address.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the host record. If you are adding a record in a zone that\nis linked to an incremental naming policy, you must add a single hash sign (#)\nat the appropriate l...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "networkId",
"type": "number",
"info": "The network receiving the available IP addresses. Each address is used\nfor one host record.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "numberOfAddresses",
"type": "number",
"info": "The number of addresses.: 123",
"required": false,
"schema": {
"title": "numberOfAddresses",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "excludeDHCPRange = true/false . If true, then IP\naddresses within a DHCP range will be skipped. This argument can also\ncontain user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "startAddress",
"type": "string",
"info": "The starting IPv4 address for getting the available addresses.: string",
"required": false,
"schema": {
"title": "startAddress",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record. To ignore the TTL, set the value\nto -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which you are adding the record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of host record APIEntity objects based on available addresses and number of IP addresses required. If no addresses are available, an error will be shown.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addBulkHostRecord"
},
"task": true
},
{
"name": "addDNSDeploymentOption",
"summary": "Adds DNS options.",
"description": "Adds DNS options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which you are adding the deployment option.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DNS option you are adding. This name must be one of the\nconstants listed in .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value you are assigning to the option. Depending on the type of\ndeployment option you are adding, the format of the value might differ. For\nmore information, refer to...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDNSDeploymentOption"
},
"task": true
},
{
"name": "addEnumNumber",
"summary": "Adds ENUM numbers.",
"description": "Adds ENUM numbers.",
"input": [
{
"name": "enumZoneId",
"type": "number",
"info": "The object ID of the parent object for the ENUM number. The parent object\nfor an ENUM number is always an ENUM zone.: 123",
"required": false,
"schema": {
"title": "enumZoneId",
"type": "number"
}
},
{
"name": "number",
"type": "number",
"info": "The ENUM phone number.: 123",
"required": false,
"schema": {
"title": "number",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties and user-defined fields, including the\n data string, which includes service , URI ,\n comment , and ttl values.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addEnumNumber"
},
"task": true
},
{
"name": "addEnumZone",
"summary": "Adds ENUM zones.",
"description": "Adds ENUM zones.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The object ID for the parent object of the ENUM zone.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "prefix",
"type": "number",
"info": "The number prefix for the ENUM zone.: 123",
"required": false,
"schema": {
"title": "prefix",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addEnumZone"
},
"task": true
},
{
"name": "addExternalHostRecord",
"summary": "Adds external host records.",
"description": "Adds external host records.",
"input": [
{
"name": "name",
"type": "string",
"info": "The FQDN of the host record.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which you are adding the record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addExternalHostRecord"
},
"task": true
},
{
"name": "addGenericRecord",
"summary": "Adds generic records.",
"description": "Adds generic records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the record. If you are adding a record in a zone that is\nlinked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate locatio...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "rdata",
"type": "string",
"info": "The data for the resource record, in BIND format. For example, A\nrecords follow the format 10.0.0.4.: string",
"required": false,
"schema": {
"title": "rdata",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of record. Valid settings for this parameter are the\ngeneric resource record types supported in Address Manager: A6, AAAA,\nAFSDB, APL, CAA, CERT, DHCID, DNAME, D...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which you are adding the record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addGenericRecord"
},
"task": true
},
{
"name": "addHINFORecord",
"summary": "Adds HINFO records.",
"description": "Adds HINFO records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the HINFO record. If you are adding a record in a zone that\nis linked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate l...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "cpu",
"type": "string",
"info": "A string providing central processing unit information.: string",
"required": false,
"schema": {
"title": "cpu",
"type": "string"
}
},
{
"name": "os",
"type": "string",
"info": "A string providing operating system information.: string",
"required": false,
"schema": {
"title": "os",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which you are adding the HINFO record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addHINFORecord"
},
"task": true
},
{
"name": "addHostRecord",
"summary": "Adds host records for IPv4 or IPv6 addresses.",
"description": "Adds host records for IPv4 or IPv6 addresses. All addresses must be valid\naddresses.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the host record. If you are adding a record in a zone that\nis linked to an incremental naming policy, you must add a single hash (#) sign\nat the appropriate l...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "addresses",
"type": "string",
"info": "A list of comma-separated IP addresses, for example, 10.0.0.5,130.4.5.2 .: string",
"required": false,
"schema": {
"title": "addresses",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record. To ignore the TTL, set the value\nto -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which this record is being added.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addHostRecord"
},
"task": true
},
{
"name": "addMXRecord",
"summary": "Adds MX records.",
"description": "Adds MX records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the record. If you are adding a record in a zone that is\nlinked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate locatio...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "linkedRecordName",
"type": "string",
"info": "The FQDN of the host record to which this MX record is linked.: string",
"required": false,
"schema": {
"title": "linkedRecordName",
"type": "string"
}
},
{
"name": "priority",
"type": "number",
"info": "Specifies which mail server to send clients to first when multiple\nmatching MX records are present. Multiple MX records with equal priority\nvalues are referred to in a ro...(description truncated): 123",
"required": false,
"schema": {
"title": "priority",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view where you wish to add the MX record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addMXRecord"
},
"task": true
},
{
"name": "addNAPTRRecord",
"summary": "Adds NAPTR records.",
"description": "Adds NAPTR records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN for the record. If you are adding a record in a zone that is\nlinked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate locati...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "flags",
"type": "string",
"info": "An optional parameter used to set flag values for the record.: string",
"required": false,
"schema": {
"title": "flags",
"type": "string"
}
},
{
"name": "order",
"type": "number",
"info": "Specifies the order in which NAPTR records are read if several are\npresent and are possible matches. The lower ordervalue takes precedence.: 123",
"required": false,
"schema": {
"title": "order",
"type": "number"
}
},
{
"name": "preference",
"type": "number",
"info": "Specifies the order in which NAPTR records are read if the ordervalues\nare the same in multiple records. The lower preferencevalue takes\nprecedence.: 123",
"required": false,
"schema": {
"title": "preference",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "regexp",
"type": "string",
"info": "A regular expression, enclosed in double quotation marks, used to\ntransform the client data. If you do not specify a regular expression,\nyou must specify a domain name in...(description truncated): string",
"required": false,
"schema": {
"title": "regexp",
"type": "string"
}
},
{
"name": "replacement",
"type": "string",
"info": "Specifies a domain name as an alternative to the regexp. This parameter\nreplaces client data with a domain name.: string",
"required": false,
"schema": {
"title": "replacement",
"type": "string"
}
},
{
"name": "service",
"type": "string",
"info": "Specifies the service used for the NAPTR record. Valid settings for this\nparameter are listed in\n .: string",
"required": false,
"schema": {
"title": "service",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view where you wish to add the record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addNAPTRRecord"
},
"task": true
},
{
"name": "addResourceRecord",
"summary": "Add resource records.",
"description": "Add resource records.\n\nThis method is a generic method for adding resource records of any kind by\nspecifying the name, type, and rdata arguments.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The absolute name of the record, specified as an FQDN. If you are adding\na record in a zone that is linked to a incremental naming policy, you must add a\nsingle hash sign...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "rdata",
"type": "string",
"info": "The data for the resource record in BIND format. For example, an A\nrecord in the format A 10.0.0.4. You can specify either a single IPv4 or IPv6 address\nfor the record.: string",
"required": false,
"schema": {
"title": "rdata",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of record being added. Valid values for this parameter are the\nresource record types shown in\n Object Types :\n\n AliasRecord\n HINFORecord\n HostRecord\n MXRecor...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view where you wish to add the resource record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addResourceRecord"
},
"task": true
},
{
"name": "addResponsePolicy",
"summary": "Adds a DNS response policy.",
"description": "Adds a DNS response policy.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration to which you are adding the response policy.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DNS response policy you are adding.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options, including comments and user-defined fields.\n If you configure a redirect response policy, you must\nalso specify the redirectTarget property...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "responsePolicyType",
"type": "string",
"info": "The type of response policy you are adding. The available values are\nBLACKLIST, BLACKHOLE, WHITELIST, and REDIRECT. The\n responsePolicyType values must be in CAPITAL\nl...(description truncated): string",
"required": false,
"schema": {
"title": "responsePolicyType",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value in seconds.: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addResponsePolicy"
},
"task": true
},
{
"name": "addResponsePolicyItem",
"summary": "Adds a DNS response policy item under a specified local DNS response policy.",
"description": "Adds a DNS response policy item under a specified local DNS response policy.",
"input": [
{
"name": "itemName",
"type": "string",
"info": "The FQDN of the response policy item.: string",
"required": false,
"schema": {
"title": "itemName",
"type": "string"
}
},
{
"name": "options",
"type": "array",
"info": "Reserved for future use.: array",
"required": false,
"schema": {
"title": "options",
"type": "array"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID of the parent local response policy to which the response\npolicy item is being added.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addResponsePolicyItem"
},
"task": true
},
{
"name": "addSRVRecord",
"summary": "Adds SRV records.",
"description": "Adds SRV records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the SRV record. If you are adding a record in a zone that is\nlinked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate loc...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "linkedRecordName",
"type": "string",
"info": "The FQDN of the host record to which this SRV record is linked.: string",
"required": false,
"schema": {
"title": "linkedRecordName",
"type": "string"
}
},
{
"name": "port",
"type": "number",
"info": "The TCP/UDP port on which the service is available.: 123",
"required": false,
"schema": {
"title": "port",
"type": "number"
}
},
{
"name": "priority",
"type": "number",
"info": "Specifies which SRV record to use when multiple matching SRV records are\npresent. The record with the lowest value takes precedence.: 123",
"required": false,
"schema": {
"title": "priority",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view where you wish to add the SRV record.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
},
{
"name": "weight",
"type": "number",
"info": "If two matching SRV records within a zone have equal priority, the weight\nvalue is checked. If the weight value for one object is higher than the\nother, the record with t...(description truncated): 123",
"required": false,
"schema": {
"title": "weight",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addSRVRecord"
},
"task": true
},
{
"name": "addStartOfAuthority",
"summary": "Adds SOA records.",
"description": "Adds SOA records.",
"input": [
{
"name": "email",
"type": "string",
"info": "Specifies the email address of the administrator for the zones to which\nthe SOA applies.: string",
"required": false,
"schema": {
"title": "email",
"type": "string"
}
},
{
"name": "expire",
"type": "number",
"info": "Specifies the length of time that a slave server will use a non-updated\nset of zone data before it stops sending queries. This is specified as a\nnumber of seconds using a...(description truncated): 123",
"required": false,
"schema": {
"title": "expire",
"type": "number"
}
},
{
"name": "minimum",
"type": "number",
"info": "Specifies the maximum amount of time that a negative cache response is\nheld in cache. A negative cache response is a response to a DNS query\nthat does not return an IP ad...(description truncated): 123",
"required": false,
"schema": {
"title": "minimum",
"type": "number"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the SOA record.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields. The\nsupported properties are time-to-live TTL , primary server\nmname and serial number format\n\nser...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "refresh",
"type": "number",
"info": "The amount of time that a slave server waits before attempting to refresh\nzone files from the master server. This is specified in seconds using a\n32-bit integer value. RF...(description truncated): 123",
"required": false,
"schema": {
"title": "refresh",
"type": "number"
}
},
{
"name": "retry",
"type": "number",
"info": "Specifies the amount of time that the slave server should wait before\nre-attempting a zone transfer from the master server after the refresh\nvalue has expired. This is sp...(description truncated): 123",
"required": false,
"schema": {
"title": "retry",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addStartOfAuthority"
},
"task": true
},
{
"name": "addTXTRecord",
"summary": "Adds TXT records.",
"description": "Adds TXT records.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The FQDN of the text record. If you are adding a record in a zone that is\nlinked to a incremental naming policy, you must add a single hash sign (#)\nat the appropriate lo...(description truncated): string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "ttl",
"type": "number",
"info": "The time-to-live (TTL) value for the record.\nTo ignore the TTL, set the value to -1 .: 123",
"required": false,
"schema": {
"title": "ttl",
"type": "number"
}
},
{
"name": "txt",
"type": "string",
"info": "The text data for the record.: string",
"required": false,
"schema": {
"title": "txt",
"type": "string"
}
},
{
"name": "viewId",
"type": "number",
"info": "The object ID for the parent view to which the record is being added.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTXTRecord"
},
"task": true
},
{
"name": "addView",
"summary": "Adds DNS views.",
"description": "Adds DNS views.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration in which this DNS view is\nlocated.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the view.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addView"
},
"task": true
},
{
"name": "addZone",
"summary": "Adds DNS zones.",
"description": "Adds DNS zones. When using addZone , you can use dot (.) characters to\ncreate the top-level domain and subzones.",
"input": [
{
"name": "absoluteName",
"type": "string",
"info": "The complete FQDN of the zone with no trailing dot, for example,\nexample.com.: string",
"required": false,
"schema": {
"title": "absoluteName",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID for the parent object to which the zone is being added. For\ntop-level domains, the parent object is a DNS view. For sub-zones, the\nparent object is a top-le...(description truncated): 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including a flag for deployment, an optional\nnetwork template association, and user-defined fields in the format:\n deployable=<true|false>|t...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addZone"
},
"task": true
},
{
"name": "addZoneTemplate",
"summary": "Adds a DNS zone template.",
"description": "Adds a DNS zone template.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the DNS zone template. This value can be an empty string (\"\").: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent DNS view if adding a view-level zone\ntemplate. The object ID of the configuration if adding a\n configuration-level zone template.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addZoneTemplate"
},
"task": true
},
{
"name": "deleteDNSDeploymentOption",
"summary": "Deletes DNS options.",
"description": "Deletes DNS options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which the deployment option is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DNS option being deleted. This name must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which the option is assigned. To\ndelete an option that has not been assigned to a server role, set this\nvalue to 0 (zero). Omitt...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDNSDeploymentOption"
},
"task": true
},
{
"name": "deleteResponsePolicyItem",
"summary": "Deletes a DNS response policy item under a specified local DNS response\npolicy.",
"description": "Deletes a DNS response policy item under a specified local DNS response\npolicy.",
"input": [
{
"name": "itemName",
"type": "string",
"info": "The FQDN of the response policy item.\n When deleting a response policy item, the exact FQDN of the\nresponse policy item must be used.: string",
"required": false,
"schema": {
"title": "itemName",
"type": "string"
}
},
{
"name": "options",
"type": "array",
"info": "Reserved for future use.: array",
"required": false,
"schema": {
"title": "options",
"type": "array"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID of the parent local response policy to which the response\npolicy item is being deleted.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteResponsePolicyItem"
},
"task": true
},
{
"name": "findResponsePoliciesWithItem",
"summary": "Finds local DNS response policies with their associated response policy items.",
"description": "Finds local DNS response policies with their associated response policy items.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration to which the local response policies\nare located.\n\nTo view a complete list of all local response policies under all\nconfigurations tha...(description truncated): 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "itemName",
"type": "string",
"info": "The FQDN of the response policy item.\n The exact FQDN of the response policy item must be used when\nconducting a search.: string",
"required": false,
"schema": {
"title": "itemName",
"type": "string"
}
},
{
"name": "options",
"type": "array",
"info": "Reserved for future use.: array",
"required": false,
"schema": {
"title": "options",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns a list of local response policies along with the associated response policy item under a specific configuration or all configurations. This is determined by the input provided for the configurationId parameter.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/findResponsePoliciesWithItem"
},
"task": true
},
{
"name": "getDNSDeploymentOption",
"summary": "Retrieves all DNS options assigned for the object specified excluding the\noptions inherited from th",
"description": "Retrieves all DNS options assigned for the object specified excluding the\noptions inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which this deployment option is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DNS option. This name must be one of the constants listed\nin .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which this option is assigned. To\nretrieve an option that has not been assigned to a server role, set this\nvalue to 0 (zero). Om...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDNSDeploymentOption"
},
"task": true
},
{
"name": "getHostRecordsByHint",
"summary": "Returns an array of objects with host record type.",
"description": "Returns an array of objects with host record type.",
"input": [
{
"name": "count",
"type": "number",
"info": "Indicates the maximum of child objects that this method will return. The\nvalue must be less than or equal to 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing options. The supported options are hint and\n retrieveFields . Separate multiple options with a\npipe character. For example: hint=^abc|retrieveField...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of objects to start returning objects. The\nlist begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of host record APIEntity objects.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getHostRecordsByHint"
},
"task": true
},
{
"name": "getKSK",
"summary": "Returns a string containing all active Key Signing Keys (KSK) for a given\nentityId value in a speci",
"description": "Returns a string containing all active Key Signing Keys (KSK) for a given\nentityId value in a specified output format with its start time and expire\ntime, divided by a delimiter (|). The list of returned KSKs is sorted in\ndescending order by expiry date.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity associated with the KSK. The only supported\nentity types are zone, IPv4 block, and IPv4 network.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "format",
"type": "string",
"info": "The output format of the KSK of an entity. The value must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns a string containing up to two active KSK(s) of an entity.",
"type": "array",
"items": {
"type": "string"
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getKSK"
},
"task": true
},
{
"name": "getNetworkLinkedProperties",
"summary": "Returns an array of IP addresses with linked records and the IP addresses\nthat are assigned as DHCP",
"description": "Returns an array of IP addresses with linked records and the IP addresses\nthat are assigned as DHCP Reserved, Static, or Gateway.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID for the IPv4 network.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of IP address APIEntity objects with their linked host records and the IP addresses that are assigned as DHCP Reserved, Static or Gateway. The output has the following format: hostId : hostName : zoneId : zoneName : viewId : viewName : hasAlias;.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNetworkLinkedProperties"
},
"task": true
},
{
"name": "getZonesByHint",
"summary": "Returns an array of accessible zones of child objects for a given containerId\nvalue.",
"description": "Returns an array of accessible zones of child objects for a given containerId\nvalue.",
"input": [
{
"name": "containerId",
"type": "number",
"info": "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 can be\nthe configuration level.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "count",
"type": "number",
"info": "Indicates the maximum number of child objects that this method will\nreturn. The maximum number of child objects cannot exceed more than 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing options. The Option names available in the\nObjectProperties are ObjectProperties.hint ,\n ObjectProperties.accessRight , and\n ObjectProperties.overrid...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of objects to start returning objects. The\nlist begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of zones based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getZonesByHint"
},
"task": true
},
{
"name": "moveResourceRecord",
"summary": "Moves resource records between different zones that already exist.",
"description": "Moves resource records between different zones that already exist.",
"input": [
{
"name": "destinationZone",
"type": "string",
"info": "Fully qualified domain name of the destination DNS zone to which the\nresource record will be moved.: string",
"required": false,
"schema": {
"title": "destinationZone",
"type": "string"
}
},
{
"name": "resourceRecordId",
"type": "number",
"info": "The object ID of the resource record to be moved.: 123",
"required": false,
"schema": {
"title": "resourceRecordId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/moveResourceRecord"
},
"task": true
},
{
"name": "searchResponsePolicyItems",
"summary": "Searches Response Policy items configured in local Response Policies or\npredefined BlueCat Security",
"description": "Searches Response Policy items configured in local Response Policies or\npredefined BlueCat Security feed data. The search will return a list of all\nmatching items in Address Manager across all configurations.",
"input": [
{
"name": "count",
"type": "number",
"info": "The total number of results to be returned. The possible value is a\npositive integer ranging from 1 to 1000.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "keyword",
"type": "string",
"info": "The search string for which you wish to search.\n\n\n ^ —matches the beginning of a string. For example: ^ex\nmatches ex ample but not t ex t.\n\n $ —matches the en...(description truncated): string",
"required": false,
"schema": {
"title": "keyword",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use. Use an empty string \"\" for now.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "scope",
"type": "string",
"info": "The scope in which the search is to be performed. The possible values\nare:\n\n\n RPItemSearchScope.LOCAL —to search policy items configured in\nlocal Response Policies.\n\n...(description truncated): string",
"required": false,
"schema": {
"title": "scope",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "A starting number from where the search result will be returned. The\npossible value is a positive integer ranging from 0 to 999. For example,\nspecifying 99 will return th...(description truncated): 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of ResponsePolicySearchResult objects. Each object contains information of one Response Policy item found either in local Response Policies or BlueCat Security feed data.",
"type": "array",
"items": {
"type": "object",
"title": "ResponsePolicySearchResult",
"properties": {
"name": {
"readOnly": false,
"description": "The name of the Response Policy item.",
"type": "string"
},
"policyType": {
"readOnly": false,
"description": "The type of response policy. For example, whitelist, blacklist,\nredirect or blackhole.",
"type": "string"
},
"parentIds": {
"readOnly": false,
"description": "Comma-separated values of the parent Response Policy or RP\nZone object(s) ID. If policy item is associated with a Response Policy,\nit is the Response Policy object ID. If policy item is associated with\nBlueCat Security feed data, it is the RP Zone object ID.",
"type": "string"
},
"category": {
"readOnly": false,
"description": "The name of the BlueCat Security feed category associated with the\npolicy item. For example, Malicious, Spam or Botnet command and control.\nFor local response policy items, this will be null.",
"type": "string"
},
"configId": {
"readOnly": false,
"description": "The object ID of the parent configuration in which the Response Policy\nitem is configured.",
"type": "integer",
"format": "int64"
}
},
"example": {
"name": "...",
"policyType": "...",
"parentIds": "...",
"category": "...",
"configId": 12345
},
"description": "Represents the Response Policy items that are configured either in local\nResponse Policies or BlueCat Security feed data."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/searchResponsePolicyItems"
},
"task": true
},
{
"name": "updateDNSDeploymentOption",
"summary": "Updates DNS options.",
"description": "Updates DNS options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The object ID of the DNS option to be updated. Depending on the\ntype of deployment option being updated, the format of the value might\ndiffer. For more information, refe...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDNSDeploymentOption"
},
"task": true
},
{
"name": "uploadResponsePolicyItems",
"summary": "Uploads one response policy file containing a list of fully qualified domain\nnames (FQDNs).",
"description": "Uploads one response policy file containing a list of fully qualified domain\nnames (FQDNs).",
"input": [
{
"name": "inputStream",
"type": "string",
"info": "The file to be uploaded under the response policy. This file is passed to\nAddress Manager as a byte array. This actual file size should be no\nmore than 75 MB.: string",
"required": false,
"schema": {
"title": "inputStream",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent response policy under which the response\npolicy item file is being uploaded.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "body",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "body",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/uploadResponsePolicyItems"
},
"task": true
},
{
"name": "addAccessRight",
"summary": "Adds access rights to a specified object.",
"description": "Adds access rights to a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the access right is being added. Set\nto zero (0) if you are adding the access right to the root level default\naccess rights.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "overrides",
"type": "string",
"info": "A list of type-specific overrides in the following format:\n \"objectType=accessValue|objectType=accessValue\": string",
"required": false,
"schema": {
"title": "overrides",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string including the following options:\n\n\n workflowLevel —valid values for this option are:\n\n\n None —changes made by the user or group take effect\nimmediately.\n\n...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "userId",
"type": "number",
"info": "The object ID of the user to whom this access right applies.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
},
{
"name": "value",
"type": "string",
"info": "The value of the access right being added. Valid values for this\nparameter are listed in the table.: string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addAccessRight"
},
"task": true
},
{
"name": "addDevice",
"summary": "Adds a device to a configuration.",
"description": "Adds a device to a configuration.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the device is to be located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "deviceSubtypeId",
"type": "number",
"info": "The object ID of the device sub-type with which the device is associated.\nThe value can be 0 if you do not wish to associate a device sub-type to\nthe device you are addin...(description truncated): 123",
"required": false,
"schema": {
"title": "deviceSubtypeId",
"type": "number"
}
},
{
"name": "deviceTypeId",
"type": "number",
"info": "The object ID of the device type with which the device is associated. The\nvalue can be 0 if you do not wish to associate a device type to the\ndevice you are adding.: 123",
"required": false,
"schema": {
"title": "deviceTypeId",
"type": "number"
}
},
{
"name": "ip4Addresses",
"type": "string",
"info": "One or more IPv4 addresses to which the device is assigned. Specify\nmultiple addresses in a comma-delimited list.: string",
"required": false,
"schema": {
"title": "ip4Addresses",
"type": "string"
}
},
{
"name": "ip6Addresses",
"type": "string",
"info": "One or more IPv6 addresses to which the device is assigned. Specify\nmultiple addresses in a comma-delimited list.: string",
"required": false,
"schema": {
"title": "ip6Addresses",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The descriptive name of the device.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDevice"
},
"task": true
},
{
"name": "addDeviceSubtype",
"summary": "Adds a device sub-type to Address Manager.",
"description": "Adds a device sub-type to Address Manager. Use device types and device\nsub-types to categorize and organize devices on the network.",
"input": [
{
"name": "name",
"type": "string",
"info": "The descriptive name for the device sub-type.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent device type object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDeviceSubtype"
},
"task": true
},
{
"name": "addDeviceType",
"summary": "Adds a device type to Address Manager.",
"description": "Adds a device type to Address Manager. Use device types and device sub-types\nto categorize and organize devices on the network.",
"input": [
{
"name": "name",
"type": "string",
"info": "The descriptive name for the device type.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDeviceType"
},
"task": true
},
{
"name": "addMACAddress",
"summary": "Adds MAC addresses.",
"description": "Adds MAC addresses.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration in which the MAC address resides.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including the name, MAC Pool ID macPool, and\nuser-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addMACAddress"
},
"task": true
},
{
"name": "addTag",
"summary": "Adds object tags.",
"description": "Adds object tags.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the object tag.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent for this object tag. The parent is either an\nobject tag or an object tag group.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTag"
},
"task": true
},
{
"name": "addTagGroup",
"summary": "Adds object tag groups.",
"description": "Adds object tag groups.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the tag group.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTagGroup"
},
"task": true
},
{
"name": "addUser",
"summary": "Adds Address Manager users.",
"description": "Adds Address Manager users.",
"input": [
{
"name": "password",
"type": "string",
"info": "The Address Manager password for the user. The password must be set even\nif the authenticator property option is defined.: string",
"required": false,
"schema": {
"title": "password",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing user-defined fields and options listed in List of\noptions . You can separate multiple property values with\npipe character (|), for example, my $prop...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "username",
"type": "string",
"info": "The name of the user.: string",
"required": false,
"schema": {
"title": "username",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addUser"
},
"task": true
},
{
"name": "addUserGroup",
"summary": "Adds user groups.",
"description": "Adds user groups.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the user group.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string including the following option:\n\n\n\n isAdministrator —either true or false , to indicate\nwhether or not you wish to add an administrator user group to Addr...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addUserGroup"
},
"task": true
},
{
"name": "associateMACAddressWithPool",
"summary": "Associates a MAC address with a MAC pool.",
"description": "Associates a MAC address with a MAC pool.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration in which the MAC address\nresides.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "macAddress",
"type": "string",
"info": "The MAC address in the format nnnnnnnnnnnn ,\n nn-nn-nn-nn-nn-nn , or nn:nn:nn:nn:nn:nn , where nn is a\nhexadecimal value.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "poolId",
"type": "number",
"info": "The object ID of the MAC pool with which this MAC address is associated.: 123",
"required": false,
"schema": {
"title": "poolId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/associateMACAddressWithPool"
},
"task": true
},
{
"name": "breakReplication",
"summary": "Breaks replication and returns each server to its original stand-alone state.",
"description": "Breaks replication and returns each server to its original stand-alone state.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/breakReplication"
},
"task": true
},
{
"name": "configureStreamingReplication",
"summary": "Enables database replication on a remote system in order to automate the\nsetup of replication betwe",
"description": "Enables database replication on a remote system in order to automate the\nsetup of replication between two or three Address Manager systems. This API\nmethod must be run against the Address Manager system that will be primary.",
"input": [
{
"name": "compressReplication",
"type": "boolean",
"info": "The boolean value. Set to true to compress the database\nreplication files. Compressing database replication files is a\nresource-intensive process that might affect sys...(description truncated): boolean",
"required": false,
"schema": {
"title": "compressReplication",
"type": "boolean"
}
},
{
"name": "latencyCriticalThreshold",
"type": "number",
"info": "A value to specify the threshold size of the replication break in seconds\n(sec). Valid values for this parameter range from 0 to any positive value.\nBy default, the laten...(description truncated): 123",
"required": false,
"schema": {
"title": "latencyCriticalThreshold",
"type": "number"
}
},
{
"name": "latencyWarningThreshold",
"type": "number",
"info": "A value to specify the threshold size of the replication directory in\nseconds (sec). Valid values for this parameter range from 0 to any\npositive value. By default, the l...(description truncated): 123",
"required": false,
"schema": {
"title": "latencyWarningThreshold",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string including the following option:\n\n\n secondStandbyServer —Used to add an additional standby\nserver. The server's IP address is required. When adding a standby\n...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "standbyServer",
"type": "string",
"info": "The IP address of the standby server.\n\n\n\n To configure replication in Address Manager, you must have a standby\nserver. An additional standby server can be added by usin...(description truncated): string",
"required": false,
"schema": {
"title": "standbyServer",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/configureStreamingReplication"
},
"task": true
},
{
"name": "deleteAccessRight",
"summary": "Deletes an access right for a specified object.",
"description": "Deletes an access right for a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the access right is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "userId",
"type": "number",
"info": "The object ID of the user to whom this access right is applied.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteAccessRight"
},
"task": true
},
{
"name": "denyMACAddress",
"summary": "Denies MAC addresses.",
"description": "Denies MAC addresses.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration in which the MAC address\nresides.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/denyMACAddress"
},
"task": true
},
{
"name": "establishTrustRelationship",
"summary": "Establishes a trust relationship between a maximum of three Address Manager\nservers, which is a pre",
"description": "Establishes a trust relationship between a maximum of three Address Manager\nservers, which is a prerequisite for configuring replication in Address\nManager.",
"input": [
{
"name": "password",
"type": "string",
"info": "The password for the API user logging into Address Manager.: string",
"required": false,
"schema": {
"title": "password",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "remoteIP",
"type": "string",
"info": "The IP address of the standby server. The standby server must be\naccessible from the primary server and must have database access from the\nprimary server. To enable data...(description truncated): string",
"required": false,
"schema": {
"title": "remoteIP",
"type": "string"
}
},
{
"name": "username",
"type": "string",
"info": "The username for the API user created using the Address Manager\ninterface.: string",
"required": false,
"schema": {
"title": "username",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/establishTrustRelationship"
},
"task": true
},
{
"name": "failoverReplication",
"summary": "Performs a manual replication failover.",
"description": "Performs a manual replication failover.",
"input": [
{
"name": "properties",
"type": "string",
"info": "A string that includes the following option:\n\n\n forceFailover —either true or\n false ; to indicate whether or not a forced failover will\nbe performed. If the latenc...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "standbyServer",
"type": "string",
"info": "The IP address of the standby server, which will become the primary BAM\nserver once a failover has been performed.: string",
"required": false,
"schema": {
"title": "standbyServer",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/failoverReplication"
},
"task": true
},
{
"name": "getAccessRight",
"summary": "Retrieves an access right for a specified object.",
"description": "Retrieves an access right for a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the access right is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "userId",
"type": "number",
"info": "The object ID of the user to whom the access right is applied.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIAccessRight",
"properties": {
"entityId": {
"readOnly": false,
"description": "The database ID of the object to which the access right\napplies. This value must be greater than 0.",
"type": "integer",
"format": "int64"
},
"userId": {
"readOnly": false,
"description": "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"type": "integer",
"format": "int64"
},
"value": {
"readOnly": false,
"description": "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null.",
"type": "string"
},
"overrides": {
"readOnly": false,
"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.",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value.",
"type": "string"
}
},
"example": {
"entityId": 12345,
"userId": 12345,
"value": "...",
"overrides": "...",
"properties": "..."
},
"description": "This class controls Access Right objects."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAccessRight"
},
"task": true
},
{
"name": "getAccessRightsForEntity",
"summary": "Returns an array of access rights for entities.",
"description": "Returns an array of access rights for entities.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of access right child objects to return.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity whose access rights are returned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of child access right objects to start\nreturning objects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of access right objects.",
"type": "array",
"items": {
"type": "object",
"title": "APIAccessRight",
"properties": {
"entityId": {
"readOnly": false,
"description": "The database ID of the object to which the access right\napplies. This value must be greater than 0.",
"type": "integer",
"format": "int64"
},
"userId": {
"readOnly": false,
"description": "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"type": "integer",
"format": "int64"
},
"value": {
"readOnly": false,
"description": "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null.",
"type": "string"
},
"overrides": {
"readOnly": false,
"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.",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value.",
"type": "string"
}
},
"example": {
"entityId": 12345,
"userId": 12345,
"value": "...",
"overrides": "...",
"properties": "..."
},
"description": "This class controls Access Right objects."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAccessRightsForEntity"
},
"task": true
},
{
"name": "getAccessRightsForUser",
"summary": "Returns an array of access rights for a specified user.",
"description": "Returns an array of access rights for a specified user.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of access right child objects to return.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of child access right objects to start\nreturning objects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "userId",
"type": "number",
"info": "The object ID of the user whose access rights are returned.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of access right objects.",
"type": "array",
"items": {
"type": "object",
"title": "APIAccessRight",
"properties": {
"entityId": {
"readOnly": false,
"description": "The database ID of the object to which the access right\napplies. This value must be greater than 0.",
"type": "integer",
"format": "int64"
},
"userId": {
"readOnly": false,
"description": "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"type": "integer",
"format": "int64"
},
"value": {
"readOnly": false,
"description": "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null.",
"type": "string"
},
"overrides": {
"readOnly": false,
"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.",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value.",
"type": "string"
}
},
"example": {
"entityId": 12345,
"userId": 12345,
"value": "...",
"overrides": "...",
"properties": "..."
},
"description": "This class controls Access Right objects."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAccessRightsForUser"
},
"task": true
},
{
"name": "getAllUsedLocations",
"summary": "Returns a list of location objects that are used to annotate\nother objects.",
"description": "Returns a list of location objects that are used to annotate\nother objects.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of location APIEntity objects.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getAllUsedLocations"
},
"task": true
},
{
"name": "getConfigurationGroups",
"summary": "Gets a list of all configuration groups in Address Manager.",
"description": "Gets a list of all configuration groups in Address Manager.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns a list of configuration groups.",
"type": "array",
"items": {
"type": "string"
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getConfigurationGroups"
},
"task": true
},
{
"name": "getConfigurationSetting",
"summary": "Returns the configuration setting.",
"description": "Returns the configuration setting.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the setting is to be located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "settingName",
"type": "string",
"info": "The name of the specific setting to be read. Only the option\ninheritance\n\nOPTION_INHERITANCE setting is supported.: string",
"required": false,
"schema": {
"title": "settingName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfigurationSetting"
},
"task": true
},
{
"name": "getConfigurationsByGroup",
"summary": "Gets a list of configurations in Address Manager based on the name of a\nconfiguration group.",
"description": "Gets a list of configurations in Address Manager based on the name of a\nconfiguration group.",
"input": [
{
"name": "groupName",
"type": "string",
"info": "The name of the configuration group in which the configurations\nare to be located. Configuration group names are case\nsensitive.: string",
"required": false,
"schema": {
"title": "groupName",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "This is reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns a list of configurations based on the specified group.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfigurationsByGroup"
},
"task": true
},
{
"name": "getLocationByCode",
"summary": "Returns the location object with the specified hierarchical\nlocation code.",
"description": "Returns the location object with the specified hierarchical\nlocation code.",
"input": [
{
"name": "code",
"type": "string",
"info": "The hierarchical location code consists of a set of 1 to 3 alpha-numeric\nstrings separated by a space. The first two characters indicate a\ncountry, followed by next three...(description truncated): string",
"required": false,
"schema": {
"title": "code",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getLocationByCode"
},
"task": true
},
{
"name": "getMACAddress",
"summary": "Returns an APIEntity for a MAC address.",
"description": "Returns an APIEntity for a MAC address.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the MAC address is located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getMACAddress"
},
"task": true
},
{
"name": "getReplicationInfo",
"summary": "Retrieves information regarding the status of replication in Address Manager\nthrough the API.",
"description": "Retrieves information regarding the status of replication in Address Manager\nthrough the API.",
"input": [
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getReplicationInfo"
},
"task": true
},
{
"name": "purgeHistoryNow",
"summary": "Runs the history purge function.",
"description": "Runs the history purge function.",
"input": [
{
"name": "numberOfDaysToKeep",
"type": "number",
"info": "The number of days for which the data will be preserved in the database.\nThe valid value for this parameter is between 1 and 3650. Set this\nparameter to -1 if you are usi...(description truncated): 123",
"required": false,
"schema": {
"title": "numberOfDaysToKeep",
"type": "number"
}
},
{
"name": "numberOfMonthsToKeep",
"type": "number",
"info": "The number of months for which the data will be preserved in the\ndatabase. The valid value for this parameter is between 0 to infinite\nmonths. Set this parameter to -1 if...(description truncated): 123",
"required": false,
"schema": {
"title": "numberOfMonthsToKeep",
"type": "number"
}
},
{
"name": "untilWhenTimestamp",
"type": "string",
"info": "The string specifying the point in time after which history is to be\npreserved. The valid timestamp pattern is YYYY-MM[-DD[\nHH:MM:SS[.mmm]]] . Set this parameter with an...(description truncated): string",
"required": false,
"schema": {
"title": "untilWhenTimestamp",
"type": "string"
}
},
{
"name": "waitOption",
"type": "boolean",
"info": "The Boolean value. If set to true , the purge will be\nperformed and the result will be returned when completed. The default\nvalue is false .: boolean",
"required": false,
"schema": {
"title": "waitOption",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/purgeHistoryNow"
},
"task": true
},
{
"name": "removeTrustRelationship",
"summary": "Removes a remote Address Manager server from the trust relationship.",
"description": "Removes a remote Address Manager server from the trust relationship.\n\nYou can remove Address Manager servers within the trust relationship one at a\ntime.",
"input": [
{
"name": "otherBAMIP",
"type": "string",
"info": "The IP address of the standby server. If the Address Manager server is in\nreplication, you must first remove it from replication in order to remove it from the trust rel...(description truncated): string",
"required": false,
"schema": {
"title": "otherBAMIP",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/removeTrustRelationship"
},
"task": true
},
{
"name": "terminateUserSessions",
"summary": "Terminates all active user sessions in Address Manager.",
"description": "Terminates all active user sessions in Address Manager.",
"input": [
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "username",
"type": "string",
"info": "The username of the user for which all active sessions are terminated.: string",
"required": false,
"schema": {
"title": "username",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/terminateUserSessions"
},
"task": true
},
{
"name": "updateAccessRight",
"summary": "Updates access rights for a specified object.",
"description": "Updates access rights for a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the access right is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "overrides",
"type": "string",
"info": "A list of potentially modified type-specific overrides in the following\nformat: \"objectType=accessValue|objectType=accessValue\": string",
"required": false,
"schema": {
"title": "overrides",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string including the following options:\n\n\n workflowLevel —valid values for this option are as\nfollows:\n\n\n None —changes made by the user or group take effect\nimme...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "userId",
"type": "number",
"info": "The object ID of the user to whom the access right is assigned. This\nvalue is not mutable.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
},
{
"name": "value",
"type": "string",
"info": "The new value for the access right. Valid entries are listed in\n .: string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateAccessRight"
},
"task": true
},
{
"name": "updateConfigurationSetting",
"summary": "Updates the configuration setting.",
"description": "Updates the configuration setting.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the setting is to be located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "The new properties of the configuration setting to be updated. Only the\n disable DNS option inheritance disableDnsOptionInheritance\nproperty is supported. If set to tru...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "settingName",
"type": "string",
"info": "The name of the specific setting to be read. Only the option\ninheritance\n\nOPTION_INHERITANCE setting is supported.: string",
"required": false,
"schema": {
"title": "settingName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateConfigurationSetting"
},
"task": true
},
{
"name": "updateUserPassword",
"summary": "Updates an Address Manager user password.",
"description": "Updates an Address Manager user password.\n\nYou must be an Address Manager administrator to invoke this method.",
"input": [
{
"name": "newPassword",
"type": "string",
"info": "The new password for the user.: string",
"required": false,
"schema": {
"title": "newPassword",
"type": "string"
}
},
{
"name": "options",
"type": "array",
"info": "Reserved for future use.: array",
"required": false,
"schema": {
"title": "options",
"type": "array"
}
},
{
"name": "userId",
"type": "number",
"info": "The user ID of an application user who is either a primary or a secondary\nauthenticator.: 123",
"required": false,
"schema": {
"title": "userId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateUserPassword"
},
"task": true
},
{
"name": "addAdditionalIPAddresses",
"summary": "Adds additional IPv4 addresses and loopback addresses to the Services\ninterface for DNS service.",
"description": "Adds additional IPv4 addresses and loopback addresses to the Services\ninterface for DNS service.",
"input": [
{
"name": "ipsToAdd",
"type": "string",
"info": "The list of IP addresses you wish to add. You can specify multiple IP\naddresses with a separator. The supported format is\n [IP,serviceType|IP,serviceType] . For example,\n...(description truncated): string",
"required": false,
"schema": {
"title": "ipsToAdd",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties. Currently there are no supported properties; this is reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The database object ID of the server to which you will add the additional IP addresses.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addAdditionalIPAddresses"
},
"task": true
},
{
"name": "addDeviceInstance",
"summary": "Adds a device instance.",
"description": "Adds a device instance.\n\nUse this method to provision new devices for the network. This method combines a number of\nexisting API methods into one: It assigns the next available, or\nmanually defined, IP address. It optionally adds a DNS host record and MAC\naddress that are linked to the IP address. It returns the property string\ncontaining the IP address, netmask, and gateway. When configured with a DNS host\nrecord, addDeviceInstance updates the DNS server to immediately deploy\nthe host re...(description truncated)",
"input": [
{
"name": "configName",
"type": "string",
"info": "Name of parent configuration. If the value is empty or cannot be found,\nan exception will be thrown.: string",
"required": false,
"schema": {
"title": "configName",
"type": "string"
}
},
{
"name": "deviceName",
"type": "string",
"info": "IP address or device name of the new instance. This is reserved for future use.: string",
"required": false,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "ipAddressMode",
"type": "string",
"info": "Accepted values are: REQUEST_STATIC — Use to get the next available static\nIP address. REQUEST_DHCP_RESERVED - Use to get the next available DHCP reserved IP addre...(description truncated): string",
"required": false,
"schema": {
"title": "ipAddressMode",
"type": "string"
}
},
{
"name": "ipEntity",
"type": "string",
"info": "If ipAddressMode is REQUEST_STATIC or\n REQUEST_DHCP_RESERVED , this must be the network where the IP\naddress will be provisioned from in the format of an IP address r...(description truncated): string",
"required": false,
"schema": {
"title": "ipEntity",
"type": "string"
}
},
{
"name": "macAddressMode",
"type": "string",
"info": "Accepted values are: REQUEST_VALUE - Reserved for future use.\n PASS_VALUE - Use to manually provide the MAC address linked to the IP address.\n If you specify an ...(description truncated): string",
"required": false,
"schema": {
"title": "macAddressMode",
"type": "string"
}
},
{
"name": "macEntity",
"type": "string",
"info": "If macAddressMode is PASS_VALUE , this must be a\nMAC address. If macAddressMode is REQUEST_VALUE ,\nthis is a MAC mask.: string",
"required": false,
"schema": {
"title": "macEntity",
"type": "string"
}
},
{
"name": "options",
"type": "string",
"info": "The options string contains four properties: skip , offset ,\n excludeDHCPRange , and allowDuplicateHosts .\n\n\n skip —this is optional. It is applied to REQUEST_STAT...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "recordName",
"type": "string",
"info": "Name of the host record to add. This cannot be empty if both\n viewName and zoneName are specified and in\nuse. The viewName , zoneName , and\n recordName parameters m...(description truncated): string",
"required": false,
"schema": {
"title": "recordName",
"type": "string"
}
},
{
"name": "viewName",
"type": "string",
"info": "Name of parent view. Specify an empty string (\"\") for all\n viewName , zoneName , and\n recordName parameters to ignore DNS object\ncreation.: string",
"required": false,
"schema": {
"title": "viewName",
"type": "string"
}
},
{
"name": "zoneName",
"type": "string",
"info": "Parent zone of the record. This must be specified and existing if the\n viewName parameter is an empty string and existing.\n Specify an empty string for all viewName ,\n ...(description truncated): string",
"required": false,
"schema": {
"title": "zoneName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDeviceInstance"
},
"task": true
},
{
"name": "addIP4BlockByCIDR",
"summary": "Adds a new IPv4 Block using CIDR notation.",
"description": "Adds a new IPv4 Block using CIDR notation.",
"input": [
{
"name": "cIDR",
"type": "string",
"info": "The CIDR notation defining the block, for example, 10.10/16.: string",
"required": false,
"schema": {
"title": "cIDR",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the target object’s parent object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options. For more information about the available\noptions, refer to\n .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4BlockByCIDR"
},
"task": true
},
{
"name": "addIP4BlockByRange",
"summary": "Adds a new IPv4 block defined by an address range.",
"description": "Adds a new IPv4 block defined by an address range.",
"input": [
{
"name": "end",
"type": "string",
"info": "An IP address defining the highest address or end of the block.: string",
"required": false,
"schema": {
"title": "end",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the target object’s parent object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options. For more information about the available\noptions, refer to\n .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "start",
"type": "string",
"info": "An IP address defining the lowest address or start of the block.: string",
"required": false,
"schema": {
"title": "start",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4BlockByRange"
},
"task": true
},
{
"name": "addIP4IPGroupByRange",
"summary": "Adds an IPv4 IP group by range bounds (start address and end address).",
"description": "Adds an IPv4 IP group by range bounds (start address and end address).",
"input": [
{
"name": "end",
"type": "string",
"info": "An end IP address of the IP group range.: string",
"required": false,
"schema": {
"title": "end",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the IP group.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID for the network where you wish to add the IP group.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including the user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "start",
"type": "string",
"info": "A start IP address of the IP group range.: string",
"required": false,
"schema": {
"title": "start",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4IPGroupByRange"
},
"task": true
},
{
"name": "addIP4IPGroupBySize",
"summary": "Adds an IPv4 IP group by size.",
"description": "Adds an IPv4 IP group by size.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the IP group.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID for the network where you wish to add the IP group.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "positionRangeBy",
"type": "string",
"info": "A string specifying the position of the IP group range in the parent\nnetwork. The value must be one of the constants listed in\n .\nThis is optional. If specified, you must...(description truncated): string",
"required": false,
"schema": {
"title": "positionRangeBy",
"type": "string"
}
},
{
"name": "positionValue",
"type": "string",
"info": "The offset value when using positionRangeBy.START_OFFSET or\n positionRangeBy.END_OFFSET . The start address of the IP group in\nthe network when using positionRangeBy.S...(description truncated): string",
"required": false,
"schema": {
"title": "positionValue",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "size",
"type": "number",
"info": "The number of addresses in the IP group.: 123",
"required": false,
"schema": {
"title": "size",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4IPGroupBySize"
},
"task": true
},
{
"name": "addIP4Network",
"summary": "Adds an IPv4 network using CIDR notation.",
"description": "Adds an IPv4 network using CIDR notation.",
"input": [
{
"name": "cIDR",
"type": "string",
"info": "The CIDR notation defining the network, for example, 10.10.10/24.: string",
"required": false,
"schema": {
"title": "cIDR",
"type": "string"
}
},
{
"name": "blockId",
"type": "number",
"info": "The object ID of the new network’s parent IPv4 block.: 123",
"required": false,
"schema": {
"title": "blockId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options. For more information about the available\noptions, refer to .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4Network"
},
"task": true
},
{
"name": "addIP4NetworkTemplate",
"summary": "Add an IPv4 network template to the specified configuration.",
"description": "Add an IPv4 network template to the specified configuration.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration where you wish to add the IPv4 template.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the IPv4 network template.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string defining the IPv4 network template properties. For example,\n gateway=[gateway_offset]|\nreservedAddresses={type,definedBy,\noffset,size,direction,name,splitStaticA...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4NetworkTemplate"
},
"task": true
},
{
"name": "addIP4ReconciliationPolicy",
"summary": "Adds an IPv4 reconciliation policy.",
"description": "Adds an IPv4 reconciliation policy.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the policy.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent network of the policy. You can create IPv4\nreconciliation policies at the configuration, IPv4 block, and IPv4 network\nlevels.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing properties and values listed in\n .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP4ReconciliationPolicy"
},
"task": true
},
{
"name": "addIP6Address",
"summary": "Adds an IPv6 address to a specified IPv6 network.",
"description": "Adds an IPv6 address to a specified IPv6 network.",
"input": [
{
"name": "address",
"type": "string",
"info": "The IPv6 address you wish to add.\n address and type must be consistent. For\nexample, if the type is ObjectTypes.IP6Address, the address must be a\nstring representi...(description truncated): string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "containerId",
"type": "number",
"info": "The object ID of the container where you wish to add the IPv6 address.\nThis can be the object ID of a configuration, IPv6 block, or IPv6 network.\nThe parent IPv6 network ...(description truncated): 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "Descriptive name for the IPv6 address. This value can be empty.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of IPv6 address. This value must be one of the following:\n macAddress , IP6Address , or InterfaceID .\nAs with the address parameter, address and type m...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP6Address"
},
"task": true
},
{
"name": "addIP6BlockByMACAddress",
"summary": "Adds an IPv6 block by specifying the MAC address of the server.",
"description": "Adds an IPv6 block by specifying the MAC address of the server.",
"input": [
{
"name": "macAddress",
"type": "string",
"info": "The MAC address of the server in the format nnnnnnnnnnnn ,\n nn-nn-nn-nn-nn-nn , or nn:nn:nn:nn:nn:nn , where nn is\na hexadecimal value.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Descriptive name for the IPv6 block. This value can be empty.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the new IPv6 block. The parent\nobject must be another IPv6 block.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields. This value can be empty.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP6BlockByMACAddress"
},
"task": true
},
{
"name": "addIP6BlockByPrefix",
"summary": "Adds an IPv6 block be specifying the prefix for the block.",
"description": "Adds an IPv6 block be specifying the prefix for the block.",
"input": [
{
"name": "name",
"type": "string",
"info": "Descriptive name for the IPv6 block. This value can be empty.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the new IPv6 block. The parent\nobject may be a configuration or another IPv6 block.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "prefix",
"type": "string",
"info": "The IPv6 prefix for the new block.: string",
"required": false,
"schema": {
"title": "prefix",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields. This value can be empty.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP6BlockByPrefix"
},
"task": true
},
{
"name": "addIP6NetworkByPrefix",
"summary": "Adds an IPv6 network be specifying the prefix for the network.",
"description": "Adds an IPv6 network be specifying the prefix for the network.",
"input": [
{
"name": "name",
"type": "string",
"info": "Descriptive name for the IPv6 network. This value can be empty.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the IPv6 block in which the new IPv6 network will be located.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "prefix",
"type": "string",
"info": "The IPv6 prefix for the new network.: string",
"required": false,
"schema": {
"title": "prefix",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields. This value can be empty.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addIP6NetworkByPrefix"
},
"task": true
},
{
"name": "addParentBlock",
"summary": "Adds a parent block.",
"description": "Adds a parent block.\n\nCreates an IPv4 or IPv6 block from a list of IPv4 or IPv6 blocks or networks.\nAll blocks and networks must have the same parent but it does not need to be\ncontiguous.",
"input": [
{
"name": "body",
"type": "array",
"info": "An array containing the object IDs of IPv4 or IPv6 blocks or networks.: array",
"required": false,
"schema": {
"description": "An array containing the object IDs of IPv4 or IPv6 blocks or networks.",
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addParentBlock"
},
"task": true
},
{
"name": "addParentBlockWithProperties",
"summary": "Adds a parent block with properties.",
"description": "Adds a parent block with properties.\n\nCreates an IPv4 or IPv6 block with a name from a list of IPv4 or IPv6 blocks\nor networks. All blocks and networks must have the same parent but it does\nnot need to be contiguous.",
"input": [
{
"name": "properties",
"type": "string",
"info": "A string containing the following option:\n\n\n name -the name of the new IPv4 or IPv6 block to be\ncreated.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "body",
"type": "array",
"info": "An array containing the object IDs of IPv4 or IPv6 blocks or networks.: array",
"required": false,
"schema": {
"description": "An array containing the object IDs of IPv4 or IPv6 blocks or networks.",
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addParentBlockWithProperties"
},
"task": true
},
{
"name": "applyIP4NetworkTemplate",
"summary": "Applies IPv4 network templates.",
"description": "Applies IPv4 network templates.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID of the IPv4 network. If\nthe value is zero, the template is applied to all networks.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the following properties and values:\n\n\n applyToNonConflictedNetworksOnly - Boolean value:\n true or false . If set to\n true , the template is appl...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the IPv4 template.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/applyIP4NetworkTemplate"
},
"task": true
},
{
"name": "assignIP4Address",
"summary": "Assigns a MAC address and other properties to an IPv4 address.",
"description": "Assigns a MAC address and other properties to an IPv4 address.",
"input": [
{
"name": "action",
"type": "string",
"info": "This parameter must be set to one of the constants shown in\n .: string",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the IPv4 address is located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "hostInfo",
"type": "string",
"info": "A string containing host information for the address in the following\nformat: hostname,viewId,reverseFlag,sameAsZoneFlag[,\nhostname,viewId,reverseFlag,sameAsZoneFlag,......(description truncated): string",
"required": false,
"schema": {
"title": "hostInfo",
"type": "string"
}
},
{
"name": "ip4Address",
"type": "string",
"info": "The IPv4 address.: string",
"required": false,
"schema": {
"title": "ip4Address",
"type": "string"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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 or\n nn:nn:nn:nn:nn:nn , where nn is a ...(description truncated): string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "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 wi...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignIP4Address"
},
"task": true
},
{
"name": "assignIP4NetworkTemplate",
"summary": "Assigns IPv4 network templates.",
"description": "Assigns IPv4 network templates.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID of the IPv4 network.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the following property and value:\n\n\n overrideAssignedTemplate - true or\n false . If set to true , the previous\nassigned template is overriden. T...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the IPv4 template.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignIP4NetworkTemplate"
},
"task": true
},
{
"name": "assignIP6Address",
"summary": "Assigns an IPv6 address to a MAC address and host.",
"description": "Assigns an IPv6 address to a MAC address and host.",
"input": [
{
"name": "action",
"type": "string",
"info": "Determines how to assign the address. Valid values are MAKE_STATIC\nor MAKE_DHCP_RESERVED .: string",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "address",
"type": "string",
"info": "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 strin...(description truncated): string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "containerId",
"type": "number",
"info": "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 net...(description truncated): 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "hostInfo",
"type": "string",
"info": "The host information for the IPv6 address. This value can be empty. The\nhostInfo string uses the following format:\n viewId, hostname, ifSameAsZone,\nifReverseMapping\n\nWh...(description truncated): string",
"required": false,
"schema": {
"title": "hostInfo",
"type": "string"
}
},
{
"name": "macAddress",
"type": "string",
"info": "The MAC address in the format nnnnnnnnnnnn ,\n nn-nn-nn-nn-nn-nn , or nn:nn:nn:nn:nn:nn , where nn\nis a hexadecimal value.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "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 wi...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignIP6Address"
},
"task": true
},
{
"name": "assignNextAvailableIP4Address",
"summary": "Assign the next available IPv4 address.",
"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.",
"input": [
{
"name": "action",
"type": "string",
"info": "This parameter must be set to one of the constants shown in .: string",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the IPv4 address is located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "hostInfo",
"type": "string",
"info": "A string containing host information for the address in the following\nformat: hostname,viewId,reverseFlag,sameAsZoneFlag[,\nhostname,viewId,reverseFlag,sameAsZoneFlag,......(description truncated): string",
"required": false,
"schema": {
"title": "hostInfo",
"type": "string"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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...(description truncated): string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the configuration, block, or network in which to look\nfor the next available address.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "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 wi...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignNextAvailableIP4Address"
},
"task": true
},
{
"name": "changeStateIP4Address",
"summary": "Converts the state of an address from and between Reserved, DHCP Reserved,\nand Static, or DHCP Allo",
"description": "Converts the state of an address from and between Reserved, DHCP Reserved,\nand Static, or DHCP Allocated to DHCP Reserved.",
"input": [
{
"name": "addressId",
"type": "number",
"info": "The database ID of the address object.: 123",
"required": false,
"schema": {
"title": "addressId",
"type": "number"
}
},
{
"name": "macAddress",
"type": "string",
"info": "Optional and only needed, if the target requires it. For example,\nMAKE_DHCP_RESERVED: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
},
{
"name": "targetState",
"type": "string",
"info": "One of MAKE_STATIC , MAKE_RESERVED ,\n MAKE_DHCP_RESERVED . All of these constants are defined in the\nJava Class IPAssignmentActionValues or in the API.pm file\nfor P...(description truncated): string",
"required": false,
"schema": {
"title": "targetState",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/changeStateIP4Address"
},
"task": true
},
{
"name": "clearIP6Address",
"summary": "Clears a specified IPv6 address assignment.",
"description": "Clears a specified IPv6 address assignment.",
"input": [
{
"name": "addressId",
"type": "number",
"info": "The object ID of the IPv6 address to be deleted.: 123",
"required": false,
"schema": {
"title": "addressId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/clearIP6Address"
},
"task": true
},
{
"name": "deleteDeviceInstance",
"summary": "Deletes either the IP address or MAC address (and all related DNS entries\nincluding host records, P",
"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.",
"input": [
{
"name": "configName",
"type": "string",
"info": "Name of parent configuration. If the value is empty or cannot be found,\nan exception will be thrown.: string",
"required": false,
"schema": {
"title": "configName",
"type": "string"
}
},
{
"name": "identifier",
"type": "string",
"info": "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 ...(description truncated): string",
"required": false,
"schema": {
"title": "identifier",
"type": "string"
}
},
{
"name": "options",
"type": "string",
"info": "Currently empty. This parameter is reserved for future use.: string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDeviceInstance"
},
"task": true
},
{
"name": "getAdditionalIPAddresses",
"summary": "Returns IPv4 addresses and loopback addresses added to the Service interface\nfor DNS services.",
"description": "Returns IPv4 addresses and loopback addresses added to the Service interface\nfor DNS services.",
"input": [
{
"name": "adonisID",
"type": "number",
"info": "The database object ID of the server on which additional services IP\naddress have been added.: 123",
"required": false,
"schema": {
"title": "adonisID",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "The supported property is:\n\n\n serviceType —type of service for which a list of IP\naddresses will be retrieved. Available types are\n AdditionalIPServiceType.SERVICE an...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAdditionalIPAddresses"
},
"task": true
},
{
"name": "getAliasesByHint",
"summary": "Returns an array of CNAMEs with linked record name.",
"description": "Returns an array of CNAMEs with linked record name.",
"input": [
{
"name": "count",
"type": "number",
"info": "indicates the maximum of child objects that this method will return. The\nvalue must be less than or equal to 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "a string containing options. The supported options are hint and\nretrieveFields. Separate multiple options with a pipe\ncharacter. For example: hint=^abc|retrieveFields=fa...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "indicates where in the list of objects to start returning objects. The\nlist begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of Alias APIEntity objects.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAliasesByHint"
},
"task": true
},
{
"name": "getDiscoveredDevice",
"summary": "Returns the object ID of the discovered device by running an IPv4\nreconciliation policy.",
"description": "Returns the object ID of the discovered device by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDevice"
},
"task": true
},
{
"name": "getDiscoveredDeviceArpEntries",
"summary": "Returns all ARP entries of a specific device discovered by running an IPv4\nreconciliation policy.",
"description": "Returns all ARP entries of a specific device discovered by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all ARP entries of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceArpEntries"
},
"task": true
},
{
"name": "getDiscoveredDeviceHosts",
"summary": "Returns all hosts of a specific device discovered by running an IPv4\nreconciliation policy.",
"description": "Returns all hosts of a specific device discovered by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all hosts of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceHosts"
},
"task": true
},
{
"name": "getDiscoveredDeviceInterfaces",
"summary": "Returns all interfaces of a specific device discovered by running an IPv4\nreconciliation policy.",
"description": "Returns all interfaces of a specific device discovered by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all interfaces of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceInterfaces"
},
"task": true
},
{
"name": "getDiscoveredDeviceMacAddressEntries",
"summary": "Returns all MAC address entries of a specific device discovered by running an\nIPv4 reconciliation p",
"description": "Returns all MAC address entries of a specific device discovered by running an\nIPv4 reconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all MAC address entries of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceMacAddressEntries"
},
"task": true
},
{
"name": "getDiscoveredDeviceNetworks",
"summary": "Returns all networks of a specific device discovered by running an IPv4\nreconciliation policy.",
"description": "Returns all networks of a specific device discovered by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all networks of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceNetworks"
},
"task": true
},
{
"name": "getDiscoveredDeviceVlans",
"summary": "Returns all VLANs of a specific device discovered by running an IPv4\nreconciliation policy.",
"description": "Returns all VLANs of a specific device discovered by running an IPv4\nreconciliation policy.",
"input": [
{
"name": "deviceId",
"type": "number",
"info": "The object ID of the discovered device.: 123",
"required": false,
"schema": {
"title": "deviceId",
"type": "number"
}
},
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all Vlans of a specific device.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDeviceVlans"
},
"task": true
},
{
"name": "getDiscoveredDevices",
"summary": "Returns a list of discovered Layer 2 or Layer 3 devices by running an IPv4\nreconciliation policy sp",
"description": "Returns a list of discovered Layer 2 or Layer 3 devices by running an IPv4\nreconciliation policy specified.",
"input": [
{
"name": "policyId",
"type": "number",
"info": "The object ID for the IPv4 reconciliation policy.: 123",
"required": false,
"schema": {
"title": "policyId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of discovered Layer 2 or Layer 3 devices.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDiscoveredDevices"
},
"task": true
},
{
"name": "getIP4Address",
"summary": "Returns the details for the requested IPv4 address object.",
"description": "Returns the details for the requested IPv4 address object.",
"input": [
{
"name": "address",
"type": "string",
"info": "The IPv4 address.: string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "containerId",
"type": "number",
"info": "The object ID for the configuration, block, network, or DHCP range in\nwhich this address is located.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getIP4Address"
},
"task": true
},
{
"name": "getIP4NetworksByHint",
"summary": "Returns an array of IPv4 networks found under a given container object.",
"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.",
"input": [
{
"name": "containerId",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "count",
"type": "number",
"info": "Indicates the maximum number of child objects that this method will\nreturn. The maximum number of child objects that can be returned is 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing options. The option names available in the\nObjectProperties are ObjectProperties.hint ,\n ObjectProperties.accessRight , and\n ObjectProperties.overrid...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of objects to start returning objects. The\nlist begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"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.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getIP4NetworksByHint"
},
"task": true
},
{
"name": "getIP6Address",
"summary": "Returns an APIEntity for the specified IPv6 address.",
"description": "Returns an APIEntity for the specified IPv6 address.",
"input": [
{
"name": "address",
"type": "string",
"info": "The IPv6 address.: string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "containerId",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getIP6Address"
},
"task": true
},
{
"name": "getIP6ObjectsByHint",
"summary": "Returns an array of IPv6 objects found under a given container object.",
"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.",
"input": [
{
"name": "containerId",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "count",
"type": "number",
"info": "Indicates the maximum number of child objects that this method will\nreturn.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "objectType",
"type": "string",
"info": "The type of object containing the IPv6 network. Currently, it only\nsupports ObjectTypes.IP6Network .: string",
"required": false,
"schema": {
"title": "objectType",
"type": "string"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing options. The Option names available in\n ObjectProperties are ObjectProperties.hint and\n ObjectProperties.accessRight .\n\nMultiple options can be se...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of objects to start returning objects. The\nlist begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"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.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getIP6ObjectsByHint"
},
"task": true
},
{
"name": "getIPRangedByIP",
"summary": "Returns the DHCP range containing the specified IPv4 or IPv6 address.",
"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.",
"input": [
{
"name": "address",
"type": "string",
"info": "An IPv4 or IPv6 address.: string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "containerId",
"type": "number",
"info": "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 configur...(description truncated): 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object containing the IP address. Specify\n ObjectTypes.IP4Block or ObjectTypes.IP6Block ,\n ObjectTypes.IP4Network or ObjectTypes.IP6Network , or\n ObjectTy...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getIPRangedByIP"
},
"task": true
},
{
"name": "getLinkedNetworkConflicts",
"summary": "Get a list of deployment options that conflict with the associated networks\nor network that are lin",
"description": "Get a list of deployment options that conflict with the associated networks\nor network that are linked to the IPv4 network template.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the IPv4 network template.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getLinkedNetworkConflicts"
},
"task": true
},
{
"name": "getMaxAllowedRange",
"summary": "Finds the maximum possible address range to which the existing IPv4 DHCP\nrange can be extended.",
"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.",
"input": [
{
"name": "rangeId",
"type": "number",
"info": "The object ID of the IPv4 DHCP range.: 123",
"required": false,
"schema": {
"title": "rangeId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns the possible start address and end address for the specified IPv4 DHCP range object in the form of array of length 2.",
"type": "array",
"items": {
"type": "string"
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getMaxAllowedRange"
},
"task": true
},
{
"name": "getNextAvailableIP4Address",
"summary": "Returns the IPv4 address for the next available (unallocated) address within\na configuration, block",
"description": "Returns the IPv4 address for the next available (unallocated) address within\na configuration, block, or network.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The object ID for configuration, block, or network in which to look for\nthe next available address.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextAvailableIP4Address"
},
"task": true
},
{
"name": "getNextAvailableIP4Network",
"summary": "Returns the object ID for the next available (unused) network within a\nconfiguration or block.",
"description": "Returns the object ID for the next available (unused) network within a\nconfiguration or block.",
"input": [
{
"name": "autoCreate",
"type": "boolean",
"info": "This Boolean value indicates whether the next available network should be\ncreated if it does not exist.: boolean",
"required": false,
"schema": {
"title": "autoCreate",
"type": "boolean"
}
},
{
"name": "isLargerAllowed",
"type": "boolean",
"info": "This Boolean value indicates whether to return larger networks than those\nspecified with the size parameter.: boolean",
"required": false,
"schema": {
"title": "isLargerAllowed",
"type": "boolean"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the network’s parent object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "size",
"type": "number",
"info": "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 ...(description truncated): 123",
"required": false,
"schema": {
"title": "size",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextAvailableIP4Network"
},
"task": true
},
{
"name": "getNextAvailableIP6Address",
"summary": "Returns the next available IPv6 address within an IPv6 block or network.",
"description": "Returns the next available IPv6 address within an IPv6 block or network.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The object ID of IPv6 block or network where to look for\nthe next available IPv6 address.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "The properties string contains the following properties (the properties are separated by \"|\"):\n\n\n startOffset - This is optional. Specifies from which offset to\nretrie...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextAvailableIP6Address"
},
"task": true
},
{
"name": "getNextAvailableIPRange",
"summary": "Returns the object ID for the next available (unused) block or network within\na configuration or bl",
"description": "Returns the object ID for the next available (unused) block or network within\na configuration or block.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object under which the next available range\nresides configuration or block.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "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...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "size",
"type": "number",
"info": "The size of the range, expressed as a power of 2.: 123",
"required": false,
"schema": {
"title": "size",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of the range object to be fetched. Currently IPv4 block and\nnetwork are supported.: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextAvailableIPRange"
},
"task": true
},
{
"name": "getNextAvailableIPRanges",
"summary": "Returns the object IDs for the next available (unused) blocks or networks\nwithin a configuration or",
"description": "Returns the object IDs for the next available (unused) blocks or networks\nwithin a configuration or block.",
"input": [
{
"name": "count",
"type": "number",
"info": "The number of networks to be found.\n If the number of networks count\nis greater than 1:\n\n\n isLargerAllowed and traversalMethod properties will not be\napplicable.\n\n The ...(description truncated): 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object under which the next available range\nresides configuration or block.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "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...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "size",
"type": "number",
"info": "The size of the range, expressed as a power of 2.: 123",
"required": false,
"schema": {
"title": "size",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of the range object to be fetched. Currently only IPv4 network\nis supported.: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"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.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextAvailableIPRanges"
},
"task": true
},
{
"name": "getNextIP4Address",
"summary": "Returns the next available IP addresses in octet notation under specified\ncircumstances.",
"description": "Returns the next available IP addresses in octet notation under specified\ncircumstances.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The network or configuration Id.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "The property string contains three properties; skip ,\n offset and excludeDHCPRange . The values for\n skip and offset must be IPv4 addresses and must appear in\ndotte...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getNextIP4Address"
},
"task": true
},
{
"name": "getTemplateTaskStatus",
"summary": "Gets the IPv4 template task status when the template is applied.",
"description": "Gets the IPv4 template task status when the template is applied.",
"input": [
{
"name": "taskId",
"type": "string",
"info": "The task ID of the IPv4 network template.: string",
"required": false,
"schema": {
"title": "taskId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getTemplateTaskStatus"
},
"task": true
},
{
"name": "isAddressAllocated",
"summary": "Queries a MAC address to determine if the address has been allocated to an IP\naddress.",
"description": "Queries a MAC address to determine if the address has been allocated to an IP\naddress.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration in which the MAC address\nresides.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "ipAddress",
"type": "string",
"info": "The IPv4 DHCP allocated address to be checked against the MAC address.: string",
"required": false,
"schema": {
"title": "ipAddress",
"type": "string"
}
},
{
"name": "macAddress",
"type": "string",
"info": "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.: string",
"required": false,
"schema": {
"title": "macAddress",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAddressAllocated"
},
"task": true
},
{
"name": "mergeBlocksWithParent",
"summary": "Merges specified IPv4 blocks into a single block.",
"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.",
"input": [
{
"name": "body",
"type": "array",
"info": "An array containing a list of IPv4 block IDs.: array",
"required": false,
"schema": {
"description": "An array containing a list of IPv4 block IDs.",
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/mergeBlocksWithParent"
},
"task": true
},
{
"name": "mergeSelectedBlocksOrNetworks",
"summary": "Merges specified IPv4 blocks or IPv4 networks into a single IPv4 block or\nIPv4 network.",
"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.",
"input": [
{
"name": "blockOrNetworkToKeep",
"type": "number",
"info": "The ID of the IPv4 block or IPv4 network that will retain its identity\nafter the merge.: 123",
"required": false,
"schema": {
"title": "blockOrNetworkToKeep",
"type": "number"
}
},
{
"name": "body",
"type": "array",
"info": "An array containing a list of IPv4 block or network IDs.: array",
"required": false,
"schema": {
"description": "An array containing a list of IPv4 block or network IDs.",
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/mergeSelectedBlocksOrNetworks"
},
"task": true
},
{
"name": "moveIPObject",
"summary": "Moves an IPv4 block, IPv4 network, IPv4 address, IPv6 block, or IPv6 network\nto a new IPv4 or IPv6",
"description": "Moves an IPv4 block, IPv4 network, IPv4 address, IPv6 block, or IPv6 network\nto a new IPv4 or IPv6 address.",
"input": [
{
"name": "address",
"type": "string",
"info": "The new address for the object.: string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "objectId",
"type": "number",
"info": "The ID of the object to be moved. Currently IPv4 blocks, IPv4 networks,\nIPv4 addresses, IPv6 blocks and IPv6 networks are supported.: 123",
"required": false,
"schema": {
"title": "objectId",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing the noServerUpdate option.\n\n\n noServerUpdate - A boolean value. If set to\n true , instant dynamic host record changes will not be\nperformed on DN...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/moveIPObject"
},
"task": true
},
{
"name": "reapplyTemplate",
"summary": "Reapplies DNS zone templates.",
"description": "Reapplies DNS zone templates. The template must already be applied to an\nobject before you can re-apply or remove it.",
"input": [
{
"name": "properties",
"type": "string",
"info": "A string containing the following settings:\n\n\n The properties value must include\n ObjectProperties.templateType with the value of\n ObjectProperties.zoneTemplateType .\n...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the DNS zone template to be assigned or updated.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/reapplyTemplate"
},
"task": true
},
{
"name": "reassignIP6Address",
"summary": "Reassigns an existing IPv6 address to a new IPv6 address.",
"description": "Reassigns an existing IPv6 address to a new IPv6 address.",
"input": [
{
"name": "destination",
"type": "string",
"info": "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 ...(description truncated): string",
"required": false,
"schema": {
"title": "destination",
"type": "string"
}
},
{
"name": "oldAddressId",
"type": "number",
"info": "The object ID of the current IPv6 address.: 123",
"required": false,
"schema": {
"title": "oldAddressId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/reassignIP6Address"
},
"task": true
},
{
"name": "removeAdditionalIPAddresses",
"summary": "Removes additional IPv4 addresses and loopback addresses from the Services\ninterface.",
"description": "Removes additional IPv4 addresses and loopback addresses from the Services\ninterface.",
"input": [
{
"name": "ipsToRemove",
"type": "string",
"info": "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\nexampl...(description truncated): string",
"required": false,
"schema": {
"title": "ipsToRemove",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties. Currently there is no supported properties.\nReserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The database object ID of the server from which additional services IP\naddresses need to be removed.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/removeAdditionalIPAddresses"
},
"task": true
},
{
"name": "resizeRange",
"summary": "Changes the size of an IPv4 block, IPv4 network, DHCPv4 range, IPv6 block, or\nIPv6 network.",
"description": "Changes the size of an IPv4 block, IPv4 network, DHCPv4 range, IPv6 block, or\nIPv6 network.",
"input": [
{
"name": "objectId",
"type": "number",
"info": "The ID of the object to be resized. Currently IPv4 block, IPv4 network,\nDHCPv4 range, IPv6 block, and IPv6 network are supported.: 123",
"required": false,
"schema": {
"title": "objectId",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "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 ...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "range",
"type": "string",
"info": "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\n ipAddressS...(description truncated): string",
"required": false,
"schema": {
"title": "range",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/resizeRange"
},
"task": true
},
{
"name": "splitIP4Network",
"summary": "Splits an IPv4 network into the specified number of networks.",
"description": "Splits an IPv4 network into the specified number of networks.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The database object ID of the network that you are splitting.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "numberOfParts",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "numberOfParts",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing the following options:\n\n\n assignDefaultGateway —a Boolean value. If set to\n true , a gateway will be created by using the default\ngateway value whic...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of networks created after splitting the network.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/splitIP4Network"
},
"task": true
},
{
"name": "splitIP6Range",
"summary": "Splits an IPv6 block or network into the specified number of blocks or\nnetworks.",
"description": "Splits an IPv6 block or network into the specified number of blocks or\nnetworks.",
"input": [
{
"name": "numberOfParts",
"type": "number",
"info": "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.: 123",
"required": false,
"schema": {
"title": "numberOfParts",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "No options available. Reserved for future use.: string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "rangeId",
"type": "number",
"info": "The database object ID of the block or network that is being split.: 123",
"required": false,
"schema": {
"title": "rangeId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of IPv6 blocks or networks created after splitting the block or network.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/splitIP6Range"
},
"task": true
},
{
"name": "unassignIP4NetworkTemplate",
"summary": "Unassigns IPv4 network templates.",
"description": "Unassigns IPv4 network templates.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID of the IPv4 network.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the IPv4 template.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/unassignIP4NetworkTemplate"
},
"task": true
},
{
"name": "addCustomOptionDefinition",
"summary": "Adds a custom deployment option.",
"description": "Adds a custom deployment option.",
"input": [
{
"name": "allowMultiple",
"type": "boolean",
"info": "This parameter determines whether or not the custom option requires multiple values. The\ndefault value is false;\n\nIn Perl script, only an empty string and zero (0) are c...(description truncated): boolean",
"required": false,
"schema": {
"title": "allowMultiple",
"type": "boolean"
}
},
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the parent configuration.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the custom deployment option.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "optionId",
"type": "number",
"info": "The option code for the custom deployment option. This value must be\nwithin the range of 151 to 174, 178 to 207, 212 to 219, 222 to 223, or\n224 to 254.: 123",
"required": false,
"schema": {
"title": "optionId",
"type": "number"
}
},
{
"name": "optionType",
"type": "string",
"info": "The type of custom deployment option. This value must be one of the items\nlisted in .: string",
"required": false,
"schema": {
"title": "optionType",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addCustomOptionDefinition"
},
"task": true
},
{
"name": "addDHCP4Range",
"summary": "Adds IPv4 DHCP ranges.",
"description": "Adds IPv4 DHCP ranges.",
"input": [
{
"name": "end",
"type": "string",
"info": "An IP address defining the highest address or end of the range.: string",
"required": false,
"schema": {
"title": "end",
"type": "string"
}
},
{
"name": "networkId",
"type": "number",
"info": "The object ID for the network in which this DHCP range is located.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including the object name and user-defined\nfields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "start",
"type": "string",
"info": "An IP address defining the lowest address or start of the range.: string",
"required": false,
"schema": {
"title": "start",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP4Range"
},
"task": true
},
{
"name": "addDHCP4RangeBySize",
"summary": "Adds IPv4 DHCP ranges by offset and percentage.",
"description": "Adds IPv4 DHCP ranges by offset and percentage.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID for the network in which this DHCP range is located.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "offset",
"type": "string",
"info": "An integer value specifying the point where the range should begin. The\npositive values indicate that the starting IP address of the range will\nbe counted from the Networ...(description truncated): string",
"required": false,
"schema": {
"title": "offset",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Optional object properties that can contain the object name, the value of\n defineRangeBy , and user-defined fields. The possible\nvalues for defineRangeBy are OFFSET_AN...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "size",
"type": "string",
"info": "The size of the range. Currently, you can only specify the range size in\na relative size proportional to the parent network size. To define the\nrelative range size, you m...(description truncated): string",
"required": false,
"schema": {
"title": "size",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP4RangeBySize"
},
"task": true
},
{
"name": "addDHCP6ClientDeploymentOption",
"summary": "Adds DHCPv6 client options and returns the database object ID for the new\noption object.",
"description": "Adds DHCPv6 client options and returns the database object ID for the new\noption object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which you are adding the deployment option.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv6 client option you are adding. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value you are assigning to the option. Depending on the type of\ndeployment option you are adding, the format of the value might differ. For\nmore information, refer t...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP6ClientDeploymentOption"
},
"task": true
},
{
"name": "addDHCP6Range",
"summary": "Adds IPv6 DHCP ranges.",
"description": "Adds IPv6 DHCP ranges.",
"input": [
{
"name": "end",
"type": "string",
"info": "An IP address defining the highest address or end of the range.: string",
"required": false,
"schema": {
"title": "end",
"type": "string"
}
},
{
"name": "networkId",
"type": "number",
"info": "The object ID for the network in which this DHCPv6 range is located.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including the object name and user-defined\nfields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "start",
"type": "string",
"info": "An IP address defining the lowest address or start of the range.: string",
"required": false,
"schema": {
"title": "start",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP6Range"
},
"task": true
},
{
"name": "addDHCP6RangeBySize",
"summary": "Adds IPv6 DHCP ranges by size.",
"description": "Adds IPv6 DHCP ranges by size.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID for the network in which the DHCP range is located.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Optional object properties that can contain the object name, the value of\n defineRangeBy , and user-defined fields. The possible\nvalues for defineRangeBy are AUTOCREAT...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "size",
"type": "string",
"info": "The size of the range. Currently, you can only specify the range size in\na relative size proportional to the parent network size.: string",
"required": false,
"schema": {
"title": "size",
"type": "string"
}
},
{
"name": "start",
"type": "string",
"info": "An integer value or IPv6 address specifying the point where the range\nshould begin. The positive values indicate that the starting IP address\nof the range will be counted...(description truncated): string",
"required": false,
"schema": {
"title": "start",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP6RangeBySize"
},
"task": true
},
{
"name": "addDHCP6ServiceDeploymentOption",
"summary": "Adds DHCPv6 service options.",
"description": "Adds DHCPv6 service options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which you are adding the service option.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv6 service option you are adding. This name must be one\nof the constants listed in\n . If you do not configure the DDNS_UPDATE_STYLE service option,\nt...(description truncated): string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value you are assigning to the option. When adding the DDNS\nhostname option, you must specify the value in the format:\n [Type] , [Data] for IP and DUID. Where:\n\n\n...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCP6ServiceDeploymentOption"
},
"task": true
},
{
"name": "addDHCPClientDeploymentOption",
"summary": "Adds a DHCP client option and returns the object ID for the new option object.",
"description": "Adds a DHCP client option and returns the object ID for the new option object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which you are adding the client option.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 client option you are adding. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value you are assigning to the option. Depending on the type of\ndeployment option you are adding, the format of the value might differ. For\nmore information, refer t...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPClientDeploymentOption"
},
"task": true
},
{
"name": "addDHCPMatchClass",
"summary": "Adds DHCP match classes to Address Manager.",
"description": "Adds DHCP match classes to Address Manager.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration to which you are adding the DHCP match class.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "matchCriteria",
"type": "string",
"info": "A string defining the match criteria. The value must be one of the\nconstants listed in .: string",
"required": false,
"schema": {
"title": "matchCriteria",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCP match class.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the following properties and values:\n\n\n description —a description of the match class.\n\n matchOffset —the Match Offset value for the MatchClass....(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPMatchClass"
},
"task": true
},
{
"name": "addDHCPServiceDeploymentOption",
"summary": "Adds DHCP service options.",
"description": "Adds DHCP service options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which you are adding the service option.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 service option you are adding. This name must be one\nof the constants listed in\n . If you do not configure the DDNS_UPDATE_STYLE service option,\nt...(description truncated): string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value you are assigning to the option. When adding the DDNS\nhostname option, you must specify the value in the format:\n [Type] , [Position] , [Data] for IP and MA...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPServiceDeploymentOption"
},
"task": true
},
{
"name": "addDHCPSubClass",
"summary": "Adds DHCP match class values.",
"description": "Adds DHCP match class values.",
"input": [
{
"name": "matchClassId",
"type": "number",
"info": "The object ID of the match class in which you are defining the DHCP match class value.: 123",
"required": false,
"schema": {
"title": "matchClassId",
"type": "number"
}
},
{
"name": "matchValue",
"type": "string",
"info": "The value of the DHCP match value to be matched with the match class. The\nlength of the match value must be equal to the length, in bytes,\nspecified in the match class.: string",
"required": false,
"schema": {
"title": "matchValue",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing:\n\n\n description —a description of the match class.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPSubClass"
},
"task": true
},
{
"name": "addDHCPVendorDeploymentOption",
"summary": "Adds a DHCP vendor deployment option to specified objects.",
"description": "Adds a DHCP vendor deployment option to specified objects.",
"input": [
{
"name": "optionId",
"type": "number",
"info": "The object ID of the vendor option definition. All DHCP vendor client\ndeployment options have a fixed option code of 60 and a unique option\nsub-code. The unique sub-code ...(description truncated): 123",
"required": false,
"schema": {
"title": "optionId",
"type": "number"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object for the DHCP vendor deployment option.\nThe parent object must not be a DNS object. Valid parent types are\nConfiguration, IP4Block, IP4N...(description truncated): 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields. This value can be\nempty. If the DHCP vendor client deployment option is intended for use\nwith a specific server, th...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "value",
"type": "string",
"info": "The value for the option. The value should be\nappropriate for its option type. For example, if the option type is IP4\nand allowMultiple is set as true in the vendor optio...(description truncated): string",
"required": false,
"schema": {
"title": "value",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPVendorDeploymentOption"
},
"task": true
},
{
"name": "addVendorOptionDefinition",
"summary": "Adds a vendor option definition to a vendor profile.",
"description": "Adds a vendor option definition to a vendor profile.",
"input": [
{
"name": "allowMultiple",
"type": "boolean",
"info": "Determines whether or not the custom option requires multiple values. The\ndefault value is false.\n\nIn Perl script, only an empty string and 0 zero are considered as\n fal...(description truncated): boolean",
"required": false,
"schema": {
"title": "allowMultiple",
"type": "boolean"
}
},
{
"name": "description",
"type": "string",
"info": "A description of the vendor option.: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the vendor option.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "optionId",
"type": "number",
"info": "The deployment option ID. This value must be within the range of 1 to\n254.: 123",
"required": false,
"schema": {
"title": "optionId",
"type": "number"
}
},
{
"name": "optionType",
"type": "string",
"info": "The option type. This value must be one of the types listed in\n .: string",
"required": false,
"schema": {
"title": "optionType",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields. This value can be\nempty.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "vendorProfileId",
"type": "number",
"info": "The object ID of the vendor profile.: 123",
"required": false,
"schema": {
"title": "vendorProfileId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addVendorOptionDefinition"
},
"task": true
},
{
"name": "addVendorProfile",
"summary": "Adds a vendor profile and returns the object ID for the new vendor profile.",
"description": "Adds a vendor profile and returns the object ID for the new vendor profile.",
"input": [
{
"name": "description",
"type": "string",
"info": "A description of the vendor profile.: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "identifier",
"type": "string",
"info": "The Vendor Class Identifier.: string",
"required": false,
"schema": {
"title": "identifier",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "A descriptive name for the vendor profile. This name is not matched\nagainst DHCP functionality.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addVendorProfile"
},
"task": true
},
{
"name": "deleteDHCP6ClientDeploymentOption",
"summary": "Deletes DHCPv6 client options.",
"description": "Deletes DHCPv6 client options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The database object ID for the entity from which this deployment option\nwill be deleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv6 client option being deleted. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which this option is deployed. To\ndelete an option that has not been assigned to a server role, set this\nvalue to 0 (zero) . Omitt...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCP6ClientDeploymentOption"
},
"task": true
},
{
"name": "deleteDHCP6ServiceDeploymentOption",
"summary": "Deletes DHCPv6 service options.",
"description": "Deletes DHCPv6 service options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity from which this deployment option is being\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 service option being deleted. This name must be\none of the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which the option is deployed for\nthe specified entity. To return an option that has not been assigned to a\nserver role, set this v...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCP6ServiceDeploymentOption"
},
"task": true
},
{
"name": "deleteDHCPClientDeploymentOption",
"summary": "Deletes DHCP client options.",
"description": "Deletes DHCP client options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity from which the deployment option will be\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 client option to be deleted. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which this option is deployed. To\ndelete an option that has not been assigned to a server, set this value\nto 0 (zero). Omitting t...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCPClientDeploymentOption"
},
"task": true
},
{
"name": "deleteDHCPServiceDeploymentOption",
"summary": "Deletes DHCP service options.",
"description": "Deletes DHCP service options.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity from which this deployment option is being\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 service option being deleted. This name must be\none of the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which the option is deployed for\nthe specified entity. To retrieve an option that has not been assigned to\na server role, set this...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCPServiceDeploymentOption"
},
"task": true
},
{
"name": "deleteDHCPVendorDeploymentOption",
"summary": "Deletes a specified DHCP vendor deployment option.",
"description": "Deletes a specified DHCP vendor deployment option.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the object to which the DHCP vendor deployment option is\nassigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "optionId",
"type": "number",
"info": "the object ID of the vendor option definition. All DHCP vendor client\ndeployment options have a fixed option code of 60 and a unique option\nsub-code. The unique sub-code ...(description truncated): 123",
"required": false,
"schema": {
"title": "optionId",
"type": "number"
}
},
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server or server group where the DHCP vendor\ndeployment option is used. If the option is generic, set this value to 0\n(zero). Omitting this parameter...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCPVendorDeploymentOption"
},
"task": true
},
{
"name": "getDHCP6ClientDeploymentOption",
"summary": "Returns DHCPv6 client options assigned for the object specified excluding the\noptions inherited fro",
"description": "Returns DHCPv6 client options assigned for the object specified excluding the\noptions inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv6 client option being added. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which this option is deployed. To\nreturn an option that has not been assigned to a server role, set this\nvalue to zero.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCP6ClientDeploymentOption"
},
"task": true
},
{
"name": "getDHCP6ServiceDeploymentOption",
"summary": "Returns DHCPv6 service options assigned for the object specified excluding\nthe options inherited fr",
"description": "Returns DHCPv6 service options assigned for the object specified excluding\nthe options inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The database object ID for the entity to which the deployment option is\nassigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv6 service option being added. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which the option is deployed for\nthe specified entity. To retrieve an option that has not been assigned to\na server role, set this...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCP6ServiceDeploymentOption"
},
"task": true
},
{
"name": "getDHCPClientDeploymentOption",
"summary": "Returns DHCPv4 client options assigned for the object specified excluding the\noptions inherited fro",
"description": "Returns DHCPv4 client options assigned for the object specified excluding the\noptions inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which the deployment option has been\napplied.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 client option being added. This name must be one\nof the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which this option is deployed. To\nreturn an option that has not been assigned to a server, set this value\nto 0 (zero). Omitting thi...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCPClientDeploymentOption"
},
"task": true
},
{
"name": "getDHCPServiceDeploymentOption",
"summary": "Returns DHCP service options assigned for the object specified excluding the\noptions inherited from",
"description": "Returns DHCP service options assigned for the object specified excluding the\noptions inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the entity to which the deployment option is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the DHCPv4 service option being retrieved. This name must be\none of the constants listed in\n .: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "Specifies the server or server group to which the option is deployed for\nthe specified entity. To retrieve an option that has not been assigned to\na server role, specify ...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCPServiceDeploymentOption"
},
"task": true
},
{
"name": "getDHCPVendorDeploymentOption",
"summary": "Retrieves a DHCP vendor deployment option assigned for the object specified\nexcluding the options i",
"description": "Retrieves a DHCP vendor deployment option assigned for the object specified\nexcluding the options inherited from the higher-level parent object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the DHCP vendor deployment option is\nassigned. This must be the ID of a configuration, IPv4 block, IPv4\nnetwork, IPv4 address, IPv4 D...(description truncated): 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "optionId",
"type": "number",
"info": "The object ID of the DHCP vendor option definition.: 123",
"required": false,
"schema": {
"title": "optionId",
"type": "number"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which this option is deployed for\nthe specified entity. To return an option that has not been assigned to a\nserver, set this value ...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCPVendorDeploymentOption"
},
"task": true
},
{
"name": "getSharedNetworks",
"summary": "Returns multiple IPv4 networks linked to the given shared network tag.",
"description": "Returns multiple IPv4 networks linked to the given shared network tag.",
"input": [
{
"name": "tagId",
"type": "number",
"info": "The object ID of the tag that is linked with shared IPv4 networks.\n\nIf tagId is invalid, an error will be returned.: 123",
"required": false,
"schema": {
"title": "tagId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities of all the IPv4 networks linked to the given shared network tag. If no networks are found, returns an empty array.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getSharedNetworks"
},
"task": true
},
{
"name": "shareNetwork",
"summary": "Links an IPv4 network with a shared network tag.",
"description": "Links an IPv4 network with a shared network tag.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID of the IPv4 network that is being linked with a shared\nnetwork tag. If networkId is invalid, an error will be\nreturned.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
},
{
"name": "tagId",
"type": "number",
"info": "The object ID of the tag that is linked. If tagId is not\nvalid, an error will be returned.: 123",
"required": false,
"schema": {
"title": "tagId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/shareNetwork"
},
"task": true
},
{
"name": "unshareNetwork",
"summary": "Unlinks the shared network tag from an IPv4 network.",
"description": "Unlinks the shared network tag from an IPv4 network.",
"input": [
{
"name": "networkId",
"type": "number",
"info": "The object ID of the IPv4 network that is being unlinked from a shared\nnetwork tag. If networkId is invalid, an error will be\nreturned.: 123",
"required": false,
"schema": {
"title": "networkId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/unshareNetwork"
},
"task": true
},
{
"name": "updateDHCP6ClientDeploymentOption",
"summary": "Updates DHCPv6 client options.",
"description": "Updates DHCPv6 client options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DHCPv6 client option object that is updated. The Name field of\nthe DHCPv6 client deployment option object cannot be updated.\n Depending on the type of deployment op...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCP6ClientDeploymentOption"
},
"task": true
},
{
"name": "updateDHCP6ServiceDeploymentOption",
"summary": "Updates DHCPv6 service options.",
"description": "Updates DHCPv6 service options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DHCPv6 service option object to be updated. Depending on the\ntype of deployment option being updated, the format of the value might\ndiffer. For more information, ref...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCP6ServiceDeploymentOption"
},
"task": true
},
{
"name": "updateDHCPClientDeploymentOption",
"summary": "Updates DHCP client options.",
"description": "Updates DHCP client options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DHCP client option object to be updated. The Name field of the\nDHCP client deployment option object cannot be updated.\n Depending on the type of deployment option b...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCPClientDeploymentOption"
},
"task": true
},
{
"name": "updateDHCPServiceDeploymentOption",
"summary": "Updates DHCP service options.",
"description": "Updates DHCP service options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DHCP service option object to be updated. Depending on the type\nof deployment option being updated, the format of the value might differ.\nFor more information, refer...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCPServiceDeploymentOption"
},
"task": true
},
{
"name": "updateDHCPVendorDeploymentOption",
"summary": "Updates the specified DHCP vendor deployment option.",
"description": "Updates the specified DHCP vendor deployment option.",
"input": [
{
"name": "body",
"type": "object",
"info": "APIDeploymentOption to be updated. This is what\n getDHCPVendorDeploymentOption returns.: {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCPVendorDeploymentOption"
},
"task": true
},
{
"name": "addDHCPDeploymentRole",
"summary": "Adds a DHCP deployment role to a specified object.",
"description": "Adds a DHCP deployment role to a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which you are adding the deployment role.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "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 —th...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which you are adding the role.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of DHCP role to be added. The type must be one of those listed\nin .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDHCPDeploymentRole"
},
"task": true
},
{
"name": "addDNSDeploymentRole",
"summary": "Adds a DNS deployment role to a specified object.",
"description": "Adds a DNS deployment role to a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which you are adding the deployment role.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including the View associated with this DNS\ndeployment role and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which you are adding the role.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of DNS role you are adding. The type must be one of those listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addDNSDeploymentRole"
},
"task": true
},
{
"name": "addServer",
"summary": "Adds servers to Address Manager.",
"description": "Adds servers to Address Manager.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration to which you wish to add the server.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "defaultInterfaceAddress",
"type": "string",
"info": "The physical IP address for the server within Address Manager.: string",
"required": false,
"schema": {
"title": "defaultInterfaceAddress",
"type": "string"
}
},
{
"name": "fullHostName",
"type": "string",
"info": "The DNS FQDN by which the server is referenced.: string",
"required": false,
"schema": {
"title": "fullHostName",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the server within Address Manager.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "profile",
"type": "string",
"info": "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 mus...(description truncated): string",
"required": false,
"schema": {
"title": "profile",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "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...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addServer"
},
"task": true
},
{
"name": "addTFTPDeploymentRole",
"summary": "Adds a TFTP deployment role to a specified object.",
"description": "Adds a TFTP deployment role to a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which you wish to add the TFTP deployment role.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server interface to which you wish to add the TFTP deployment role.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTFTPDeploymentRole"
},
"task": true
},
{
"name": "deleteDHCPDeploymentRole",
"summary": "Deletes DHCP deployment roles.",
"description": "Deletes DHCP deployment roles.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object from which the deployment role is to be\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface from which the deployment roles is\nto be deleted.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDHCPDeploymentRole"
},
"task": true
},
{
"name": "deleteDNSDeploymentRole",
"summary": "Deletes a specified DNS deployment role.",
"description": "Deletes a specified DNS deployment role.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object from which this DNS deployment role is to be\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDNSDeploymentRole"
},
"task": true
},
{
"name": "deleteDNSDeploymentRoleForView",
"summary": "Deletes the DNS deployment role assigned to view-level objects in the IP\nspace for ARPA zones.",
"description": "Deletes the DNS deployment role assigned to view-level objects in the IP\nspace for ARPA zones.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object from which this DNS deployment role is to be\ndeleted.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The view from which the DNS deployment role is to be deleted.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDNSDeploymentRoleForView"
},
"task": true
},
{
"name": "deployServer",
"summary": "Deploys servers.",
"description": "Deploys servers. When you invoke this method, the server is immediately deployed.",
"input": [
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server you are deploying.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deployServer"
},
"task": true
},
{
"name": "deployServerConfig",
"summary": "Deploys specific configuration(s) to a particular server.",
"description": "Deploys specific configuration(s) to a particular server.",
"input": [
{
"name": "properties",
"type": "string",
"info": "A string containing property names. The property names available in the\nObjectProperties are ObjectProperties.services , and\n ObjectProperties.forceDNSFullDeployment . M...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The database object ID of the server that will immediately be deployed.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deployServerConfig"
},
"task": true
},
{
"name": "deployServerServices",
"summary": "Deploys specific service(s) to a particular server.",
"description": "Deploys specific service(s) to a particular server.",
"input": [
{
"name": "serverId",
"type": "number",
"info": "The database object ID of the server for which deployment services to be\ndeployed.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
},
{
"name": "services",
"type": "string",
"info": "The name of the valid services to be deployed. Specify multiple services\nusing a comma(,). The valid format is services=DNS,DHCP,TFTP: string",
"required": false,
"schema": {
"title": "services",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deployServerServices"
},
"task": true
},
{
"name": "getDHCPDeploymentRole",
"summary": "Retrieves the DHCP deployment role assigned to a specified object.",
"description": "Retrieves the DHCP deployment role assigned to a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which the deployment role is assigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which the role is assigned.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDHCPDeploymentRole"
},
"task": true
},
{
"name": "getDNSDeploymentRole",
"summary": "Retrieves a DNS deployment role from a specified object.",
"description": "Retrieves a DNS deployment role from a specified object.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDNSDeploymentRole"
},
"task": true
},
{
"name": "getDNSDeploymentRoleForView",
"summary": "Retrieves the DNS deployment role assigned to a view-level objects in the IP\nspace for ARPA zones.",
"description": "Retrieves the DNS deployment role assigned to a view-level objects in the IP\nspace for ARPA zones.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for the object to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "serverInterfaceId",
"type": "number",
"info": "The object ID of the server interface to which the DNS deployment role is\nassigned.: 123",
"required": false,
"schema": {
"title": "serverInterfaceId",
"type": "number"
}
},
{
"name": "viewId",
"type": "number",
"info": "The view in which the DNS deployment role is assigned.: 123",
"required": false,
"schema": {
"title": "viewId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDNSDeploymentRoleForView"
},
"task": true
},
{
"name": "getDeploymentRoles",
"summary": "Returns the DNS and DHCP deployment roles associated with the specified\nobject.",
"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.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID for a DNS view, DNS zone, IPv4 block or network, IPv6 block\nor network, DHCP class, or MAC pool.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of APIDeploymentRole objects representing the deployment roles associated with the specified object.",
"type": "array",
"items": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDeploymentRoles"
},
"task": true
},
{
"name": "getDeploymentTaskStatus",
"summary": "Returns the deployment status of the deployment task that was created using\nthe.",
"description": "Returns the deployment status of the deployment task that was created using\nthe selectiveDeploy API method.",
"input": [
{
"name": "deploymentTaskToken",
"type": "string",
"info": "The string token value that is returned from the\n selectiveDeploy} API method.: string",
"required": false,
"schema": {
"title": "deploymentTaskToken",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDeploymentTaskStatus"
},
"task": true
},
{
"name": "getServerDeploymentRoles",
"summary": "Returns a list of all deployment roles associated with the server.",
"description": "Returns a list of all deployment roles associated with the server.",
"input": [
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server with which deployment roles are associated.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns a list of all deployment roles associated with the server.",
"type": "array",
"items": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getServerDeploymentRoles"
},
"task": true
},
{
"name": "getServerDeploymentStatus",
"summary": "Returns the deployment status of the server.",
"description": "Returns the deployment status of the server.",
"input": [
{
"name": "properties",
"type": "string",
"info": "The valid value is empty .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server whose deployment status needs to be checked.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getServerDeploymentStatus"
},
"task": true
},
{
"name": "getServerForRole",
"summary": "Returns a list of all servers associated with the specified deployment role.",
"description": "Returns a list of all servers associated with the specified deployment role.",
"input": [
{
"name": "roleId",
"type": "number",
"info": "The object ID for the deployment role whose servers are to be returned.: 123",
"required": false,
"schema": {
"title": "roleId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getServerForRole"
},
"task": true
},
{
"name": "moveDeploymentRoles",
"summary": "Moves all DNS and DHCP deployment roles from a server to the specified\ninterface of another server.",
"description": "Moves all DNS and DHCP deployment roles from a server to the specified\ninterface of another server.",
"input": [
{
"name": "moveDhcpRoles",
"type": "boolean",
"info": "If set to true , DHCP roles will be moved to the target\nserver interface.: boolean",
"required": false,
"schema": {
"title": "moveDhcpRoles",
"type": "boolean"
}
},
{
"name": "moveDnsRoles",
"type": "boolean",
"info": "If set to true , DNS roles will be moved to the target\nserver interface.: boolean",
"required": false,
"schema": {
"title": "moveDnsRoles",
"type": "boolean"
}
},
{
"name": "options",
"type": "string",
"info": "This is reserved for future use.: string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "sourceServerId",
"type": "number",
"info": "The object ID of the server that contains the roles.: 123",
"required": false,
"schema": {
"title": "sourceServerId",
"type": "number"
}
},
{
"name": "targetServerInterfaceId",
"type": "number",
"info": "The object ID of the server interface of the server to which the roles\nare to be moved.: 123",
"required": false,
"schema": {
"title": "targetServerInterfaceId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/moveDeploymentRoles"
},
"task": true
},
{
"name": "quickDeploy",
"summary": "Instantly deploys changes you made to DNS resource records\nsince the last full or quick deployment.",
"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.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the DNS zone or network for which deployment service\nneeds to be deployed.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the services option. It can also be\n empty .\n\n\n services —the name of the valid service that need to be\ndeployed. The only valid service name f...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/quickDeploy"
},
"task": true
},
{
"name": "replaceServer",
"summary": "Replaces a server.",
"description": "Replaces a server.",
"input": [
{
"name": "defaultInterface",
"type": "string",
"info": "Management interface address for the server.: string",
"required": false,
"schema": {
"title": "defaultInterface",
"type": "string"
}
},
{
"name": "hostName",
"type": "string",
"info": "The DNS FQDN by which the server is referenced.: string",
"required": false,
"schema": {
"title": "hostName",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Name of the server to be replaced.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "password",
"type": "string",
"info": "The server password by default, bluecat .: string",
"required": false,
"schema": {
"title": "password",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "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\nmanage...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The object ID of the server that needs to be replaced.: 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
},
{
"name": "upgrade",
"type": "boolean",
"info": "Flag indicating that server needs to be upgraded or not. True means\nserver needs to be upgraded.: boolean",
"required": false,
"schema": {
"title": "upgrade",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/replaceServer"
},
"task": true
},
{
"name": "selectiveDeploy",
"summary": "Selectively deploys—creates a differential deployment task to deploy changes made to specific DNS\ne",
"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.",
"input": [
{
"name": "properties",
"type": "string",
"info": "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 ...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "body",
"type": "array",
"info": "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 10...(description truncated): array",
"required": false,
"schema": {
"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",
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/selectiveDeploy"
},
"task": true
},
{
"name": "updateDHCPDeploymentRole",
"summary": "Updates a DHCP deployment role.",
"description": "Updates a DHCP deployment role.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DHCP deployment role object to be updated.: {\"id\": 123, \"type\": \"string\", \"service\": \"string\", \"entityId\": 123, \"serverInterfaceId\": 123, \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDHCPDeploymentRole"
},
"task": true
},
{
"name": "updateDNSDeploymentRole",
"summary": "Updates a specified DNS deployment role.",
"description": "Updates a specified DNS deployment role.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DNS deployment role object to be updated.: {\"id\": 123, \"type\": \"string\", \"service\": \"string\", \"entityId\": 123, \"serverInterfaceId\": 123, \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentRole",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the deployment role in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"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.",
"type": "string"
},
"service": {
"readOnly": false,
"description": "DNS, DHCP, or TFTP. This field cannot be null.",
"type": "string"
},
"entityId": {
"readOnly": false,
"description": "The database ID of the entity. This value must be greater\nthan 0.",
"type": "integer",
"format": "int64"
},
"serverInterfaceId": {
"readOnly": false,
"description": "The database ID of the sever interface. This value must\nbe greater than 0.",
"type": "integer",
"format": "int64"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute=value. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"service": "...",
"entityId": 12345,
"serverInterfaceId": 12345,
"properties": "..."
},
"description": "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateDNSDeploymentRole"
},
"task": true
},
{
"name": "addEntity",
"summary": "A generic method for adding configurations, DNS zones, and DNS resource\nrecords.",
"description": "A generic method for adding configurations, DNS zones, and DNS resource\nrecords.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The parent ID of the new entity. For configurations, always set the parentId value to 0\n\nzero , which is the root element.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "body",
"type": "object",
"info": "The object configuration, including its name, sharedNetwork, and\nuser-defined fields.: {\"id\": 123, \"name\": \"string\", \"type\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addEntity"
},
"task": true
},
{
"name": "assignOrUpdateTemplate",
"summary": "Assigns, updates, or removes DNS zone and IPv4 network templates.",
"description": "Assigns, updates, or removes DNS zone and IPv4 network templates.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the IPv4 network to which the network template is to be\nassigned or updated, or the object ID of the zone to which the zone\ntemplate is to be assigned or...(description truncated): 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing the following settings:\n\n\n ObjectProperties.templateType —Specifies the type of template\non which this operation is being performed.\n\nThe possible...(description truncated): string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "templateId",
"type": "number",
"info": "The object ID of the DNS zone template or IPv4 network template. To\nremove a template, set this value to zero.: 123",
"required": false,
"schema": {
"title": "templateId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignOrUpdateTemplate"
},
"task": true
},
{
"name": "customSearch",
"summary": "Search for an array of entities by specifying object properties.",
"description": "Search for an array of entities by specifying object properties.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return. The value must be a positive\nvalue between 1 and 1000.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "filters",
"type": "array",
"info": "The list of properties on which the search will be based. The valid\nformat is Field name=value . Refer to for\ndetails. The field name is case-sensitive.\n\nIn additio...(description truncated): array",
"required": false,
"schema": {
"title": "filters",
"type": "array"
}
},
{
"name": "options",
"type": "array",
"info": "The list of search options specifying the search behavior. Reserved for\nfuture use.: array",
"required": false,
"schema": {
"title": "options",
"type": "array"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The value must be a positive value.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The object type that you wish to search. This must be one for the following object types:\n\n\n IP4Block\n\n IP4Network\n\n IP4Addr\n\n GenericRecord\n\n HostRecord\n\n Any othe...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of APIEntities matching the specified object properties or returns an empty array. The APIEntity will at least contain Object Type, Object ID, Object Name, and Object Properties.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/customSearch"
},
"task": true
},
{
"name": "delete",
"summary": "Deletes an object using the generic.",
"description": "Deletes an object using the generic delete method.",
"input": [
{
"name": "objectId",
"type": "number",
"info": "The ID for the object to be deleted.: 123",
"required": false,
"schema": {
"title": "objectId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/delete"
},
"task": true
},
{
"name": "deleteWithOptions",
"summary": "Deletes objects that have options associated with their removal.",
"description": "Deletes objects that have options associated with their removal.\nWhen deleting dynamic resource records, you can choose not to\ndynamically deploy the changes to the DNS/DHCP Server.",
"input": [
{
"name": "objectId",
"type": "number",
"info": "The ID for the object to be deleted.: 123",
"required": false,
"schema": {
"title": "objectId",
"type": "number"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing the following delete options:\n\n\n noServerUpdate —a Boolean value. This applies to the\ndynamic resource records. Set to true to update the record\n...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteWithOptions"
},
"task": true
},
{
"name": "getEntities",
"summary": "Returns multiple entities for the specified parent ID.",
"description": "Returns multiple entities for the specified parent ID.",
"input": [
{
"name": "count",
"type": "number",
"info": "Indicates the maximum number of child objects to return.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the entities.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of child objects to start returning entities. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object to be returned. This value must be one of the object\ntypes listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities. The array is empty if there are no matching entities.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntities"
},
"task": true
},
{
"name": "getEntitiesByName",
"summary": "Returns an array of entities that match the specified parent, name, and\nobject type.",
"description": "Returns an array of entities that match the specified parent, name, and\nobject type.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return. The default value is 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the entity.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the entities to be returned.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object to be returned. This value must be one of the object\ntypes listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities. The array is empty if there are no matching entities.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntitiesByName"
},
"task": true
},
{
"name": "getEntitiesByNameUsingOptions",
"summary": "Returns an array of entities that match the specified name and object type.",
"description": "Returns an array of entities that match the specified name and object type.\nSearching behavior can be changed by using the options.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return. The default value is 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the entity.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "options",
"type": "string",
"info": "A string containing options. Currently the only available option is\n ObjectProperties.ignoreCase . By default, the value is set to\nfalse. Setting this option to true will...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the entities to be returned.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object to be returned. This value must be one of the object\ntypes listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities. The array is empty if there are no matching entities.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntitiesByNameUsingOptions"
},
"task": true
},
{
"name": "getEntityByCIDR",
"summary": "Returns an IPv4 Network object from the database by calling it using CIDR\nnotation.",
"description": "Returns an IPv4 Network object from the database by calling it using CIDR\nnotation.",
"input": [
{
"name": "cidr",
"type": "string",
"info": "CIDR notation defining the network for example, 10.10.10/24.: string",
"required": false,
"schema": {
"title": "cidr",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the network’s parent object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object returned: IP4Network. This must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntityByCIDR"
},
"task": true
},
{
"name": "getEntityById",
"summary": "Returns objects from the database referenced by their database ID and with\nits properties fields po",
"description": "Returns objects from the database referenced by their database ID and with\nits properties fields populated. For more information about the available options,\nrefer to\nin the section.",
"input": [
{
"name": "id",
"type": "number",
"info": "The object ID of the target object.: 123",
"required": false,
"schema": {
"title": "id",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntityById"
},
"task": true
},
{
"name": "getEntityByName",
"summary": "Returns objects from the database referenced by their name field.",
"description": "Returns objects from the database referenced by their name field.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the target object.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The ID of the target object’s parent object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object returned by the method. This string must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntityByName"
},
"task": true
},
{
"name": "getEntityByPrefix",
"summary": "Returns an APIEntity for the specified IP block or network.",
"description": "Returns an APIEntity for the specified IP block or network.",
"input": [
{
"name": "containerId",
"type": "number",
"info": "The object ID of higher-level parent object IP block or configuration in\nwhich the IP block or network is located.: 123",
"required": false,
"schema": {
"title": "containerId",
"type": "number"
}
},
{
"name": "prefix",
"type": "string",
"info": "The prefix value for the IP block or network.: string",
"required": false,
"schema": {
"title": "prefix",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object to be returned. This string must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntityByPrefix"
},
"task": true
},
{
"name": "getEntityByRange",
"summary": "Returns an IPv4 DHCP range object by calling it using its range.",
"description": "Returns an IPv4 DHCP range object by calling it using its range.",
"input": [
{
"name": "address1",
"type": "string",
"info": "An IP address defining the lowest address or start of the range.: string",
"required": false,
"schema": {
"title": "address1",
"type": "string"
}
},
{
"name": "address2",
"type": "string",
"info": "An IP address defining the highest address or end of the range.: string",
"required": false,
"schema": {
"title": "address2",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the DHCP range.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object returned: DHCP4Range. This must be one of the\nconstants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getEntityByRange"
},
"task": true
},
{
"name": "getLinkedEntities",
"summary": "Returns an array of entities containing the entities linked to a specified\nentity.",
"description": "Returns an array of entities containing the entities linked to a specified\nentity. The array is empty if there are no linked entities.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity for which to return linked entities.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "type",
"type": "string",
"info": "The type of linked entities which need to be returned. This value must be\none of the types listed in\n .\n\n\n\n While specifying a resource record as the entityId ,\nif you...(description truncated): string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities. The array is empty if there are no linked entities.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getLinkedEntities"
},
"task": true
},
{
"name": "getParent",
"summary": "Returns the parent entity of a given entity.",
"description": "Returns the parent entity of a given entity.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The entity ID of the parent object.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getParent"
},
"task": true
},
{
"name": "getSystemInfo",
"summary": "Gets Address Manager system information.",
"description": "Gets Address Manager system information.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getSystemInfo"
},
"task": true
},
{
"name": "linkEntities",
"summary": "Establishes a link between two specified Address Manager entities.",
"description": "Establishes a link between two specified Address Manager entities.",
"input": [
{
"name": "entity1Id",
"type": "number",
"info": "The object ID of the first entity in the pair of linked entities.: 123",
"required": false,
"schema": {
"title": "entity1Id",
"type": "number"
}
},
{
"name": "entity2Id",
"type": "number",
"info": "The object ID of the second entity in the pair of linked entities.: 123",
"required": false,
"schema": {
"title": "entity2Id",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/linkEntities"
},
"task": true
},
{
"name": "login",
"summary": "Logs in as API user.",
"description": "Logs in as API user.\n\nYou must use an API user account to access the Address Manager API.",
"input": [
{
"name": "password",
"type": "string",
"info": "The password for the API user logging into Address Manager.: string",
"required": false,
"schema": {
"title": "password",
"type": "string"
}
},
{
"name": "username",
"type": "string",
"info": "The username for the API user created using the Address Manager user\ninterface.: string",
"required": false,
"schema": {
"title": "username",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/login"
},
"task": true
},
{
"name": "loginWithOptions",
"summary": "Logs in as an API user with the option to change the locale to Japanese or Simplified Chinese.",
"description": "Logs in as an API user with the option to change the locale to Japanese or Simplified Chinese.\n\nChanging locale only affects the behavior of the getUserDefinedFields and updateBulkUdf methods.",
"input": [
{
"name": "options",
"type": "string",
"info": "You can use one of the following options:\n\n\n locale=ja-JA\n\n locale=zh-CN: string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "password",
"type": "string",
"info": "The password for the API user logging into Address Manager.: string",
"required": false,
"schema": {
"title": "password",
"type": "string"
}
},
{
"name": "username",
"type": "string",
"info": "The username for the API user created using the Address Manager user\ninterface.: string",
"required": false,
"schema": {
"title": "username",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/loginWithOptions"
},
"task": true
},
{
"name": "logout",
"summary": "Logs out of the current API session.",
"description": "Logs out of the current API session.\n\nOnce you have logged out, you must log in again to execute new API calls.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/logout"
},
"task": true
},
{
"name": "searchByCategory",
"summary": "Returns an array of entities by searching for keywords associated with\nobjects of a specified objec",
"description": "Returns an array of entities by searching for keywords associated with\nobjects of a specified object category.",
"input": [
{
"name": "category",
"type": "string",
"info": "The entity category to be searched. This must be one of the entity\ncategories listed in\n .: string",
"required": false,
"schema": {
"title": "category",
"type": "string"
}
},
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return. The default value is 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "keyword",
"type": "string",
"info": "The search keyword string.: string",
"required": false,
"schema": {
"title": "keyword",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities matching the keyword text and the category type, or returns an empty array.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/searchByCategory"
},
"task": true
},
{
"name": "searchByObjectTypes",
"summary": "Returns an array of entities by searching for keywords associated with\nobjects of a specified objec",
"description": "Returns an array of entities by searching for keywords associated with\nobjects of a specified object type. You can search for multiple object types\nwith a single method call.",
"input": [
{
"name": "count",
"type": "number",
"info": "The maximum number of objects to return. The default value is 10.: 123",
"required": false,
"schema": {
"title": "count",
"type": "number"
}
},
{
"name": "keyword",
"type": "string",
"info": "The search keyword string.: string",
"required": false,
"schema": {
"title": "keyword",
"type": "string"
}
},
{
"name": "start",
"type": "number",
"info": "Indicates where in the list of returned objects to start returning\nobjects. The list begins at an index of 0.: 123",
"required": false,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "types",
"type": "string",
"info": "The object types for which to search, specified in the format:\n \"type1[,type2…]\" The object type must be one of the types\nlisted in\n .: string",
"required": false,
"schema": {
"title": "types",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns an array of entities matching the keyword text and the category type, or returns an empty array.",
"type": "array",
"items": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/searchByObjectTypes"
},
"task": true
},
{
"name": "unlinkEntities",
"summary": "Removes the link between two specified Address Manager entities.",
"description": "Removes the link between two specified Address Manager entities.",
"input": [
{
"name": "entity1Id",
"type": "number",
"info": "The object ID of the first entity in the pair of linked entities.: 123",
"required": false,
"schema": {
"title": "entity1Id",
"type": "number"
}
},
{
"name": "entity2Id",
"type": "number",
"info": "The object ID of the second entity in the pair of linked entities.: 123",
"required": false,
"schema": {
"title": "entity2Id",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/unlinkEntities"
},
"task": true
},
{
"name": "update",
"summary": "Updates entity objects.",
"description": "Updates entity objects. If you are updating the state of an IPv4\naddress, use the API\nmethod.",
"input": [
{
"name": "body",
"type": "object",
"info": "The actual API entity passed as an entire object that has its mutable\nvalues updated.: {\"id\": 123, \"name\": \"string\", \"type\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/update"
},
"task": true
},
{
"name": "updateWithOptions",
"summary": "Updates objects requiring a certain behavior that is not covered by the\nregular.",
"description": "Updates objects requiring a certain behavior that is not covered by the\nregular update method. This method only applies to CNAME, MX, and SRV\nrecords.",
"input": [
{
"name": "options",
"type": "string",
"info": "A string containing the update options. Currently, only one option is\nsupported: linkToExternalHost=boolean . If true ,\nupdate will search for the external host record ...(description truncated): string",
"required": false,
"schema": {
"title": "options",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "The actual API entity to be updated.: {\"id\": 123, \"name\": \"string\", \"type\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIEntity",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the object in Address Manager.",
"type": "integer",
"format": "int64"
},
"name": {
"readOnly": false,
"description": "The field name, which might be null.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The class name of the object. For example, a\nconfiguration object has a type equal to\nConfiguration. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as ttl=123|comments=my\ncomment|. This field can be null.",
"type": "string"
}
},
"example": {
"id": 12345,
"name": "...",
"type": "...",
"properties": "..."
},
"description": "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in ."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateWithOptions"
},
"task": true
},
{
"name": "addRawDeploymentOption",
"summary": "Adds raw deployment options.",
"description": "Adds raw deployment options.\n\nRaw deployment options are added to DNS or DHCP services in a format that\nwill be passed to the service when deployed. The SOAP version of this\nAPI has a different signature than the REST version.",
"input": [
{
"name": "parentId",
"type": "number",
"info": "The object ID for the entity to which you are adding the deployment option.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "body",
"type": "object",
"info": "Object containing information about the raw deployment option:\n\n type - The type of option. The type must be one of the\nfollowing values:\n\n DNS_RAW\n DHCP_RAW\n DHCPV...(description truncated): {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addRawDeploymentOption"
},
"task": true
},
{
"name": "getDeploymentOptions",
"summary": "Retrieves deployment options for Address Manager DNS and DHCP services.",
"description": "Retrieves deployment options for Address Manager DNS and DHCP services.",
"input": [
{
"name": "entityId",
"type": "number",
"info": "The object ID of the entity to which the DNS or DHCP deployment option is\nassigned.: 123",
"required": false,
"schema": {
"title": "entityId",
"type": "number"
}
},
{
"name": "optionTypes",
"type": "string",
"info": "The type of deployment options. Multiple options can be separated by a |\n(pipe) character. This value must be one of the following items:\n\n\n DNSOption\n\n DNSRawOption\n\n...(description truncated): string",
"required": false,
"schema": {
"title": "optionTypes",
"type": "string"
}
},
{
"name": "serverId",
"type": "number",
"info": "The specific server or server group to which options are deployed. The\nvalid values are as follows:\n\n\n >0 —returns only the options that are linked to the\nspecified...(description truncated): 123",
"required": false,
"schema": {
"title": "serverId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns all deployment options assigned to the specified object including inherited options from higher level parent objects. If an option is inherited and overridden, then only the overriding option will be returned.",
"type": "array",
"items": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDeploymentOptions"
},
"task": true
},
{
"name": "updateRawDeploymentOption",
"summary": "Updates raw deployment options.",
"description": "Updates raw deployment options.",
"input": [
{
"name": "body",
"type": "object",
"info": "The DNS or DHCP raw option object to be updated.: {\"id\": 123, \"type\": \"string\", \"name\": \"string\", \"value\": \"string\", \"properties\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIDeploymentOption",
"properties": {
"id": {
"readOnly": false,
"description": "The database ID of the option in Address Manager.",
"type": "integer",
"format": "int64"
},
"type": {
"readOnly": false,
"description": "The option type listed in Option\nTypes. This field cannot be null.",
"type": "string"
},
"name": {
"readOnly": false,
"description": "The name of the option.",
"type": "string"
},
"value": {
"readOnly": false,
"description": "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type": "string"
},
"properties": {
"readOnly": false,
"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.",
"type": "string"
}
},
"example": {
"id": 12345,
"type": "...",
"name": "...",
"value": "...",
"properties": "..."
},
"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."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateRawDeploymentOption"
},
"task": true
},
{
"name": "addTFTPFile",
"summary": "Adds TFTP files.",
"description": "Adds TFTP files.",
"input": [
{
"name": "inputStream",
"type": "string",
"info": "The file to be uploaded and distributed to clients by TFTP. The file is\npassed to Address Manager as a byte array.: string",
"required": false,
"schema": {
"title": "inputStream",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the TFTP file.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the TFTP file. The parent will\nalways be a TFTP folder.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including user-defined fields and\ndescription properties.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "version",
"type": "string",
"info": "The version of the file. This parameter is optional.: string",
"required": false,
"schema": {
"title": "version",
"type": "string"
}
},
{
"name": "body",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "body",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTFTPFile"
},
"task": true
},
{
"name": "addTFTPFolder",
"summary": "Adds TFTP folders.",
"description": "Adds TFTP folders.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the TFTP folder.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "parentId",
"type": "number",
"info": "The object ID of the parent object of the TFTP folder. The parent is\neither a TFTP group or another TFTP folder object.: 123",
"required": false,
"schema": {
"title": "parentId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTFTPFolder"
},
"task": true
},
{
"name": "addTFTPGroup",
"summary": "Adds TFTP groups.",
"description": "Adds TFTP groups.",
"input": [
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration where you wish to add the TFTP group.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "The name of the TFTP group.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Adds object properties, including comments and user-defined fields.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addTFTPGroup"
},
"task": true
},
{
"name": "addUserDefinedField",
"summary": "Adds user-defined fields.",
"description": "Adds user-defined fields.",
"input": [
{
"name": "type",
"type": "string",
"info": "The type of object the user-defined field belongs to. This must be one of\nthe constants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "The user-defined field assigned to an object.: {\"name\": \"string\", \"displayName\": \"string\", \"type\": \"string\", \"defaultValue\": \"string\", \"validatorProperties\": \"string\", \"properties\": \"string\", \"predefinedValues\": \"string\", \"required\": \"boolean\", \"renderAsRadioButton\": \"boolean\", \"hideFromSearch\": \"boolean\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIUserDefinedField",
"properties": {
"name": {
"readOnly": false,
"description": "The internal name of the user-defined field.",
"type": "string"
},
"displayName": {
"readOnly": false,
"description": "The name of the user-defined field that appears to users in the\nAddress Manager interface.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The type of the user-defined field. Types are available\nas constants in the UserDefinedFieldType class. For\navailable constants, refer to .",
"type": "string"
},
"defaultValue": {
"readOnly": false,
"description": "The default value for the user-defined field.",
"type": "string"
},
"validatorProperties": {
"readOnly": false,
"description": "The validation properties for the user-defined field.\nProperty names are available as constants in the\nUserDefinedFieldValidatorProperties class. For\navailable constants, refer to .",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "The following property can be used:\n- locales=en-US,ja-JP,zh-CN
\n
\nYou must enable the supported locales in the global settings of\nthe Address Manager user interface before you can use them within UDFs.\n",
"type": "string"
},
"predefinedValues": {
"readOnly": false,
"description": "The preset values for the user-defined field separated by a | (pipe)\ncharacter and ending with a pipe character. For example, value1|value2|.",
"type": "string"
},
"required": {
"readOnly": false,
"description": "The boolean value. If set to true, users must enter data\nin the field.",
"type": "boolean"
},
"renderAsRadioButton": {
"readOnly": false,
"description": "This has been deprecated.",
"type": "boolean"
},
"hideFromSearch": {
"readOnly": false,
"description": "The boolean value. If set to true, the user-defined field\nis hidden from the search.",
"type": "boolean"
}
},
"example": {
"name": "...",
"displayName": "...",
"type": "...",
"defaultValue": "...",
"validatorProperties": "...",
"properties": "...",
"predefinedValues": "...",
"required": true,
"hideFromSearch": true
},
"description": "User-defined fields can be added to each of the Address Manager object types.\nThis class allows API users to query and gather user-defined fields\ninformation for a specified object type."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addUserDefinedField"
},
"task": true
},
{
"name": "deleteUserDefinedField",
"summary": "Deletes user-defined fields.",
"description": "Deletes user-defined fields.",
"input": [
{
"name": "name",
"type": "string",
"info": "The internal name of the user-defined field.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object the user-defined field belongs to. This must be one of\nthe constants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteUserDefinedField"
},
"task": true
},
{
"name": "getUserDefinedFields",
"summary": "Returns the user-defined fields information.",
"description": "Returns the user-defined fields information.",
"input": [
{
"name": "requiredFieldsOnly",
"type": "boolean",
"info": "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.: boolean",
"required": false,
"schema": {
"title": "requiredFieldsOnly",
"type": "boolean"
}
},
{
"name": "type",
"type": "string",
"info": "The type of object the user-defined field belongs to. This must be one of\nthe constants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Returns the user-defined fields information.",
"type": "array",
"items": {
"type": "object",
"title": "APIUserDefinedField",
"properties": {
"name": {
"readOnly": false,
"description": "The internal name of the user-defined field.",
"type": "string"
},
"displayName": {
"readOnly": false,
"description": "The name of the user-defined field that appears to users in the\nAddress Manager interface.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The type of the user-defined field. Types are available\nas constants in the UserDefinedFieldType class. For\navailable constants, refer to .",
"type": "string"
},
"defaultValue": {
"readOnly": false,
"description": "The default value for the user-defined field.",
"type": "string"
},
"validatorProperties": {
"readOnly": false,
"description": "The validation properties for the user-defined field.\nProperty names are available as constants in the\nUserDefinedFieldValidatorProperties class. For\navailable constants, refer to .",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "The following property can be used:\n- locales=en-US,ja-JP,zh-CN
\n
\nYou must enable the supported locales in the global settings of\nthe Address Manager user interface before you can use them within UDFs.\n",
"type": "string"
},
"predefinedValues": {
"readOnly": false,
"description": "The preset values for the user-defined field separated by a | (pipe)\ncharacter and ending with a pipe character. For example, value1|value2|.",
"type": "string"
},
"required": {
"readOnly": false,
"description": "The boolean value. If set to true, users must enter data\nin the field.",
"type": "boolean"
},
"renderAsRadioButton": {
"readOnly": false,
"description": "This has been deprecated.",
"type": "boolean"
},
"hideFromSearch": {
"readOnly": false,
"description": "The boolean value. If set to true, the user-defined field\nis hidden from the search.",
"type": "boolean"
}
},
"example": {
"name": "...",
"displayName": "...",
"type": "...",
"defaultValue": "...",
"validatorProperties": "...",
"properties": "...",
"predefinedValues": "...",
"required": true,
"hideFromSearch": true
},
"description": "User-defined fields can be added to each of the Address Manager object types.\nThis class allows API users to query and gather user-defined fields\ninformation for a specified object type."
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getUserDefinedFields"
},
"task": true
},
{
"name": "updateBulkUdf",
"summary": "Updates values of various user-defined fields (UDFs) for different objects.",
"description": "Updates values of various user-defined fields (UDFs) for different objects.",
"input": [
{
"name": "inputStream",
"type": "string",
"info": "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 ...(description truncated): string",
"required": false,
"schema": {
"title": "inputStream",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "body",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "body",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"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.",
"type": "array",
"items": {
"type": "number"
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateBulkUdf"
},
"task": true
},
{
"name": "updateUserDefinedField",
"summary": "Updates user-defined fields.",
"description": "Updates user-defined fields.",
"input": [
{
"name": "type",
"type": "string",
"info": "The type of object the user-defined field belongs to. This must be one of\nthe constants listed in\n .: string",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "The user-defined field assigned to an object.: {\"name\": \"string\", \"displayName\": \"string\", \"type\": \"string\", \"defaultValue\": \"string\", \"validatorProperties\": \"string\", \"properties\": \"string\", \"predefinedValues\": \"string\", \"required\": \"boolean\", \"renderAsRadioButton\": \"boolean\", \"hideFromSearch\": \"boolean\"}",
"required": false,
"schema": {
"type": "object",
"title": "APIUserDefinedField",
"properties": {
"name": {
"readOnly": false,
"description": "The internal name of the user-defined field.",
"type": "string"
},
"displayName": {
"readOnly": false,
"description": "The name of the user-defined field that appears to users in the\nAddress Manager interface.",
"type": "string"
},
"type": {
"readOnly": false,
"description": "The type of the user-defined field. Types are available\nas constants in the UserDefinedFieldType class. For\navailable constants, refer to .",
"type": "string"
},
"defaultValue": {
"readOnly": false,
"description": "The default value for the user-defined field.",
"type": "string"
},
"validatorProperties": {
"readOnly": false,
"description": "The validation properties for the user-defined field.\nProperty names are available as constants in the\nUserDefinedFieldValidatorProperties class. For\navailable constants, refer to .",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "The following property can be used:\n- locales=en-US,ja-JP,zh-CN
\n
\nYou must enable the supported locales in the global settings of\nthe Address Manager user interface before you can use them within UDFs.\n",
"type": "string"
},
"predefinedValues": {
"readOnly": false,
"description": "The preset values for the user-defined field separated by a | (pipe)\ncharacter and ending with a pipe character. For example, value1|value2|.",
"type": "string"
},
"required": {
"readOnly": false,
"description": "The boolean value. If set to true, users must enter data\nin the field.",
"type": "boolean"
},
"renderAsRadioButton": {
"readOnly": false,
"description": "This has been deprecated.",
"type": "boolean"
},
"hideFromSearch": {
"readOnly": false,
"description": "The boolean value. If set to true, the user-defined field\nis hidden from the search.",
"type": "boolean"
}
},
"example": {
"name": "...",
"displayName": "...",
"type": "...",
"defaultValue": "...",
"validatorProperties": "...",
"properties": "...",
"predefinedValues": "...",
"required": true,
"hideFromSearch": true
},
"description": "User-defined fields can be added to each of the Address Manager object types.\nThis class allows API users to query and gather user-defined fields\ninformation for a specified object type."
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateUserDefinedField"
},
"task": true
},
{
"name": "breakXHAPair",
"summary": "Breaks an xHA pair and returns each server to its original stand-alone state.",
"description": "Breaks an xHA pair and returns each server to its original stand-alone state.",
"input": [
{
"name": "breakInProteusOnly",
"type": "boolean",
"info": "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, eve...(description truncated): boolean",
"required": false,
"schema": {
"title": "breakInProteusOnly",
"type": "boolean"
}
},
{
"name": "xHAServerId",
"type": "number",
"info": "The object ID of the xHA server.: 123",
"required": false,
"schema": {
"title": "xHAServerId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/breakXHAPair"
},
"task": true
},
{
"name": "createXHAPair",
"summary": "Creates an xHA pair.",
"description": "Creates an xHA pair.",
"input": [
{
"name": "activeServerId",
"type": "number",
"info": "The object ID of the active DNS/DHCP Server.: 123",
"required": false,
"schema": {
"title": "activeServerId",
"type": "number"
}
},
{
"name": "activeServerNewIPv4Address",
"type": "string",
"info": "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 s...(description truncated): string",
"required": false,
"schema": {
"title": "activeServerNewIPv4Address",
"type": "string"
}
},
{
"name": "configurationId",
"type": "number",
"info": "The object ID of the configuration in which the xHA servers are located.: 123",
"required": false,
"schema": {
"title": "configurationId",
"type": "number"
}
},
{
"name": "passiveServerId",
"type": "number",
"info": "The object ID of the passive DNS/DHCP Server.: 123",
"required": false,
"schema": {
"title": "passiveServerId",
"type": "number"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options listed in\n .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/createXHAPair"
},
"task": true
},
{
"name": "editXHAPair",
"summary": "Updates the xHA pair created.",
"description": "Updates the xHA pair created.",
"input": [
{
"name": "name",
"type": "string",
"info": "The name of the xHA server being updated.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "A string containing options listed in\n .: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "xHAServerId",
"type": "number",
"info": "The object ID of the xHA server.: 123",
"required": false,
"schema": {
"title": "xHAServerId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/editXHAPair"
},
"task": true
},
{
"name": "failoverXHA",
"summary": "Performs a manual xHA failover.",
"description": "Performs a manual xHA failover.",
"input": [
{
"name": "xHAServerId",
"type": "number",
"info": "The object ID of the xHA server.: 123",
"required": false,
"schema": {
"title": "xHAServerId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/failoverXHA"
},
"task": true
},
{
"name": "cleanBrokenTrustRelationship",
"summary": "This is an internal API used by Address Manager services.",
"description": "This is an internal API used by Address Manager services. It's not intended for users.",
"input": [
{
"name": "ipsToRemove",
"type": "array",
"info": ": array",
"required": false,
"schema": {
"title": "ipsToRemove",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cleanBrokenTrustRelationship"
},
"task": true
},
{
"name": "configureReplication",
"summary": "This API has been deprecated and is no longer supported.",
"description": "This API has been deprecated and is no longer supported.",
"input": [
{
"name": "compressReplication",
"type": "boolean",
"info": ": boolean",
"required": false,
"schema": {
"title": "compressReplication",
"type": "boolean"
}
},
{
"name": "properties",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
},
{
"name": "replicationBreakThreshold",
"type": "number",
"info": ": 123",
"required": false,
"schema": {
"title": "replicationBreakThreshold",
"type": "number"
}
},
{
"name": "replicationQueueThreshold",
"type": "number",
"info": ": 123",
"required": false,
"schema": {
"title": "replicationQueueThreshold",
"type": "number"
}
},
{
"name": "standbyServer",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "standbyServer",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/configureReplication"
},
"task": true
},
{
"name": "exchangeKeyBundles",
"summary": "This is an internal API used by Address Manager services.",
"description": "This is an internal API used by Address Manager services. It's not intended for users.",
"input": [
{
"name": "body",
"type": "array",
"info": ": array",
"required": false,
"schema": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"IP": {
"readOnly": false,
"description": "",
"type": "string"
},
"ip": {
"readOnly": false,
"description": "",
"type": "string"
},
"sshUser": {
"readOnly": false,
"description": "",
"type": "string"
},
"hostPublicKey": {
"readOnly": false,
"description": "",
"type": "string"
},
"hostPublicKeyGeneratedTimestamp": {
"readOnly": false,
"description": "",
"type": "number"
},
"userPublicKey": {
"readOnly": false,
"description": "",
"type": "string"
},
"userPublicKeyGeneratedTimestamp": {
"readOnly": false,
"description": "",
"type": "number"
}
},
"description": ""
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"IP": {
"readOnly": false,
"description": "",
"type": "string"
},
"ip": {
"readOnly": false,
"description": "",
"type": "string"
},
"sshUser": {
"readOnly": false,
"description": "",
"type": "string"
},
"hostPublicKey": {
"readOnly": false,
"description": "",
"type": "string"
},
"hostPublicKeyGeneratedTimestamp": {
"readOnly": false,
"description": "",
"type": "number"
},
"userPublicKey": {
"readOnly": false,
"description": "",
"type": "string"
},
"userPublicKeyGeneratedTimestamp": {
"readOnly": false,
"description": "",
"type": "number"
}
},
"description": ""
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/exchangeKeyBundles"
},
"task": true
},
{
"name": "moveIP4Object",
"summary": "This API has been deprecated and is no longer supported.",
"description": "This API has been deprecated and is no longer supported.",
"input": [
{
"name": "address",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "address",
"type": "string"
}
},
{
"name": "objectId",
"type": "number",
"info": ": 123",
"required": false,
"schema": {
"title": "objectId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/moveIP4Object"
},
"task": true
},
{
"name": "getProbeData",
"summary": "Returns the JSON response from the properties field of the APIData object.",
"description": "Returns the JSON response from the properties field of the APIData object.",
"input": [
{
"name": "definedProbe",
"type": "string",
"info": "Pre-defined SQL queries that will be triggered to collect data. The\navailable values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM .: string",
"required": false,
"schema": {
"title": "definedProbe",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"title": "APIData",
"properties": {
"name": {
"readOnly": false,
"description": "The name of the probe to collect data. Values are\nNETWORK_BLOOM or LEASE_COUNT_PER_DATE.",
"type": "string"
},
"properties": {
"readOnly": false,
"description": "A string containing extra properties for the object in\nthe format attribute: value.",
"type": "string"
}
},
"example": {
"name": "...",
"properties": "..."
},
"description": "API Data with a timestamp."
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getProbeData"
},
"task": true
},
{
"name": "getProbeStatus",
"summary": "Returns the status of the triggered data collection process.",
"description": "Returns the status of the triggered data collection process.",
"input": [
{
"name": "definedProbe",
"type": "string",
"info": "Pre-defined SQL queries that have been triggered to collect data. The\navailable values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM .: string",
"required": false,
"schema": {
"title": "definedProbe",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getProbeStatus"
},
"task": true
},
{
"name": "startProbe",
"summary": "Starts collecting data from the Address Manager database using pre-defined SQL\nqueries.",
"description": "Starts collecting data from the Address Manager database using pre-defined SQL\nqueries.",
"input": [
{
"name": "definedProbe",
"type": "string",
"info": "Pre-defined SQL queries that will be triggered to collect data. The\navailable values are LEASE_COUNT_PER_DATE and NETWORK_BLOOM .: string",
"required": false,
"schema": {
"title": "definedProbe",
"type": "string"
}
},
{
"name": "properties",
"type": "string",
"info": "Reserved for future use.: string",
"required": false,
"schema": {
"title": "properties",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/startProbe"
},
"task": true
},
{
"name": "isMigrationRunning",
"summary": "Returns true or false to indicate if the migration service is running.",
"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.",
"input": [
{
"name": "filename",
"type": "string",
"info": "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.: string",
"required": false,
"schema": {
"title": "filename",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isMigrationRunning"
},
"task": true
},
{
"name": "migrateFile",
"summary": "Migrates the specified XML file into Address Manager.",
"description": "Migrates the specified XML file into Address Manager. The file must\nreside in the /data/migration/incoming directory on the Address Manager\nserver.",
"input": [
{
"name": "filename",
"type": "string",
"info": "The filename of the XML file in the data/migration/incoming directory. Do\nnot include a path in the filename.: string",
"required": false,
"schema": {
"title": "filename",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/migrateFile"
},
"task": true
}
],
"views": []
}