@itentialopensource/adapter-bluecat
Version:
This adapter integrates with system described as: BlueCat ProteusAPI.
1,736 lines (1,735 loc) • 553 kB
JSON
{
"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\n<b>Configuration</b>. 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 <b>ttl=123|comments=my\ncomment|</b>. 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 <xref\nhref=\"../topic/top_bam_api_method_introduction.dita\"/>."
}
}
},
"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",