TCPWave

Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • How to Install
  • Testing
• Configuration
  • Example Properties
  • Connection Properties
  • Authentication Properties
  • Healthcheck Properties
  • Request Properties
  • SSL Properties
  • Throttle Properties
  • Proxy Properties
  • Mongo Properties
  • Device Broker Properties
• Using this Adapter
  • Generic Adapter Calls
  • Adapter Broker Calls
  • Specific Adapter Calls
  • Authentication
• Additional Information
  • Enhancements
  • Contributing
  • Helpful Links
  • Node Scripts
• Troubleshoot
  • Connectivity Issues
  • Functional Issues

Getting Started

These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:

Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter

Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder

Prerequisites

The following is a list of required packages for installation on the system the adapter will run on:

Node.js
npm
Git

The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.

Package	Description
@itentialopensource/adapter-utils	Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.
ajv	Required for validation of adapter properties to integrate with Tcpwave.
axios	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
commander	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
dns-lookup-promise	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
fs-extra	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
mocha	Testing library that is utilized by some of the node scripts that are included with the adapter.
mocha-param	Testing library that is utilized by some of the node scripts that are included with the adapter.
mongodb	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
nyc	Testing coverage library that is utilized by some of the node scripts that are included with the adapter.
ping	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
readline-sync	Utilized by the node script that comes with the adapter; helps to test unit and integration functionality.
semver	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
winston	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.

If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.

chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble

How to Install

1. Set up the name space location in your IAP node_modules.

cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource

2. Clone/unzip/tar the adapter into your IAP environment.

cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-tcpwave
or
unzip adapter-tcpwave.zip
or
tar -xvf adapter-tcpwave.tar

3. Run the adapter install script.

cd adapter-tcpwave
npm install
npm run lint:errors
npm run test

4. Restart IAP

systemctl restart pronghorn

5. Create an adapter service instance configuration in IAP Admin Essentials GUI

6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.

7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:

3. Install adapter dependencies and check the adapter.

cd adapter-tcpwave
npm run adapter:install

4. Restart IAP

systemctl restart pronghorn

5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

Testing

Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.

Unit Testing

Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.

node utils/testRunner --unit

npm run test:unit
npm run test:baseunit

To add new unit tests, edit the test/unit/adapterTestUnit.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing - Standalone

Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Tcpwave. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.

Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.

node utils/testRunner
  answer no at the first prompt

npm run test:integration

To add new integration tests, edit the test/integration/adapterTestIntegration.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing

Integration Testing requires connectivity to Tcpwave. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.

Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for creates and updates. Hence, integration tests may have to be enhanced before they will work (integrate) with Tcpwave. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Tcpwave which change order dependencies or required data.

node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials

Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.

Reminder: Do not check in code with actual credentials to systems.

Configuration

This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.

Example Properties

  "properties": {
    "host": "localhost",
    "port": 443,
    "choosepath": "",
    "base_path": "/api",
    "version": "v1.0.0",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": true,
    "protocol": "https",
    "authentication": {
      "auth_method": "no_authentication",
      "username": "username",
      "password": "password",
      "token": "",
      "token_timeout": -1,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Authorization",
      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "sensitive": [],
      "sso": {
        "protocol": "",
        "host": "",
        "port": 0
      },
      "multiStepAuthCalls": [
        {
          "name": "",
          "requestFields": {},
          "responseFields": {},
          "successfullResponseCode": 200
        }
      ]
    },
    "healthcheck": {
      "type": "none",
      "frequency": 60000,
      "query_object": {},
      "addlHeaders": {}
    },
    "throttle": {
      "throttle_enabled": false,
      "number_pronghorns": 1,
      "sync_async": "sync",
      "max_in_queue": 1000,
      "concurrent_max": 1,
      "expire_timeout": 0,
      "avg_runtime": 200,
      "priorities": [
        {
          "value": 0,
          "percent": 100
        }
      ]
    },
    "request": {
      "number_redirects": 0,
      "number_retries": 3,
      "limit_retry_error": 0,
      "failover_codes": [],
      "attempt_timeout": 5000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {}
      },
      "healthcheck_on_timeout": true,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": false,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{id}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "getDevicesFiltered": [
        {
          "path": "/get/devices",
          "method": "GET",
          "pagination": {
            "offsetVar": "",
            "limitVar": "",
            "incrementBy": "limit",
            "requestLocation": "query"
          },
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "isAlive": [
        {
          "path": "/get/devices/{id}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{id}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {}
        }
      ],
      "getCount": [
        {
          "path": "/get/devices",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {}
        }
      ]
    },
    "cache": {
      "enabled": false,
      "entities": [
        {
          "entityType": "",
          "frequency": 1440,
          "flushOnFail": false,
          "limit": 1000,
          "retryAttempts": 5,
          "sort": true,
          "populate": [
            {
              "path": "",
              "method": "GET",
              "pagination": {
                "offsetVar": "",
                "limitVar": "",
                "incrementBy": "limit",
                "requestLocation": "query"
              },
              "query": {},
              "body": {},
              "headers": {},
              "handleFailure": "ignore",
              "requestFields": {},
              "responseDatakey": "",
              "responseFields": {}
            }
          ],
          "cachedTasks": [
            {
              "name": "",
              "filterField": "",
              "filterLoc": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

These base properties are used to connect to Tcpwave upon the adapter initially coming up. It is important to set these properties appropriately.

Property	Description
host	Required. A fully qualified domain name or IP address.
port	Required. Used to connect to the server.
base_path	Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``.
version	Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.
cache_location	Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.
encode_pathvars	Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior.
encode_queryvars	Optional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior.
save_metric	Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.
stub	Optional. Indicates whether the stub should run instead of making calls to Tcpwave (very useful during basic testing). Default is false (which means connect to Tcpwave).
protocol	Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.

A connectivity check tells IAP the adapter has loaded successfully.

Authentication Properties

The following properties are used to define the authentication process to Tcpwave.

Note: Depending on the method that is used to authenticate with Tcpwave, you may not need to set all of the authentication properties.

Property	Description
auth_method	Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.
username	Used to authenticate with Tcpwave on every request or when pulling a token that will be used in subsequent requests.
password	Used to authenticate with Tcpwave on every request or when pulling a token that will be used in subsequent requests.
token	Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).
invalid_token_error	Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.
token_timeout	Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Tcpwave. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.
token_cache	Used to determine where the token should be stored (local memory or in Redis).
auth_field	Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.
auth_field_format	Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item.
auth_logging	Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true.
client_id	Provide a client id when needed, this is common on some types of OAuth.
client_secret	Provide a client secret when needed, this is common on some types of OAuth.
grant_type	Provide a grant type when needed, this is common on some types of OAuth.

Examples of authentication field format

"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"

Healthcheck Properties

The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Tcpwave. There are currently three types of healthchecks.

• None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Tcpwave.
• Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
• Intermittent - Adapter will check connectivity to Tcpwave at a frequency defined in the frequency property.

Property	Description
type	Required. The type of health check to run.
frequency	Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_object	Query parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

Property	Description
number_redirects	Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.
number_retries	Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.
limit_retry_error	Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].
failover_codes	An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.
attempt_timeout	Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Tcpwave, and then will re-attempt the request that aborted. Default is 5000 milliseconds.
global_request	Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.
global_request -> payload	Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body.
global_request -> uriOptions	Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.
global_request -> addlHeaders	Optioonal. Defines any headers that should be sent on all requests to the other system.
global_request -> authData	Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.
healthcheck_on_timeout	Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.
return_raw	Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.
archiving	Optional flag. Default is false. It archives the request, the results and the various times (wait time, Tcpwave time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.
return_request	Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.

SSL Properties

The SSL section defines the properties utilized for ssl authentication with Tcpwave. SSL can work two different ways: set the accept\_invalid\_certs flag to true (only recommended for lab environments), or provide a ca\_file.

Property	Description
enabled	If SSL is required, set to true.
accept_invalid_certs	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
ca_file	Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
key_file	Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
cert_file	Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.
secure_protocol	Defines the protocol (e.g., SSLv3_method) to use on the SSL request.
ciphers	Required if SSL enabled. Specifies a list of SSL ciphers to use.
ecdhCurve	During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9.

Throttle Properties

The throttle section is used when requests to Tcpwave must be queued (throttled). All of the properties in this section are optional.

Property	Description
throttle_enabled	Default is false. Defines if the adapter should use throttling or not.
number_pronghorns	Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.
sync-async	This property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queue	Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.
concurrent_max	Defines the number of requests the adapter can send to Tcpwave at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Tcpwave in a serial manner.
expire_timeout	Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).
average_runtime	Represents the approximate average of how long it takes Tcpwave to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Tcpwave performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
priorities	An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }

Proxy Properties

The proxy section defines the properties to utilize when Tcpwave is behind a proxy server.

Property	Description
enabled	Required. Default is false. If Tcpwave is behind a proxy server, set enabled flag to true.
host	Host information for the proxy server. Required if `enabled` is true.
port	Port information for the proxy server. Required if `enabled` is true.
protocol	The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.
username	If there is authentication for the proxy, provide the username here.
password	If there is authentication for the proxy, provide the password here.

Mongo Properties

The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.

Property	Description
host	Optional. Host information for the mongo server.
port	Optional. Port information for the mongo server.
database	Optional. The database for the adapter to use for its data.
username	Optional. If credentials are required to access mongo, this is the user to login as.
password	Optional. If credentials are required to access mongo, this is the password to login with.
replSet	Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.
db_ssl	Optional. Contains information for SSL connectivity to the database.
db_ssl -> enabled	If SSL is required, set to true.
db_ssl -> accept_invalid_cert	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
db_ssl -> ca_file	Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
db_ssl -> key_file	Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
db_ssl -> cert_file	Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.

Device Broker Properties

The device broker section defines the properties used integrate Tcpwave to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.

Property	Description
getDevice	The array of calls used to get device details for the broker
getDevicesFiltered	The array of calls used to get devices for the broker
isAlive	The array of calls used to get device status for the broker
getConfig	The array of calls used to get device configuration for the broker
getCount	The array of calls used to get device configuration for the broker
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path	The path, not including the base_path and version, for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method	The rest method for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query	Query object containing and query parameters and their values for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body	Body object containing the payload for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers	Header object containing the headers for this call.
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure	Tells the adapter whether to "fail" or "ignore" failures if they occur.
isAlive -> statusValue	Tells the adapter what value to look for in the status field to determine if the device is alive.
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields	Object containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value.
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFields	Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.

Using this Adapter

The adapter.js file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.

Generic Adapter Calls

These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.

Method Signature	Description	Workflow?
connect()	This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.	No
healthCheck(callback)	This call ensures that the adapter can communicate with TCPWave. The actual call that is used is defined in the adapter properties and .system entities action.json file.	No
refreshProperties(properties)	This call provides the adapter the ability to accept property changes without having to restart the adapter.	No
encryptProperty(property, technique, callback)	This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with TCPWave.	No
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)	This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.	Yes
iapFindAdapterPath(apiPath, callback)	This call provides the ability to see if a particular API path is supported by the adapter.	Yes
iapSuspendAdapter(mode, callback)	This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.	Yes
iapUnsuspendAdapter(callback)	This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.	Yes
iapGetAdapterQueue(callback)	This call will return the requests that are waiting in the queue if throttling is enabled.	Yes
iapTroubleshootAdapter(props, persistFlag, adapter, callback)	This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.	Yes
iapRunAdapterHealthcheck(adapter, callback)	This call will return the results of a healthcheck.	Yes
iapRunAdapterConnectivity(callback)	This call will return the results of a connectivity check.	Yes
iapRunAdapterBasicGet(callback)	This call will return the results of running basic get API calls.	Yes
iapMoveAdapterEntitiesToDB(callback)	This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.	Yes
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)	This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.	Yes
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)	This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.	Yes
iapHasAdapterEntity(entityType, entityId, callback)	This call verifies the adapter has the specific entity.	No
iapVerifyAdapterCapability(entityType, actionType, entityId, callback)	This call verifies the adapter can perform the provided action on the specific entity.	No
iapUpdateAdapterEntityCache()	This call will update the entity cache.	No

Adapter Broker Calls

These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.

Method Signature	Description	Workflow?
hasEntities(entityType, entityList, callback)	This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.	No
getDevice(deviceName, callback)	This call returns the details of the requested device.	Yes
getDevicesFiltered(options, callback)	This call returns the list of devices that match the criteria provided in the options filter.	Yes
isAlive(deviceName, callback)	This call returns whether the device status is active	Yes
getConfig(deviceName, format, callback)	This call returns the configuration for the selected device.	Yes
iapGetDeviceCount(callback)	This call returns the count of devices.	Yes

Specific Adapter Calls

Specific adapter calls are built based on the API of the TCPWave. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.

Method Signature	Description	Path	Workflow?
aclCreate(body, callback)	ACL Create	{base_path}/{version}/acls/create?{query}	Yes
aclUpdate(body, callback)	ACL Edit	{base_path}/{version}/acls/update?{query}	Yes
aclList(callback)	ACL List	{base_path}/{version}/acls/list?{query}	Yes
aclGet(name, callback)	ACL Details	{base_path}/{version}/acls/get?{query}	Yes
aclGetReferences(name, callback)	ACL References	{base_path}/{version}/acls/getreferences?{query}	Yes
aclMultiDelete(body, callback)	ACL Delete Multiple	{base_path}/{version}/acls/multidelete?{query}	Yes
aclPage(page, rows, callback)	Search ACL	{base_path}/{version}/acls/search?{query}	Yes
adUserAdd(body, callback)	Active Directory User Add	{base_path}/{version}/activedirectory/useradd?{query}	Yes
adUserList(callback)	Active Directory User list	{base_path}/{version}/activedirectory/userlist?{query}	Yes
adUserDelete(body, callback)	Active Directory User Delete	{base_path}/{version}/activedirectory/delete?{query}	Yes
adUserAuthenticate(body, callback)	Authenticate Active Directory User	{base_path}/{version}/activedirectory/authenticate?{query}	Yes
del(id, name, organizationId, organizationName, callback)	Admin Group Delete	{base_path}/{version}/admingroup/delete?{query}	Yes
edit(body, callback)	Admin Group Modify	{base_path}/{version}/admingroup/update?{query}	Yes
adminGroupPage(page, rows, callback)	Search Admin Group	{base_path}/{version}/admingroup/search?{query}	Yes
get(adminGroupId, adminGroupName, callback)	Admin Group Details	{base_path}/{version}/admingroup/get?{query}	Yes
list(orgId, orgName, callback)	Admin Group List	{base_path}/{version}/admingroup/list?{query}	Yes
create(body, callback)	Admin Group Add	{base_path}/{version}/admingroup/add?{query}	Yes
categoryList(callback)	Threshold Category List	{base_path}/{version}/alarmSubscription/categoryList?{query}	Yes
listCategoryMonitorService(category, callback)	List Monitoring Services	{base_path}/{version}/alarmSubscription/thresholdList?{query}	Yes
listComponents(serviceList, orgName, draw, start, length, filterRules, sort, order, callback)	List Alarm Subscription Components	{base_path}/{version}/alarmSubscription/componentList?{query}	Yes
addSubscriptions(body, callback)	Add Alarm Subscriptions	{base_path}/{version}/alarmSubscription/add?{query}	Yes
deleteSubscription(body, callback)	Delete Alarm Subscriptions	{base_path}/{version}/alarmSubscription/delete?{query}	Yes
getAlarmSubscriptionList(draw, start, length, filterRules, sort, order, callback)	Subscription List	{base_path}/{version}/alarmSubscription/list?{query}	Yes
tsigList(callback)	Algorithm TSIG List	{base_path}/{version}/algo/tsiglist?{query}	Yes
getAlgoList(callback)	Algorithm List	{base_path}/{version}/algo/list?{query}	Yes
postAppliancegroupEdit(body, callback)	Edit Appliance Group	{base_path}/{version}/appliancegroup/edit?{query}	Yes
getApplainceGroupReferences(name, organization, callback)	References of Appliance Group	{base_path}/{version}/appliancegroup/references?{query}	Yes
getApplianceGroup(name, organization, callback)	Details of Appliance Group	{base_path}/{version}/appliancegroup/get?{query}	Yes
deleteApplianceGroup(name, organization, callback)	Appliance Group Delete	{base_path}/{version}/appliancegroup/delete?{query}	Yes
listByOrg(organization, callback)	Appliance Group List	{base_path}/{version}/appliancegroup/listbyorg?{query}	Yes
applianceGroupSearchPage(draw, start, length, userId, filterRules, sort, order, callback)	Searches for appliance groups	{base_path}/{version}/appliancegroup/search?{query}	Yes
getAppliancegroupList(draw, start, length, filterRules, sort, order, callback)	List Appliance Group	{base_path}/{version}/appliancegroup/list?{query}	Yes
postAppliancegroupAdd(body, callback)	Add Appliance Group	{base_path}/{version}/appliancegroup/add?{query}	Yes
postAssetEdit(body, callback)	Update Asset	{base_path}/{version}/asset/edit?{query}	Yes
deleteAll(body, callback)	Delete Assets	{base_path}/{version}/asset/deleteAll?{query}	Yes
getAssetGet(serviceTag, callback)	Get Asset Details	{base_path}/{version}/asset/get?{query}	Yes
getAssetList(callback)	Asset List	{base_path}/{version}/asset/list?{query}	Yes
postAssetAdd(body, callback)	Add Asset	{base_path}/{version}/asset/add?{query}	Yes
getReportRecordsForGrid(fromDate, toDate, draw, start, length, filterRules, sort, order, callback)	Backup Audit	{base_path}/{version}/auditbackup/reportlistbydate?{query}	Yes
upload(body, callback)	Audit backup files Upload	{base_path}/{version}/auditbackup/upload?{query}	Yes
auditBackupList(callback)	Audit Backup files List	{base_path}/{version}/auditbackup/list?{query}	Yes
auditBackupListBySearch(searchVal, callback)	Audit Backup files List	{base_path}/{version}/auditbackup/listsearchbackupfiles?{query}	Yes
auditBackupFilesReportList(fileName, draw, start, length, filterRules, sort, order, callback)	Audit Backup Report by file name	{base_path}/{version}/auditbackup/reportlistbyfilename?{query}	Yes
getAuditreportsReportlist(reportType, fromDate, toDate, actionType, ipAddressDomainName, user, domain, sourceIp, recordType, changeTicket, orgId, proxy, draw, start, length, filterRules, action, sort, order, mac, organization, id, callback)	Admin Audit	{base_path}/{version}/auditreports/reportlist?{query}	Yes
sendReportByEmail(body, adminName, adminRole, action, callback)	Email Report	{base_path}/{version}/auditreports/emailreport?{query}	Yes
getAdminsList(actionType, callback)	Admin List	{base_path}/{version}/auditreports/adminslist?{query}	Yes
getAdminRolesList(callback)	Admin Role List	{base_path}/{version}/auditreports/adminroleslist?{query}	Yes
getActionsList(callback)	Action List	{base_path}/{version}/auditreports/actionslist?{query}	Yes
getAuditNetworksList(orgId, draw, start, length, actionType, filterRules, q, callback)	Zone List	{base_path}/{version}/auditreports/auditzoneslist?{query}	Yes
getAuditreportsAuditnetworkslist(draw, start, length, actionType, orgId, filterRules, q, callback)	IPV4 Network List	{base_path}/{version}/auditreports/auditnetworkslist?{query}	Yes
getIPv4NetworkList(callback)	IPv4 Network Mask Length	{base_path}/{version}/auditreports/ipv4Network?{query}	Yes
getIPv4SubnetList(callback)	IPv4 Subnet Subnets mask lengths	{base_path}/{version}/auditreports/ipv4Subnet?{query}	Yes
getOFACCountryGridList(callback)	ccTLDs Grid List	{base_path}/{version}/auditreports/ofaccountriesgridlist?{query}	Yes
getReportsReportlist(reportType, fromDate, toDate, actionType, ipAddressDomainName, orgId, organization, draw, start, length, filterRules, action, sort, serverIp, macAddress, hostName, order, callback)	Lists all Reports	{base_path}/{version}/reports/reportlist?{query}	Yes
getSubnetGroupList(draw, start, length, filterRules, q, callback)	Subnet Groups List	{base_path}/{version}/reports/listsubnetgroup?{query}	Yes
getReportsDhcpActiveLeases(reportType, fromDate, toDate, serverIp, page, rows, callback)	DHCP active leases audit report	{base_path}/{version}/reports/dhcpActiveLeases?{query}	Yes
postReportsCsvreport(body, callback)	CSV Report	{base_path}/{version}/reports/csvreport?{query}	Yes
getReportsServertozonecount(organizationName, callback)	DNS Server to zone count result	{base_path}/{version}/reports/servertozonecount?{query}	Yes
postReportsPdfreport(body, callback)	PDF Report	{base_path}/{version}/reports/pdfreport?{query}	Yes
postReportsEmailreport(body, callback)	Email Report	{base_path}/{version}/reports/emailreport?{query}	Yes
schedemailreport(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, adminName, adminRole, callback)	Schedule Report Email	{base_path}/{version}/reports/sched_emailreport?{query}	Yes
allParamsList(serverTypeCode, entityTypeCode, draw, start, length, filterRules, q, callback)	Parameter List	{base_path}/{version}/reports/allparams?{query}	Yes
generateScheduleCsvReport(body, callback)	CSV report for Scheduled Events	{base_path}/{version}/reports/schedulecsvreport?{query}	Yes
getReportRecordsForViwsGrid(reportType, fromDate, toDate, viewName, orgId, draw, start, length, q, filterRules, action, sort, order, callback)	Lists all Columns for DNS Views Report	{base_path}/{version}/reports/viewsgridlist?{query}	Yes
getReportRecordsForRPZLogs(reportType, serverIp, clientIp, draw, start, length, q, filterRules, action, sort, order, callback)	Lists all Columns for RPZ Logs Report	{base_path}/{version}/reports/rpzlogsgridlist?{query}	Yes
getDHCPServerSubnetReportRecordsForGrid(reportType, ipAddressDomainName, draw, start, length, q, filterRules, action, sort, order, callback)	DHCP Appliance Association audit report	{base_path}/{version}/reports/dhcpserversubnetreportlist?{query}	Yes
getDHCPTemplAssoReportRecordsForGrid(reportType, optionTempl, assoType, draw, start, length, q, filterRules, action, sort, order, callback)	DHCP Option Template Association Report	{base_path}/{version}/reports/dhcptemplassoreportgrid?{query}	Yes
getDhcpOptionConfigReportRecordsForGrid(reportType, configName, paramVal, draw, start, length, q, filterRules, action, sort, order, callback)	DHCP Option Template Report	{base_path}/{version}/reports/dhcpoptionconfigreportlist?{query}	Yes
getScheduleReportRecordsForGrid(reportType, fromDate, toDate, ipAddressDomainName, userId, jobId, draw, start, length, q, filterRules, action, sort, order, callback)	Schedule Events Audit Report	{base_path}/{version}/reports/schedulereportlist?{query}	Yes
getServerConfigReportRecordsForGrid(reportType, fromDate, toDate, ipAddressDomainName, serverType, draw, start, length, q, filterRules, action, sort, order, callback)	Appliance configuration audit report	{base_path}/{version}/reports/serverConfigreportlist?{query}	Yes
getDHSSOAReportForGrid(reportType, serverIp, serverName, serverType, page, rows, callback)	DNS SOA Report Grids	{base_path}/{version}/reports/dnssoareportgrid?{query}	Yes
getDhcpLeaseReportForCsv(reportType, serverIp, page, rows, callback)	DHCP active leases Audit Report	{base_path}/{version}/reports/dhcpLeaseCsvReport?{query}	Yes
getDnsSOARptForCsv(reportType, serverName, serverIp, serverType, page, rows, callback)	DNS SOA Report CSV	{base_path}/{version}/reports/dnssoareportcsv?{query}	Yes
getDnsServersList(actionType, callback)	DNS Servers List	{base_path}/{version}/reports/dnsserverslist?{query}	Yes
getDnsAppliancebyViewlist(actionType, organization, orgId, callback)	DNS AUTH Appliance	{base_path}/{version}/reports/dnsappliancebyviewlist?{query}	Yes
getDnsZonebyViewlist(actionType, organization, orgId, callback)	DNS Zone list	{base_path}/{version}/reports/dnszonebyviewlist?{query}	Yes
getDnsTemplateList(actionType, callback)	DNS Template List	{base_path}/{version}/reports/dnstemplatelist?{query}	Yes
getZoneTemplateList(actionType, callback)	Zone Template List	{base_path}/{version}/reports/zonetemplauditlist?{query}	Yes
getResourseRecordList(callback)	Owner List	{base_path}/{version}/reports/resourserecordauditlist?{query}	Yes
getDnsOptionTemplateList(actionType, callback)	DNS option template List	{base_path}/{version}/reports/dnsoptiontemplauditlist?{query}	Yes
getDnsDhcpServersList(callback)	DNS and DHCP Appliance List	{base_path}/{version}/reports/dnsdhcpserverslist?{query}	Yes
getDhcpServerList(actionType, callback)	DHCP Appliance List	{base_path}/{version}/reports/DhcpServerlist?{query}	Yes
getDhcpLeaseServerList(callback)	DHCP Active Server List	{base_path}/{version}/reports/DhcpLeaseServerlist?{query}	Yes
getDhcpServerSubnetList(actionType, callback)	DHCP Appliance Subnet List	{base_path}/{version}/reports/DhcpServerSubnetlist?{query}	Yes
getDhcpOptionTemplateList(draw, start, length, actionType, filterRules, q, callback)	DHCP Option Template List	{base_path}/{version}/reports/dhcpoptiontemplauditlist?{query}	Yes
getDhcpPolicyTemplateList(actionType, callback)	DHCP Policy Template List	{base_path}/{version}/reports/dhcppolicytemplauditlist?{query}	Yes
getDhcpTemplateAssoList(draw, start, length, filterRules, q, callback)	DHCP Option Template List	{base_path}/{version}/reports/dhcpoptiontemplassolist?{query}	Yes
getScheduleAdminAuditList(actionType, callback)	Administrator List	{base_path}/{version}/reports/scheduleadminauditlist?{query}	Yes
getserverConfigList(callback)	DNS Appliances List	{base_path}/{version}/reports/serverConfigReportlist?{query}	Yes
getmonitoringHostsList(callback)	Host List	{base_path}/{version}/reports/monitoringhostslist?{query}	Yes
getMonitoringServicesList(hostId, callback)	Monitoring Service List	{base_path}/{version}/reports/monitoringserviceslist?{query}	Yes
getObjectTypeList(callback)	Object Type List	{base_path}/{version}/reports/objecttypelist?{query}	Yes
getDNSViewsList(actionType, orgId, draw, start, length, filterRules, q, callback)	DNS Views List	{base_path}/{version}/reports/auditviewslist?{query}	Yes
getServerIpsList(callback)	DNS Cache Appliance List	{base_path}/{version}/reports/dnscacheserverslist?{query}	Yes
getClientIPsList(callback)	Object Type List	{base_path}/{version}/reports/clientserverslist?{query}	Yes
getLast100EventsList(reportType, fromDate, toDate, ipAddressDomainName, page, rows, q, filterRules, callback)	Last 100 Event List	{base_path}/{version}/reports/last100eventslist?{query}	Yes
getNTPOffsetList(reportType, serverType, callback)	NTP Offset List	{base_path}/{version}/reports/ntpoffsetlist?{query}	Yes
page(draw, start, length, filterRules, q, sort, order, success, loginName, sessionId, remoteIp, target, targetInstance, startDate, endDate, description, ipamIpAddress, callback)	Audit Log List	{base_path}/{version}/audit/page?{query}	Yes
searchAuditHistoryData(draw, start, length, filterRules, sort, order, callback)	Searches Change Tickets	{base_path}/{version}/audit/search?{query}	Yes
configUpdate(body, callback)	Update Audit Logging Configuration Information.	{base_path}/{version}/audit/configUpdate?{query}	Yes
getAuditConfig(callback)	Audit Logging Configuration	{base_path}/{version}/audit/auditLoggingConfigDetails?{query}	Yes
getAuditLicense(callback)	License Details	{base_path}/{version}/audit/license?{query}	Yes
update(body, callback)	Update License	{base_path}/{version}/audit/license/update?{query}	Yes
postAuthconfEdit(body, callback)	Edit Authentication	{base_path}/{version}/authconf/edit?{query}	Yes
getAuthconfGet(callback)	Get Authentication Configuration	{base_path}/{version}/authconf/get?{query}	Yes
deactivate(body, callback)	Session Token Deactivate	{base_path}/{version}/auth_token/deactivate?{query}	Yes
postAuthTokenGet(body, callback)	Get Auth Token	{base_path}/{version}/auth_token/get?{query}	Yes
getAuthTokenList(callback)	Session Token List	{base_path}/{version}/auth_token/list?{query}	Yes
setActive(code, callback)	Authentication Set Active	{base_path}/{version}/authtype/setactive?{query}	Yes
getActive(callback)	Active Authentication Configuration	{base_path}/{version}/authtype/getactive?{query}	Yes
getAuthtypeList(callback)	Authentication Configuration List	{base_path}/{version}/authtype/list?{query}	Yes
view(targetType, targetId, orgId, orgName, targetName, callback)	Permissions View	{base_path}/{version}/permission/view?{query}	Yes
createMultiple(orgId, orgName, body, callback)	Add permissions	{base_path}/{version}/permission/addmultiple?{query}	Yes
getPermissionList(targetType, targetId, orgId, orgName, targetName, callback)	Permissions List	{base_path}/{version}/permission/list?{query}	Yes
postPermissionAdd(orgId, orgName, body, callback)	Add permissions to an entity	{base_path}/{version}/permission/add?{query}	Yes
postBookmarkDelete(id, type, queryString, callback)	Delete bookmark	{base_path}/{version}/bookmark/delete?{query}	Yes
postBookmarkDeleteSection(type, callback)	Delete bookmark	{base_path}/{version}/bookmark/deleteSection?{query}	Yes
delAll(callback)	Delete bookmark	{base_path}/{version}/bookmark/deleteAll?{query}	Yes
getBookmarkList(user, callback)	Get Bookmark List	{base_path}/{version}/bookmark/list?{query}	Yes
postBookmarkAdd(body, callback)	Add bookmark	{base_path}/{version}/bookmark/add?{query}	Yes
getClogConfig(callback)	Central Logging Configuration	{base_path}/{version}/centralLogging/centralLoggingConfig?{query}	Yes
getClogFullConfig(callback)	Central Logging Configuration	{base_path}/{version}/centralLogging/centralLoggingFullConfig?{query}	Yes
getClogServerLogConfig(serverType, callback)	Central Logging Server Logs	{base_path}/{version}/centralLogging/centralLoggingServerLogConfig?{query}	Yes
fullConfigupdate(body, callback)	Update Central Logging Configuration Information.	{base_path}/{version}/centralLogging/fullConfigUpdate?{query}	Yes
changeServerClogSetting(serverType, address, clogOption, callback)	Server Central Logging Setting	{base_path}/{version}/centralLogging/serverCentralLoggingSetting?{query}	Yes
getAllCerts(callback)	certificate list	{base_path}/{version}/certmgmt/certlist?{query}	Yes
getNumberOfDays(callback)	Number of days Certificate is valid for	{base_path}/{version}/certmgmt/certValidDays?{query}	Yes
duplicateAliasCheck(body, callback)	Duplicate Alias check	{base_path}/{version}/certmgmt/duplicateAlias?{query}	Yes
certificateValidate(cfile, callback)	Certificate validation	{base_path}/{version}/certmgmt/certValidate?{query}	Yes
allcertValidDays(callback)	Get number of days all certificates are valid	{base_path}/{version}/certmgmt/allcertValidDays?{query}	Yes
certificateImport(body, callback)	Import Certificate	{base_path}/{version}/certmgmt/certImport?{query}	Yes
certificateDelete(body, callback)	Certificate Delete	{base_path}/{version}/certmgmt/certDelete?{query}	Yes
changeKeystorePassword(body, callback)	Change Keystore Password	{base_path}/{version}/certmgmt/changeKeystorePassword?{query}	Yes
jettyRestart(callback)	Web Server Restart	{base_path}/{version}/certmgmt/jettyRestart?{query}	Yes
getTop10Subnets(id, address, callback)	Network Statistics	{base_path}/{version}/chart/top10subnets?{query}	Yes
getTop10v6Subnets(id, orgName, address, callback)	Network Statistics	{base_path}/{version}/chart/top10v6subnets?{query}	Yes
getAllocPercent(id, address, callback)	Network Statistics	{base_path}/{version}/chart/allocationpercent?{query}	Yes
getv6AllocPercent(id, orgName, address, callback)	Network Statistics	{base_path}/{version}/chart/v6allocationpercent?{query}	Yes
getObjectAllocChart(id, callback)	Object Allocation	{base_path}/{version}/chart/objectAlloc?{query}	Yes
getObjectTypeChart(id, callback)	Object Type	{base_path}/{version}/chart/objectType?{query}	Yes
getv6ObjectAllocChart(id, callback)	Object Allocation	{base_path}/{version}/chart/v6objectAlloc?{query}	Yes
getv6ObjectTypeChart(id, callback)	Object Type	{base_path}/{version}/chart/v6objectType?{query}	Yes
listDNS(serverType, serverIp, serverId, callback)	IPAM/DNS/DHCP appliance's checkouts information	{base_path}/{version}/checkouts/list?{query}	Yes
runAndGetCheckouts(serverType, serverIp, serverName, callback)	Performs checkouts operation and retrieves the information	{base_path}/{version}/checkouts/runAndList?{query}	Yes
setBaseLine(serverType, serverIp, body, callback)	Set baseline values for the specified checkouts	{base_path}/{version}/checkouts/baseline?{query}	Yes
getIPAMList(callback)	List IPAM Appliances	{base_path}/{version}/checkouts/ipamlist?{query}	Yes
getClassCodeLogoList(callback)	Class Code Logo List	{base_path}/{version}/classCodeLogo/list?{query}	Yes
getClassCodeDetails(classcodename, callback)	Class Code Details	{base_path}/{version}/classcode/getClassCodeDetails?{query}	Yes
autoName(classCode, callback)	Object Name Auto generation	{base_path}/{version}/classcode/nextautohostname?{query}	Yes
postClasscodeUpdate(body, callback)	Object Type Update	{base_path}/{version}/classcode/update?{query}	Yes
getClasscodeList(dHCP, callback)	Object Type List	{base_path}/{version}/classcode/list?{query}	Yes
delete(body, callback)	Object Type Delete	{base_path}/{version}/classcode/delete?{query}	Yes
postClasscodeAdd(body, callback)	Object Type Add	{base_path}/{version}/classcode/add?{query}	Yes
createImage(cloudProviderId, cloudProviderName, id, name, desc, orgId, orgName, callback)	Create AWS Image	{base_path}/{version}/cloudCompute/createAWSImage?{query}	Yes
createInstance(body, callback)	Cloud instance create	{base_path}/{version}/cloudCompute/instance/create?{query}	Yes
listGoogleZones(orgName, providerName, callback)	Cloud Provider List	{base_path}/{version}/cloudCompute/listGoogleZones?{query}	Yes
listGoogleMachines(orgName, providerName, googleZone, callback)	Cloud Provider List	{base_path}/{version}/cloudCompute/listGoogleMachines?{query}	Yes
listGoogleOSImages(orgName, providerName, imageType, callback)	Cloud Provider List	{base_path}/{version}/cloudCompute/listGoogleOsImages?{query}	Yes
createInstanceTemplate(body, callback)	Cloud instance template add	{base_path}/{version}/cloudCompute/instanceTemplate/add?{query}	Yes
editInstanceTemplate(body, callback)	Cloud instance template update	{base_path}/{version}/cloudCompute/instanceTemplate/edit?{query}	Yes
listInstanceTemplates(providerType, cloudProviderId, callback)	Cloud instance template list	{base_path}/{version}/cloudCompute/instanceTemplate/list?{query}	Yes
deleteInstanceTemplates(body, callback)	Cloud instance template delete	{base_path}/{version}/cloudCompute/instanceTemplate/delete?{query}	Yes
getInstanceTemplate(templateId, templateName, orgId, orgName, callback)	Cloud instance template get	{base_path}/{version}/cloudCompute/instanceTemplate/get?{query}	Yes
changeState(objectID, objectAddress, orgName, action, callback)	Change cloud instance state	{base_path}/{version}/cloudCompute/instance/changeState?{query}	Yes
listAzureRegions(orgName, providerName, callback)	Azure Region List	{base_path}/{version}/cloudCompute/listAzureRegions?{query}	Yes
listAzureImagePublishers(orgName, providerName, azureRegion, callback)	Azure Virtual Image Publisher List	{base_path}/{version}/cloudCompute/listAzureImagePublishers?{query}	Yes
listAzureImageOffers(orgName, providerName, azureRegion, publisher, callback)	Azure Virtual Image Publisher's Offer List	{base_path}/{version}/cloudCompute/listAzureImageOffers?{query}	Yes
listAzureImageSKUs(orgName, providerName, azureRegion, publisher, offer, callback)	Azure Virtual Image Publisher Offer's SKU List	{base_path}/{version}/cloudCompute/listAzureImageSKUs?{query}	Yes
listAzureImageVersions(orgName, providerName, azureRegion, publisher, offer, sKU, callback)	Azure Virtual Image Version List	{base_path}/{version}/cloudCompute/listAzureImageVersions?{query}	Yes
listAzureVMSizes(orgName, providerName, azureRegion, callback)	Azure Virtual Machines Size List	{base_path}/{version}/cloudCompute/listAzureVMSizes?{query}	Yes
getCloudProviders(orgId, orgName, providerType, callback)	List Cloud Providers	{base_path}/{version}/cloudCompute/listCloudProviders?{query}	Yes
getVolumeTypes(callback)	List Volume Types	{base_path}/{version}/cloudCompute/listAWSVolumeTypes?{query}	Yes
getImages(orgId, orgName, cloudProviderId, cloudProviderName, callback)	List Amazon Machine Images	{base_path}/{version}/cloudCompute/listImages?{query}	Yes
getInstanceFamilies(callback)	List AWS Instance Families	{base_path}/{version}/cloudCompute/listInstanceFamilies?{query}	Yes
getInstanceTypes(instanceFamily, callback)	List Instance Types	{base_path}/{version}/cloudCompute/listInstanceTypes?{query}	Yes
getIAMRoles(cloudProviderId, cloudProvider, orgId, orgName, callback)	Get IAM Roles	{base_path}/{version}/cloudCompute/getIAMRoles?{query}	Yes
getSecurityGroups(cloudProviderId, cloudProvider, vpcIds, orgId, orgName, callback)	Get Security Groups	{base_path}/{version}/cloudCompute/getSecurityGroups?{query}	Yes
isReservedIP(ip, subnetAddress, cloudProviderId, cloudProvider, orgId, orgName, callback)	Get Cloud Instance Template	{base_path}/{version}/cloudCompute/instance/isReservedIP?{query}	Yes
getInstanceCreationError(objectId, callback)	Get Cloud Instance creation error	{base_path}/{version}/cloudCompute/instance/getCreationError?{query}	Yes
getInstanceTemplateId(objectId, objectAddress, orgName, callback)	Get Cloud Instance Template Id	{base_path}/{version}/cloudCompute/instance/getTemplateId?{query}	Yes
recreateInstance(objectAddress, orgName, callback)	Cloud instance recreate	{base_path}/{version}/cloudCompute/instance/recreate?{query}	Yes
checkCloudInstances(ipList, orgName, callback)	Check for Cloud Instances	{base_path}/{version}/cloudCompute/instance/checkInstances?{query}	Yes
terminateInstances(cloudProviderId, objectList, ipList, orgName, subnetAddress, callback)	Terminate Cloud Instances	{base_path}/{version}/cloudCompute/instance/terminate?{query}	Yes
getImagesPage(draw, start, length, filterRules, sort, order, callback)	List AWS Images	{base_path}/{version}/cloudCompute/awsImage/page?{query}	Yes
deleteImage(id, cloudProviderId, cloudProvider, orgName, callback)	Delete AWS Image	{base_path}/{version}/cloudCompute/deleteAWSImage?{query}	Yes
getInstance(objectId, objectAddress, orgName, callback)	Change cloud instance state	{base_path}/{version}/cloudCompute/instance/get?{query}	Yes
getState(objectID, objectAddress, orgName, callback)	Cloud instance create	{base_path}/{version}/cloudCompute/instance/getState?{query}	Yes
postClouddnsproviderEdit(oldname, body, callback)	Edit Cloud Provider	{base_path}/{version}/clouddnsprovider/edit?{query}	Yes
updateTemplate(type, name, orgId, orgName, body, callback)	Cloud Provider Templates Update	{base_path}/{version}/clouddnsprovider/update_template?{query}	Yes
removePermission(cpname, cpid, cptype, orgId, orgName, body, callback)	Dis-associate Cloud Provider	{base_path}/{version}/clouddnsprovider/disassociate?{query}	Yes
listProviderTemplates(provider, template, orgName, orgId, callback)	Cloud Provider Templates	{base_path}/{version}/clouddnsprovider/list_provider_templates?{query}	Yes
listProviderTypes(callback)	Cloud Provider Types	{base_path}/{version}/clouddnsprovider/list_provider_types?{query}	Yes
cloudPPage(draw, start, length, filterRules, sort, order, callback)	Cloud provider Search	{base_path}/{version}/clouddnsprovider/search?{query}	Yes
searchCloudPReferences(page, rows, tables, id, count, callback)	Lists cloud provider references	{base_path}/{version}/clouddnsprovider/references?{query}	Yes
getCloudProvider(providerID, providerName, orgID, orgName, callback)	Cloud Provider Details	{base_path}/{version}/clouddnsprovider/get?{query}	Yes
add(body, callback)	Add New Cloud Provider	{base_path}/{version}/clouddnsprovider/add?{query}	Yes
getClouddnsproviderList(orgId, orgName, callback)	Cloud Provider List	{base_path}/{version}/clouddnsprovider/list?{query}	Yes
postClouddnsproviderDelete(name, orgName, callback)	Delete Cloud Provider	{base_path}/{version}/clouddnsprovider/delete?{query}	Yes
listByPage(organizationName, draw, start, length, filterRules, q, sort, order, inEdit, callback)	Contact List	{base_path}/{version}/contact/paged?{query}	Yes
roleslist(roles, callback)	Contact List for selected User Roles	{base_path}/{version}/contact/roleslist?{query}	Yes
auditroleslist(roles, callback)	Contact List based on Roles	{base_path}/{version}/contact/auditroleslist?{query}	Yes
getdetails(id, callback)	Get Contact Information	{base_path}/{version}/contact/getdetails?{query}	Yes
contactPage(page, rows, callback)	Search Contacts	{base_path}/{version}/contact/search?{query}	Yes
postContactGet(body, callback)	Get Contact Information	{base_path}/{version}/contact/get?{query}	Yes
postContactUpdate(firstName, middleName, lastName, email, body, callback)	Contact Update	{base_path}/{version}/contact/update?{query}	Yes
getContactList(callback)	Contact List	{base_path}/{version}/contact/list?{query}	Yes
postContactDelete(body, callback)	Contact Delete	{base_path}/{version}/contact/delete?{query}	Yes
postContactAdd(body, callback)	Contact Add	{base_path}/{version}/contact/add?{query}	Yes
getServices(service, callback)	Service information	{base_path}/{version}/contingency/service/get?{query}	Yes
listServiceMode(callback)	Service Mode information	{base_path}/{version}/contingency/serviceMode/list?{query}	Yes
createServiceMode(body, callback)	Create Service Mode	{base_path}/{version}/contingency/serviceMode/add?{query}	Yes
getServiceMode(serviceMode, callback)	Get Service Mode Details	{base_path}/{version}/contingency/serviceMode/get?{query}	Yes
deleteServiceMode(body, callback)	Delete Service Mode	{base_path}/{version}/contingency/serviceMode/delete?{query}	Yes
updateServiceMode(body, callback)	Updated Service Mode	{base_path}/{version}/contingency/serviceMode/edit?{query}	Yes
listServices(callback)	List Services	{base_path}/{version}/contingency/service/list?{query}	Yes
createService(body, callback)	Create Service	{base_path}/{version}/contingency/service/add?{query}	Yes
deleteService(body, callback)	Delete Service	{base_path}/{version}/contingency/service/delete?{query}	Yes
updateService(body, callback)	Updated Service	{base_path}/{version}/contingency/service/edit?{query}	Yes
deleteSchedule(body, callback)	Deletes ServiceSchedule	{base_path}/{version}/contingency/service/schedule/delete?{query}	Yes
executeNow(body, callback)	Execute Scheduled Service	{base_path}/{version}/contingency/service/schedule/execute?{query}	Yes
getSchedulesForService(service, callback)	Service information	{base_path}/{version}/contingency/service/schedule/list?{query}	Yes
switchService(newMode, body, callback)	Switch Service Mode	{base_path}/{version}/contingency/service/switch?{query}	Yes
switchMultipleService(newMode, body, callback)	Switch Multiple Services Mode	{base_path}/{version}/contingency/service/switchMultiple?{query}	Yes
prepareSnapshot(callback)	Dump Database	{base_path}/{version}/db/dumpdb?{query}	Yes
applySnapshot(body, callback)	Apply Snapshot on Database	{base_path}/{version}/db/apply-snapshot?{query}	Yes
backupBinlog(callback)	Backup Binlog for Database	{base_path}/{version}/db/backup-binlog?{query}	Yes
applyBinlog(body, callback)	Apply Binlog for Database	{base_path}/{version}/db/apply-binlog?{query}	Yes
restoreDB(body, callback)	Restores Database	{base_path}/{version}/db/restoredb?{query}	Yes
deleteDBSnapshot(body, callback)	Delete Database Snapshot	{base_path}/{version}/db/deletedbsnapshot?{query}	Yes
listAwsS3File(callback)	Lists s3 backup files	{base_path}/{version}/db/lists3files?{query}	Yes
deleteAWSS3Files(body, callback)	Delete Backup Files	{base_path}/{version}/db/multideletes3files?{query}	Yes
downloadAWSS3File(body, callback)	Downloads AWS S3 File	{base_path}/{version}/db/downloadawss3file?{query}	Yes
restoreAWSS3File(body, callback)	Restore Database from an AWS S3 backup file	{base_path}/{version}/db/restoredbwithawss3?{query}	Yes
backupDbToAWSS3(callback)	Uploads Backup Database to AWS S3	{base_path}/{version}/db/backupdbtoaws?{query}	Yes
getActiveLeases(serverAddress, callback)	Get Active Leases	{base_path}/{version}/dhcpActiveLeases/getActiveLeases?{query}	Yes
createDHCPClass(body, callback)	Create DHCP Class	{base_path}/{version}/dhcpclass/add?{query}	Yes
updateDHCPClass(body, callback)	DHCP Class Edit	{base_path}/{version}/dhcpclass/edit?{query}	Yes
getDHCPClassSearchList(draw, start, length, filterRules, sort, order, callback)	DHCP Class Search	{base_path}/{version}/dhcpclass/search?{query}	Yes
getDHCPClassReferences(page, rows, tables, id, count, callback)	Find DHCP Class References	{base_path}/{version}/dhcpclass/references?{query}	Yes
getClass(entityType, name, callback)	DHCP Class List	{base_path}/{version}/dhcpclass/get?{query}	Yes
getDhcpclassList(entityType, callback)	DHCP Class List	{base_path}/{version}/dhcpclass/list?{query}	Yes
postDhcpclassDelete(id, name, entityType, callback)	DHCP Classes Delete	{base_path}/{version}/dhcpclass/delete?{query}	Yes
editdhcpOSF(body, callback)	DHCP option space update	{base_path}/{version}/dhcpOptionSpace/update?{query}	Yes
deleteDHCPServer(optionSpaceName, callback)	DHCP option space delete	{base_path}/{version}/dhcpOptionSpace/delete?{query}	Yes
listSubOptionParams(optionSpaceName, callback)	User Defined sub options list	{base_path}/{version}/dhcpOptionSpace/list-sub-options?{query}	Yes
listundefinedSubOptionParams(optionSpaceName, callback)	User Defined DHCP options list	{base_path}/{version}/dhcpOptionSpace/list-undefined-sub-options?{query}	Yes
getDhcpOptionSpaceList(callback)	Option Space List	{base_path}/{version}/dhcpOptionSpace/list?{query}	Yes
postDhcpOptionSpaceCreate(body, callback)	DHCP option space add	{base_path}/{version}/dhcpOptionSpace/create?{query}	Yes
postDhcpserverDelete(id, address, callback)	DHCP Appliance Delete	{base_path}/{version}/dhcpserver/delete?{query}	Yes
gen(address, organizationName, servername, callback)	Generate Server Configuration for sync	{base_path}/{version}/dhcpserver/generateConfig?{query}	Yes
postDhcpserverEdit(body, callback)	DHCP Appliance Update	{base_path}/{version}/dhcpserver/edit?{query}	Yes
getConfiguration(serverAddress, callback)	Server Configuration	{base_path}/{version}/dhcpserver/server-configuration/{pathv1}?{query}	Yes
primaryList(inEdit, orgName, serverType, callback)	Primary DHCP Appliance List	{base_path}/{version}/dhcpserver/primary-servers-list?{query}	Yes
getDHCPLeaseReportForGrid(serverIp, callback)	DHCP Appliances Active Leases	{base_path}/{version}/dhcpserver/dhcpActiveLeases?{query}	Yes
searchDHCPServerReferences(page, rows, tables, id, count, callback)	DHCP Appliance References	{base_path}/{version}/dhcpserver/references?{query}	Yes
listSvc(callback)	DHCP Appliance List	{base_path}/{version}/dhcpserver/list?{query}	Yes
getFailoverServerConfiguration(serverAddress, callback)	Failover Server Configuration	{base_path}/{version}/dhcpserver/failover-server-configuration/{pathv1}?{query}	Yes
synAll(body, organizationName, callback)	Generate Server Configuration for sync of all servers	{base_path}/{version}/dhcpserver/syncall?{query}	Yes
associatedSubnetList(address, callback)	Server Subnet References	{base_path}/{version}/dhcpserver/server-subnet-references?{query}	Yes
runDebugger(hardware, duration, server, callback)	DHCP Appliance Debugger	{base_path}/{version}/dhcpserver/debugger?{query}	Yes
serverIPCount(organizationName, callback)	DHCP Appliance IP Count	{base_path}/{version}/dhcpserver/serverIPCount?{query}	Yes
viewConfig(address, organizationName, callback)	View Configuration	{base_path}/{version}/dhcpserver/viewconfig?{query}	Yes
getSubSysResultForServer(serverName, serverIp, level, argc, callback)	Execute Command on DHCP Appliance	{base_path}/{version}/dhcpserver/subsys?{query}	Yes
getDNSServerHeartbeat(serverIp, serverType, callback)	DHCP Appliance Heartbeat	{base_path}/{version}/dhcpserver/heartbeat?{query}	Yes
postDhcpserverAdd(body, callback)	DHCP Appliance Create	{base_path}/{version}/dhcpserver/add?{query}	Yes
getRules(callback)	Get DNS Analytics Rules	{base_path}/{version}/dnsanalytics/getrules?{query}	Yes
getAnomalousDomains(callback)	Get Domains Reputation Data	{base_path}/{version}/dnsanalytics/getanomalousdomains?{query}	Yes
blockDomains(body, callback)	Block Domains	{base_path}/{version}/dnsanalytics/blockdomains?{query}	Yes
whitelistDomains(body, callback)	Whitelist Domains	{base_path}/{version}/dnsanalytics/whitelistdomains?{query}	Yes
deleteDomains(body, callback)	Delete anomalous Domains	{base_path}/{version}/dnsanalytics/deletedomains?{query}	Yes
updateRules(body, callback)	Update DNS Analytics Rules	{base_path}/{version}/dnsanalytics/updaterules?{query}	Yes
importDomains(body, callback)	Import Domains Reputation Data	{base_path}/{version}/dnsanalytics/importdomains?{query}	Yes
retrainTunnelDetectionModel(body, callback)	Retrain DNS Tunnel Detection ML Model	{base_path}/{version}/dnsanalytics/retraintunneldetectionmodel?{query}	Yes
deleteForwarders(categoryId, categoryName, callback)	Delete Forwarders Category	{base_path}/{version}/forwarders/dnsforwarders/delete?{query}	Yes
createDNSForwarders(body, callback)	Add Forwarders	{base_path}/{version}/forwarders/dnsforwarders/add?{query}	Yes
updateDNSForwarders(body, categoryId, callback)	Add Forwarders	{base_path}/{version}/forwarders/dnsforwarders/update?{query}	Yes
listDNSForwarders(categoryId, callback)	Forwarders List	{base_path}/{version}/forwarders/dnsforwarders/list?{query}	Yes
listDNSForwardersCategory(callback)	Forwarders List	{base_path}/{version}/forwarders/dnsforwarders/majorlist?{query}	Yes
listDNSServersAssociateForForwarders(categoryId, callback)	Forwarders List	{base_path}/{version}/forwarders/dnsforwarders/associateForwarders?{query}	Yes
dnsForwardersSearch(draw, start, length, filterRules, sort, order, callback)	DNS Forwarders Search	{base_path}/{version}/forwarders/dnsforwarders/search?{query}	Yes
searchDNSForwarderReferences(page, rows, tables, id, count, callback)	Find DNS forwarder References	{base_path}/{version}/forwarders/dnsforwarders/references?{query}	Yes
postDnsserverDelete(id, address, callback)	DNS Appliance Delete	{base_path}/{version}/dnsserver/delete?{query}	Yes
getServer(serverTypeCode, serverIp, callback)	DNS Appliance Details	{base_path}/{version}/dnsserver/get?{query}	Yes
postDnsserverEdit(body, callback)	DNS Appliance Edit	{base_path}/{version}/dnsserver/edit?{query}	Yes
getDnsserverServerConfigurationServerAddressServerType(serverAddress, serverType, callback)	Appliance Configuration	{base_path}/{version}/dnsserver/server-configuration/{pathv1}/{pathv2}?{query}	Yes
serverPage(page, rows, callback)	Appliance Search	{base_path}/{version}/dnsserver/search?{query}	Yes
zoneList(id, name, revZone, callback)	DNS Appliance Zone List	{base_path}/{version}/dnsserver/zonelist?{query}	Yes
searchDNSServerReferences(page, rows, tables, id, count, callback)	Appliance References In Zones	{base_path}/{version}/dnsserver/references?{query}	Yes
cacheApplianceList(orgName, callback)	DNS Cache Appliance List	{base_path}/{version}/dnsserver/internal_cache_list?{query}	Yes
serverPagelist(draw, start, length, q, filterRules, sort, order, callback)	DNS Appliance List	{base_path}/{version}/dnsserver/page?{query}	Yes
createSvc(body, callback)	Add DNS Appliance	{base_path}/{version}/dnsserver/add?{query}	Yes
checkIfAssociatedWithProxyRootZone(serverIp, orgName, oldServerType, newServerType, callback)	Check if DNS Appliance is associated	{base_path}/{version}/dnsserver/check_if_server_is_associated?{query}	Yes
generateConfig(serverTypeCode, address, organizationName, callback)	Generate Configuration	{base_path}/{version}/dnsserver/genconfig?{query}	Yes
getDnsserverViewconfig(serverTypeCode, address, organizationName, callback)	View Configuration of DNS Appliance	{base_path}/{version}/dnsserver/viewconfig?{query}	Yes
getDigResultForServerSvc(serverName, serverIp, serverType, recordFqdn, recordType, callback)	Appliance Dig	{base_path}/{version}/dnsserver/digserver?{query}	Yes
getDnsserverSubsys(serverName, serverIp, level, argc, argv, callback)	Appliance Command	{base_path}/{version}/dnsserver/subsys?{query}	Yes
getDnsserverHeartbeat(serverIp, serverType, callback)	Appliance Heartbeat Check	{base_path}/{version}/dnsserver/heartbeat?{query}	Yes
serverRefList(id, address, callback)	Appliance References in Zone Template	{base_path}/{version}/dnsserver/server-references?{query}	Yes
listForwarders(id, address, callback)	Forwarders List	{base_path}/{version}/dnsserver/forwarders/list?{query}	Yes
createForwarders(body, callback)	Add Forwarders	{base_path}/{version}/dnsserver/forwarders/add?{query}	Yes
updateForwarders(body, callback)	Update Forwarders	{base_path}/{version}/dnsserver/forwarders/update?{query}	Yes
postDnsserverForwardersDelete(body, callback)	Delete Forwarders	{base_path}/{version}/dnsserver/forwarders/delete?{query}	Yes
dnsFlush(body, callback)	Flush operation on appliance	{base_path}/{version}/dnsserver/dnsflush?{query}	Yes
getDnstapLogs(ip, name, type, callback)	Dnstap Logs	{base_path}/{version}/dnsserver/getDnstapLogs?{query}	Yes
getDnsserverList(callback)	DNS Appliance List	{base_path}/{version}/dnsserver/list?{query}	Yes
syncAll(body, fasterSync, callback)	Synchronize DNS Appliances	{base_path}/{version}/dnsserver/syncAll?{query}	Yes
postDnsserverTemplateEdit(body, callback)	DNS Appliance Template Edit	{base_path}/{version}/dnsserver_template/edit?{query}	Yes
searchDomainReferences(page, rows, tables, id, count, callback)	Appliance Template References	{base_path}/{version}/dnsserver_template/references?{query}	Yes
dnsSrvrTemplatePage(page, rows, callback)	Appliance Template Search	{base_path}/{version}/dnsserver_template/search?{query}	Yes
getDnsserverTemplateGet(id, name, callback)	DNS Appliance Template Details	{base_path}/{version}/dnsserver_template/get?{query}	Yes
getDnsserverTemplateList(serverTypeId, serverTypeCode, callback)	DNS Appliance Template List	{base_path}/{version}/dnsserver_template/list?{query}	Yes
postDnsserverTemplateAdd(body, callback)	DNS Appliance Template Add	{base_path}/{version}/dnsserver_template/add?{query}	Yes
traverse(body, callback)	Resource Record Traverse	{base_path}/{version}/dnstools/traverseRR?{query}	Yes
converge(body, callback)	Resource Record Converge	{base_path}/{version}/dnstools/converge?{query}	Yes
flushCacheOnServer(serverip, servertype, recordname, recordtype, domainname, callback)	Resource Record Sync	{base_path}/{version}/dnstools/sync?{query}	Yes
idnConverter(body, callback)	IDN Converter	{base_path}/{version}/dnstools/idnconverter?{query}	Yes
getZoneDNSSECDelegationHTML(zoneName, orgName, cacheApplianceIp, callback)	DNSViz as HTML	{base_path}/{version}/dnsviz/getDNSVizHTML?{query}	Yes
getZoneDNSSECDelegationPNG(zoneName, orgName, cacheApplianceIp, callback)	DNSViz as PNG	{base_path}/{version}/dnsviz/getDNSVizPNG?{query}	Yes
setAcceptStatus(body, isExternalUser, callback)	Set Accept Status of Discovery Command	{base_path}/{version}/discovery/setacceptstatus?{query}	Yes
acceptElements(body, isExternalUser, callback)	Accept Discovered Elements	{base_path}/{version}/discovery/acceptelements?{query}	Yes
setDiscardStatus(body, callback)	Set Discard Status of Discovery Command	{base_path}/{version}/discovery/setdiscardstatus?{query}	Yes
getdiscoveredsubnetelements(cmdId, callback)	Discover Subnet Element List	{base_path}/{version}/discovery/getdiscoveredsubnetelements?{query}	Yes
getsubnetelements(body, callback)	Discover Subnet Element List	{base_path}/{version}/discovery/getsubnetelements?{query}	Yes
getswitchelements(body, callback)	Discover Subnet Element List	{base_path}/{version}/discovery/getswitchelements?{query}	Yes
discoverSubnet(body, callback)	Discover Subnet	{base_path}/{version}/discovery/discover_subnet?{query}	Yes
discoverMultipleSubnets(body, callback)	Discover Subnets	{base_path}/{version}/discovery/discover_multiple_subnets?{query}	Yes
discoverElement(body, callback)	Discover IP Information	{base_path}/{version}/discovery/discover_element?{query}	Yes
discoverRouterSubnets(body, callback)	Discover Subnet of Router	{base_path}/{version}/discovery/discover_router_subnets?{query}	Yes
handleObjectDiscoveryUpdate(body, callback)	Object Discovery Update	{base_path}/{version}/discovery/handle_object_discovery_update?{query}	Yes
handleSubnetDiscoveryUpdate(body, callback)	Subnet Discovery Update	{base_path}/{version}/discovery/handle_subnet_discovery_update?{query}	Yes
discoverSwitch(body, callback)	Discover Subnet	{base_path}/{version}/discovery/discover_switch?{query}	Yes
updateObjectDiscoveryData(body, callback)	Updates Object discovery data	{base_path}/{version}/discovery/updateObjectDiscoveryData?{query}	Yes
discoverReclaimSubnets(body, callback)	Discover Subnets	{base_path}/{version}/discovery/discover_reclaimable_subnets?{query}	Yes
getDiscoveryGetcmds(status, callback)	Discovery Commands List	{base_path}/{version}/discovery/getcmds?{query}	Yes
details(name, orgName, callback)	Get discovery template details	{base_path}/{version}/discovery_template/details?{query}	Yes
getDiscoveryDetails(address, type, orgName, callback)	Get discovery template details by network or subnet address	{base_path}/{version}/discovery_template/getdiscoverypreferences?{query}	Yes
getTemplateReferences(templateName, organizationName, organizationId, callback)	Discovery Template References	{base_path}/{version}/discovery_template/getreferences?{query}	Yes
getDomainList(orgId, draw, start, length, orgName, q, filterRules, sort, order, callback)	Discovery Template List by Organization	{base_path}/{version}/discovery_template/p_listbyorg?{query}	Yes
deleteDiscoveryReferences(body, callback)	Discovery Template References	{base_path}/{version}/discovery_template/deletereferences?{query}	Yes
postDiscoveryTemplateEdit(body, callback)	Update Discovery Template	{base_path}/{version}/discovery_template/edit?{query}	Yes
getDiscoveryTemplateList(callback)	Discovery Template List	{base_path}/{version}/discovery_template/list?{query}	Yes
postDiscoveryTemplateDelete(name, orgName, callback)	Delete Discovery Template	{base_path}/{version}/discovery_template/delete?{query}	Yes
postDiscoveryTemplateAdd(body, callback)	Add Discovery Template	{base_path}/{version}/discovery_template/add?{query}	Yes
hierarchy(callback)	Domain List	{base_path}/{version}/domain/hierarchy?{query}	Yes
multiDelete(body, callback)	Domain Multidelete	{base_path}/{version}/domain/multidelete?{query}	Yes
getDomainPListbyorg(orgId, draw, start, length, orgName, q, inSubnetEdit, filterRules, sort, order, callback)	Domain List By Organization	{base_path}/{version}/domain/p_listbyorg?{query}	Yes
domainList(orgId, page, rows, orgName, q, inSubnetEdit, callback)	Domain List By Organization	{base_path}/{version}/domain/listbyorg?{query}	Yes
getDomainList2(callback)	Domain List	{base_path}/{version}/domain/list?{query}	Yes
domainPage(page, rows, callback)	Domain Search	{base_path}/{version}/domain/search?{query}	Yes
domainCreate(body, callback)	Domain Add	{base_path}/{version}/domain/add?{query}	Yes
domainUpdate(body, callback)	Domain Update	{base_path}/{version}/domain/update?{query}	Yes
getReverseZoneList(orgId, draw, start, length, orgName, q, inSubnetEdit, filterRules, sort, order, callback)	Reverse Zone List By Organization	{base_path}/{version}/domain/p_revzonelistbyorg?{query}	Yes
getADZoneList(orgId, draw, start, length, orgName, zoneName, q, inSubnetEdit, filterRules, sort, order, callback)	Domain List By Organization	{base_path}/{version}/domain/adzonelistbyorg?{query}	Yes
getDomainGet(id, name, orgName, callback)	Domain Details	{base_path}/{version}/domain/get?{query}	Yes
getValuesByID(tableName, fieldValue, callback)	getValuesByID	{base_path}/{version}/dropdown/selectValueByID?{query}	Yes
postExportComplianceMgmtMultidelete(body, callback)	ccTLD Multidelete	{base_path}/{version}/exportComplianceMgmt/multidelete?{query}	Yes
getExportComplianceMgmtOfaccountriesgridlist(callback)	OFAC Country name and ccTLDs List	{base_path}/{version}/exportComplianceMgmt/ofaccountriesgridlist?{query}	Yes
ccTLDAdd(body, callback)	Domain Add	{base_path}/{version}/exportComplianceMgmt/add?{query}	Yes
listSupportedTypes(callback)	Supported Export Types	{base_path}/{version}/export/supported_types?{query}	Yes
execute(type, organization, body, callback)	Export	{base_path}/{version}/export/{pathv1}?{query}	Yes
postFilesetEdit(body, callback)	Edit FileSet	{base_path}/{version}/fileset/edit?{query}	Yes
deleteFolder(orgName, filesetName, callback)	Delete Folder	{base_path}/{version}/fileset/deletefolder?{query}	Yes
deleteFileSet(name, organization, callback)	Delete File Set	{base_path}/{version}/fileset/delete?{query}	Yes
getFileSet(name, organization, callback)	Details of FileSet	{base_path}/{version}/fileset/get?{query}	Yes
getFilesetPrimaryServersList(orgName, callback)	Primary DHCP Appliance List	{base_path}/{version}/fileset/primary-servers-list?{query}	Yes
getFilesetList(draw, start, length, filterRules, sort, order, callback)	Get File Set List	{base_path}/{version}/fileset/list?{query}	Yes
getFilesetProtocols(callback)	Protocols List	{base_path}/{version}/fileset/protocols?{query}	Yes
postFilesetAdd(body, callback)	Create FileSet	{base_path}/{version}/fileset/add?{query}	Yes
sync(body, callback)	FileSet Sync Operation	{base_path}/{version}/fileset/sync?{query}	Yes
u(twcChunkNumber, twcChunkSize, twcCurrentChunkSize, twcTotalSize, twcType, twcFilename, twcRelativePath, twcIdentifier, twcTotalChunks, callback)	Large file upload in chunks	{base_path}/{version}/files/largeFileUpload?{query}	Yes
uploadFile(fileName, body, callback)	Upload File	{base_path}/{version}/files/upload/{pathv1}?{query}	Yes
uploadBinaryFile(fileName, body, callback)	Binary Upload	{base_path}/{version}/files/binaryupload/{pathv1}?{query}	Yes
modify(body, callback)	Firewall Template Edit	{base_path}/{version}/firewall/template/modify?{query}	Yes
listAssoc(address, templateName, orgName, callback)	Firewall Template List associated with the DNS Appliances	{base_path}/{version}/firewall/template/assoc/list?{query}	Yes
updateAssoc(address, templateName, callback)	Modify Firewall Template	{base_path}/{version}/firewall/template/assoc/update?{query}	Yes
getTemplate(name, orgName, forSelect, callback)	Firewall Template List	{base_path}/{version}/firewall/template/get?{query}	Yes
postFirewallTemplateAdd(body, callback)	Add Firewall Template	{base_path}/{version}/firewall/template/add?{query}	Yes
getFirewallTemplateList(orgName, forSelect, callback)	Firewall Template List	{base_path}/{version}/firewall/template/list?{query}	Yes
postFirewallTemplateDelete(name, callback)	Firewall Template Delete	{base_path}/{version}/firewall/template/delete?{query}	Yes
getGlobalOptionValue(optionName, callback)	Get Global Option	{base_path}/{version}/globals/getGlobalOption?{query}	Yes
postGlobalsUpdate(body, callback)	Update Global Policies	{base_path}/{version}/globals/update?{query}	Yes
getGlobalsList(callback)	Global Policies List	{base_path}/{version}/globals/list?{query}	Yes
getMessagesAfter(serverIp, startDate, endDate, callback)	Server Heartbeat	{base_path}/{version}/heartbeat/getHeartbeat?{query}	Yes
getHeartbeatMessages(ip, name, startDate, endDate, callback)	Heartbeat Messages from Server	{base_path}/{version}/heartbeat/messages?{query}	Yes
listAddressBlocks(callback)	List of Address Blocks	{base_path}/{version}/hierarchy/address_block/list?{query}	Yes
listAddressSpace(callback)	List of Address Space	{base_path}/{version}/hierarchy/address_space/list?{query}	Yes
getBlockNetworkList(organization, space, address, mask, callback)	Address Block Network List	{base_path}/{version}/hierarchy/address_block/network/list?{query}	Yes
listNetworks(orgName, space, address, callback)	List of Networks at the given node	{base_path}/{version}/hierarchy/network/list?{query}	Yes
addAddressSpace(body, callback)	Add Address Space	{base_path}/{version}/hierarchy/address_space/add?{query}	Yes
updateAddressSpace(name, body, callback)	Update Address Space	{base_path}/{version}/hierarchy/address_space/update?{query}	Yes
deleteAddressSpace(body, callback)	Delete Address Space	{base_path}/{version}/hierarchy/address_space/delete?{query}	Yes
deleteAddressBlock(orgName, preserveChild, body, callback)	Delete Address Block	{base_path}/{version}/hierarchy/address_block/delete?{query}	Yes
addSeedBlock(orgName, body, callback)	Add Address Space	{base_path}/{version}/hierarchy/seed_block/add?{query}	Yes
updateChildBlock(orgName, adjustHierarchy, space, body, callback)	Update Child Block	{base_path}/{version}/hierarchy/child_block/update?{query}	Yes
updateSeedBlock(orgName, adjustHierarchy, space, body, callback)	Update Seed Block	{base_path}/{version}/hierarchy/seed_block/update?{query}	Yes
addChildBlock(orgName, adjustHierarchy, body, callback)	Add Child Block	{base_path}/{version}/hierarchy/child_block/add?{query}	Yes
splitSeedBlock(orgName, mask, body, callback)	Split Seed Block	{base_path}/{version}/hierarchy/seed_block/split?{query}	Yes
nextFreeNetworkList(orgName, mask, body, callback)	List of Address Blocks	{base_path}/{version}/hierarchy/next_free/networklist?{query}	Yes
nextFreeNetwork(orgName, mask, body, callback)	List of Address Blocks	{base_path}/{version}/hierarchy/next_free/network?{query}	Yes
nextFreeBlockList(orgName, mask, body, callback)	List of Address Blocks	{base_path}/{version}/hierarchy/next_free/blocklist?{query}	Yes
nextFreeBlock(orgName, mask, body, callback)	Address Block	{base_path}/{version}/hierarchy/next_free/block?{query}	Yes
addNextFreeBlock(orgName, mask, name, body, callback)	Address Block	{base_path}/{version}/hierarchy/next_free/block/add?{query}	Yes
addMultipleChildBlocks(orgName, adjustHierarchy, body, callback)	Add Multiple Child Blocks	{base_path}/{version}/hierarchy/child_block/add_multi?{query}	Yes
mapWave(callback)	Map of Network Hierarchy	{base_path}/{version}/hierarchy/map?{query}	Yes
getHistoryListAsJsonString(draw, start, length, filterRules, sort, order, type, organization, id, callback)	List of Execution History	{base_path}/{version}/historytab/historylist?{query}	Yes
getHomeObjectAlloc(organizationName, callback)	Object Allocation	{base_path}/{version}/home/objectAlloc?{query}	Yes
getHomeObjectType(organizationName, callback)	Object Type	{base_path}/{version}/home/objectType?{query}	Yes
getDNSServerList(callback)	DNS Server List	{base_path}/{version}/home/getDNSServerList?{query}	Yes
getTopTenWidgetDataSvc(body, callback)	Full/Underutilized Networks and Subnets	{base_path}/{version}/home/top10WidgetData?{query}	Yes
getTopTenV6WidgetDataSvc(body, callback)	Full/Underutilized Networks and Subnets	{base_path}/{version}/home/top10v6WidgetData?{query}	Yes
getAdminRolesChart(organizationName, callback)	Admin roles information	{base_path}/{version}/home/adminRoles?{query}	Yes
getIPAMSearchDetails(search, name, callback)	Get IPAM Search Details	{base_path}/{version}/home/getIPAMSearchDetails?{query}	Yes
getNetworkDetails(ipAddress, callback)	Get network details by IPAddress	{base_path}/{version}/home/getNetworkDetails/{pathv1}?{query}	Yes
getSubnetDetails(ipAddress, callback)	Subnet details by IP Address	{base_path}/{version}/home/getSubnetDetails/{pathv1}?{query}	Yes
getObjectDetails(ipAddress, subnetId, callback)	Get object details by IP Address/Subnet ID	{base_path}/{version}/home/getObjectDetails?{query}	Yes
determineIPDetail(ipAddress, callback)	Get the details of an IP Address	{base_path}/{version}/home/determineIPDetails/{pathv1}?{query}	Yes
getObbjectLineChartData(startDate, endDate, range, organizationName, callback)	Get Object Line Chart Data	{base_path}/{version}/home/getTotalObjectData?{query}	Yes
getTotalIPAMStats(organizationName, callback)	Get the IPAM statistics	{base_path}/{version}/home/getTotalIPAMStats?{query}	Yes
getIPAMServerInfo(callback)	Get the IPAM server information	{base_path}/{version}/home/getIPAMServerInfo?{query}	Yes
faultMgmt(serverName, ip, faultLevel, serverType, draw, start, length, filterRules, q, sort, order, callback)	Get the notifications of appliances status by service name	{base_path}/{version}/home/faultMgmt?{query}	Yes
getCurrentAlarms(serverName, ip, faultLevel, serverType, draw, start, length, filterRules, q, sort, order, callback)	Get the notifications of appliances status by service name	{base_path}/{version}/home/getCurrentAlarms?{query}	Yes
faultMgmtp(draw, start, length, filterRules, q, sort, order, serverName, ip, faultLevel, serverType, callback)	Get the notifications of appliances status by service name	{base_path}/{version}/home/faultMgmtp?{query}	Yes
faultMgmtHosts(serverName, ip, faultLevel, serverType, callback)	Get the notifications of appliances status by host name	{base_path}/{version}/home/faultMgmtHosts?{query}	Yes
getMonitoringCounts(serverName, ip, callback)	Get the monitoring status	{base_path}/{version}/home/monitoringServices?{query}	Yes
getApplianceStatus(serverName, ip, callback)	Get all appliances status	{base_path}/{version}/home/applianceStatus?{query}	Yes
getHealthIndices(callback)	Get values for health index scores	{base_path}/{version}/home/healthindices?{query}	Yes
getTotalTraffic(callback)	Get Total DNS traffic	{base_path}/{version}/home/getTotalTaffic?{query}	Yes
getDHCPTraffic(callback)	Get Total DHCP traffic	{base_path}/{version}/home/getDHCPTraffic?{query}	Yes
getCMDStats(callback)	Get CPU,Memory,Disk Usage	{base_path}/{version}/home/getCMDStats?{query}	Yes
getIPAMSystemInfo(callback)	Get CPU, Memory, Disk Usage and other information.	{base_path}/{version}/home/getIPAMSystemInfo?{query}	Yes
getDHCPTrafficByServer(callback)	Get Total DNS traffic	{base_path}/{version}/home/getDHCPTafficByServer?{query}	Yes
getTotalTrafficByServer(callback)	Get Total DNS traffic	{base_path}/{version}/home/getTotalTafficByServer?{query}	Yes
faultMgmtServiceHistory(serverName, id, faultLevel, startDate, endDate, pageNo, pageSize, selectdb, callback)	Get Fault Management Service History	{base_path}/{version}/home/faultMgmtServiceHistory?{query}	Yes
getServerHardwareInfo(serverId, serverType, callback)	Get server hardware information	{base_path}/{version}/home/getServerHardwareInfo?{query}	Yes
getUserLastLogin(userName, userId, callback)	Get user last login information	{base_path}/{version}/home/getUserLastLogin?{query}	Yes
getHtmlLoads(cpuCheck, memCheck, diskCheck, callback)	Get the appliance load ,memory and disk charts data	{base_path}/{version}/home/getRRdImageLoad?{query}	Yes
getMYSQLData(address, callback)	Get MySQL charts data	{base_path}/{version}/home/getMYSQLCharts?{query}	Yes
getDNSHtmlLoads(service, callback)	Get chart data	{base_path}/{version}/home/getRRDDNSLoad?{query}	Yes
getdhcpGroupedChart(service, callback)	Get chart data	{base_path}/{version}/home/getdhcpgroupedcharts?{query}	Yes
getMonitorRRD(ip, type, callback)	Get Information of all Appliances	{base_path}/{version}/home/getMonitoringRRDCharts?{query}	Yes
getDNSDHCPServerList(callback)	list of DNS and DHCP Appliances	{base_path}/{version}/home/getDNSDHCPServerList?{query}	Yes
getIpamAlerts(draw, start, length, filterRules, q, sort, order, startDate, endDate, callback)	Get IPAM server alerts	{base_path}/{version}/home/getIpamAlerts?{query}	Yes
getIpamAlertsSummary(callback)	Get IPAM server alerts Summary	{base_path}/{version}/home/getIpamAlertsSummary?{query}	Yes
getActiveSessions(page, rows, startDate, endDate, callback)	Get active sessions information	{base_path}/{version}/home/getActiveSessions?{query}	Yes
getActiveSessionsSummary(page, rows, callback)	Active Sessions Summary	{base_path}/{version}/home/getActiveSessionsSummary?{query}	Yes
getActiveSessionsSnapshotSummary(callback)	Active Sessions Information Summary	{base_path}/{version}/home/getActiveSessionsSnapshotSummary?{query}	Yes
getActiveSessionsChart(startDate, endDate, callback)	Get top ten sessions	{base_path}/{version}/home/getActiveSessionsChart?{query}	Yes
getAuditSummary(callback)	Audit Summary	{base_path}/{version}/home/auditSummary?{query}	Yes
getMaskLength(name, callback)	Get mask length list	{base_path}/{version}/home/getMaskLength/{pathv1}?{query}	Yes
getServerDetailList(type, rows, page, filterRules, sort, order, callback)	Remote appliances list	{base_path}/{version}/home/serverDetailList?{query}	Yes
getServerLogPaths(ip, scode, callback)	DNS appliance log paths	{base_path}/{version}/home/getServerLogPaths?{query}	Yes
getLogData(type, filterRules, argc, ip, serverName, scode, noOfLine, logstart, logend, callback)	Remote Logs	{base_path}/{version}/home/logData?{query}	Yes
getOMRReportData(ip, serverName, scode, type, callback)	Audit Logs Data	{base_path}/{version}/home/omreport?{query}	Yes
getAuditLogData(applianceIp, applianceName, applianceType, argc, q, draw, start, length, filterRules, logstart, logend, callback)	Audit Logs	{base_path}/{version}/home/auditLogDataNew?{query}	Yes
getHomeAuditLogData(type, filterRules, argc, ip, serverName, logstart, logend, callback)	Audit Logs Data	{base_path}/{version}/home/auditLogData?{query}	Yes
getAuditTrendData(success, startDate, endDate, dateStyle, ipamIpAddress, callback)	Get Audit Trend Data	{base_path}/{version}/home/getAuditTrendData?{query}	Yes
subSys(argc, ip, argv, arga, callback)	Recent Command's Time	{base_path}/{version}/home/subsys?{query}	Yes
getZoneDistributionChartData(organizationName, callback)	Data about Top ten Zones	{base_path}/{version}/home/getZoneDistChart?{query}	Yes
getLicenseWarnInfo(callback)	License validation Information	{base_path}/{version}/home/licenseExpWarnInfo?{query}	Yes
getAMQTopicStats(topicName, startDate, endDate, pageNo, pageSize, callback)	Get AMQ Topics Stats	{base_path}/{version}/home/getAMQTopicStats?{query}	Yes
generateCsvReport(serverType, callback)	Export to CSV	{base_path}/{version}/home/exportcsv?{query}	Yes
generateVersionCSVReport(serverType, callback)	Export to CSV	{base_path}/{version}/home/exportversionstocsv?{query}	Yes
genrateTopTalkerCSVReport(ip, type, duration, callback)	Export to CSV	{base_path}/{version}/home/exporttoptalkerstocsv?{query}	Yes
getDNSHtmlInd(ip, type, service, callback)	Displays the number of objects allocated based on the object allocation type in the TCPWave IPAM.	{base_path}/{version}/home/getRRDDNSInd?{query}	Yes
getDHCPServerList(callback)	DHCP Appliance List	{base_path}/{version}/home/getDHCPServerList?{query}	Yes
getDNSLastSync(type, callback)	Server Last Sync Status	{base_path}/{version}/home/getDNSLastSync?{query}	Yes
getClassfulNetworks(organizationName, callback)	Network classification	{base_path}/{version}/home/classnetworks?{query}	Yes
getSubnetCount(organizationName, callback)	Subnet classification	{base_path}/{version}/home/subnetscount?{query}	Yes
getO(callback)	Object classification	{base_path}/{version}/home/objectcount?{query}	Yes
getSchedJobCount(callback)	Object classification	{base_path}/{version}/home/schedjobcount?{query}	Yes
getSchedJobGraph(startTime, callback)	Object classification	{base_path}/{version}/home/schedjobcountgraph?{query}	Yes
getZoneCount(organizationName, callback)	Zone classification	{base_path}/{version}/home/zonecount?{query}	Yes
getDNSCount(organizationName, callback)	DNS Servers classification	{base_path}/{version}/home/dnscount?{query}	Yes
getDHCPCount(organizationName, callback)	DHCP Appliances classification	{base_path}/{version}/home/dhcpcount?{query}	Yes
getNDStats(id, callback)	DNS Servers classification	{base_path}/{version}/home/getndstats?{query}	Yes
getIPAMSubVersion(callback)	IPAM subcomponents versions	{base_path}/{version}/home/getipamsubversion?{query}	Yes
getIPAMConfiglist(callback)	IPAM configuration list	{base_path}/{version}/home/getipamconfiglist?{query}	Yes
getdhcpScopes(callback)	Top ten DHCP scopes	{base_path}/{version}/home/getdhcpscopes?{query}	Yes
getRemoteVersions(type, callback)	Remote server versions	{base_path}/{version}/home/getRemoteVersions?{query}	Yes
getDnsApplianceSummary(type, callback)	Remote server configuration	{base_path}/{version}/home/getdnsApplianceSummary?{query}	Yes
getMonitoredDeviceStats(type, callback)	Monitored device statistics	{base_path}/{version}/home/getMonitoredDeviceStats?{query}	Yes
getServerToZoneCount(callback)	DNS zone allocation chart	{base_path}/{version}/home/servertozonecount?{query}	Yes
getDNSTopTalkers(ip, type, duration, table, callback)	Server Top talker List	{base_path}/{version}/home/getToptalkers?{query}	Yes
getHeatMask(id, ip, nstart, nend, orgName, callback)	Object classification	{base_path}/{version}/home/heatmapdata?{query}	Yes
getCloudProvidersCount(organizationName, callback)	Admin roles information	{base_path}/{version}/home/cloudProvidersCount?{query}	Yes
getHAStatus(callback)	HA Configuration status	{base_path}/{version}/home/isHAConfigured?{query}	Yes
getHAIPAMList(callback)	HA IPAM Appliances List	{base_path}/{version}/home/haList?{query}	Yes
generatePdfReport(report, ip, type, duration, callback)	PDF Report	{base_path}/{version}/home/pdfreport?{query}	Yes
getLogsByPagination(applianceIp, applianceName, applianceType, applianceCode, argc, q, draw, start, length, filterRules, logstart, logend, callback)	Remote Logs	{base_path}/{version}/home/getLogs?{query}	Yes
getDNSTunnelDetectionData(ip, type, callback)	DNS tunnel detection data	{base_path}/{version}/home/dnsTunnelDetectionData?{query}	Yes
getSuspiciousQueries(ip, type, callback)	Get Suspicious Queries	{base_path}/{version}/home/getsuspiciousqueries?{query}	Yes
getLongQueries(ip, type, callback)	Get Long Queries	{base_path}/{version}/home/getlongqueries?{query}	Yes
logsPage(draw, start, length, q, filterRules, sort, order, callback)	Search Admin Group	{base_path}/{version}/home/searchlogs?{query}	Yes
postHomeDeletenotification(body, callback)	Delete alarms	{base_path}/{version}/home/deletenotification?{query}	Yes
hostName(name, callback)	Host Name Restriction	{base_path}/{version}/hostnamingpolicy/checkPolicy?{query}	Yes
getDetails(name, callback)	Host Name Policy Name Get	{base_path}/{version}/hostnamingpolicy/getdetails?{query}	Yes
postHostnamingpolicyEdit(body, callback)	Host Naming Policy Edit	{base_path}/{version}/hostnamingpolicy/edit?{query}	Yes
getHostnamingpolicyList(callback)	Host Naming policies List	{base_path}/{version}/hostnamingpolicy/list?{query}	Yes
postHostnamingpolicyDelete(body, callback)	Host Naming Policy delete	{base_path}/{version}/hostnamingpolicy/delete?{query}	Yes
postHostnamingpolicyAdd(body, callback)	Host Naming Policy Add	{base_path}/{version}/hostnamingpolicy/add?{query}	Yes
getObjectForIPAM(address, callback)	Object Details	{base_path}/{version}/ipamAppliance/getObjectDetails?{query}	Yes
appliancePagelist(draw, start, length, q, filterRules, sort, order, callback)	IPAM Appliance List	{base_path}/{version}/ipamAppliance/list?{query}	Yes
ipamTemplateDelete(id, address, callback)	IPAM Appliance delete	{base_path}/{version}/ipamAppliance/delete?{query}	Yes
changeDebugSetting(address, debugPref, callback)	Appliance Debug Setting	{base_path}/{version}/ipamAppliance/debug-setting?{query}	Yes
manageService(body, callback)	Manage Appliance Services	{base_path}/{version}/ipamAppliance/manage?{query}	Yes
getServiceStatus(body, callback)	IPAM Appliance Services Status	{base_path}/{version}/ipamAppliance/getStatus?{query}	Yes
getLocalhostIP(callback)	Localhost IP address	{base_path}/{version}/ipamAppliance/getLocalhostIP?{query}	Yes
getConfiguredType(callback)	Configured type either HA or DR	{base_path}/{version}/ipamAppliance/getConfiguredType?{query}	Yes
getRootAccessDtls(callback)	Get root access management details.	{base_path}/{version}/ipamAppliance/getRootAccessDtls?{query}	Yes
getSyncStatusDetails(address, callback)	Appliance Status GET	{base_path}/{version}/ipamAppliance/getSyncStatus?{query}	Yes
ipamApplianceSearch(draw, start, length, filterRules, sort, order, callback)	IPAM Appliance Search	{base_path}/{version}/ipamAppliance/search?{query}	Yes
getTrafficForIPAMAppliances(serverName, serverIp, argc, callback)	Get Live IPAM Traffic	{base_path}/{version}/ipamAppliance/ipamtraffic?{query}	Yes
getIAPMApplianceName(address, callback)	GET Appliance Name	{base_path}/{version}/ipamAppliance/getApplianceName?{query}	Yes
getProcessorsCount(address, callback)	Get number of Processors	{base_path}/{version}/ipamAppliance/getProcessorsCount?{query}	Yes
objectAssociatedOrgList(address, callback)	Get object associated organizations list	{base_path}/{version}/ipamAppliance/objectAssociatedOrgList?{query}	Yes
getIpamApplianceGet(id, address, callback)	IPAM Template List	{base_path}/{version}/ipamAppliance/get?{query}	Yes
postIpamApplianceUpdate(body, callback)	Update IPAM Appliance	{base_path}/{version}/ipamAppliance/update?{query}	Yes
postIpamApplianceCreate(body, callback)	Create IPAM Appliance	{base_path}/{version}/ipamAppliance/create?{query}	Yes
postIpamApplianceSyncAll(body, callback)	syncAll	{base_path}/{version}/ipamAppliance/syncAll?{query}	Yes
getIPAMTemplateGet(callback)	IPAM Template List	{base_path}/{version}/IPAMTemplate/get?{query}	Yes
getVersion(callback)	Get IPAM server version information	{base_path}/{version}/ipam/version?{query}	Yes
postV6dhcpserverDelete(address, v4Address, callback)	Delete DHCP Appliance	{base_path}/{version}/v6dhcpserver/delete?{query}	Yes
getV6dhcpserverGenerateConfig(v6Address, serverName, v4Address, organizationName, callback)	Generate Configuration	{base_path}/{version}/v6dhcpserver/generateConfig?{query}	Yes
postV6dhcpserverSyncall(body, organizationName, callback)	Generate Configuration	{base_path}/{version}/v6dhcpserver/syncall?{query}	Yes
postV6dhcpserverEdit(body, callback)	Update DHCP Appliance	{base_path}/{version}/v6dhcpserver/edit?{query}	Yes
getV6dhcpserverServerConfiguration(address, callback)	Configuration information	{base_path}/{version}/v6dhcpserver/server-configuration?{query}	Yes
getV6dhcpserverSearch(page, rows, callback)	Server Search	{base_path}/{version}/v6dhcpserver/search?{query}	Yes
getV6dhcpserverPrimaryServersList(inEdit, orgName, callback)	Primary IPv6 DHCP Appliance List	{base_path}/{version}/v6dhcpserver/primary-servers-list?{query}	Yes
getV6dhcpserverV6dhcpActiveLeases(serverIp, v6serverIp, callback)	DHCPv6 Appliance Active Leases	{base_path}/{version}/v6dhcpserver/v6dhcpActiveLeases?{query}	Yes
listbyorg(organizationName, callback)	DHCP Appliance List	{base_path}/{version}/v6dhcpserver/listbyorg?{query}	Yes
getV6dhcpserverServerSubnetReferences(address, callback)	Subnet Reference	{base_path}/{version}/v6dhcpserver/server-subnet-references?{query}	Yes
getV6dhcpserverViewconfig(address, organizationName, callback)	Get Configuration	{base_path}/{version}/v6dhcpserver/viewconfig?{query}	Yes
getV6dhcpserverList(callback)	DHCP Appliance List	{base_path}/{version}/v6dhcpserver/list?{query}	Yes
postV6dhcpserverAdd(body, callback)	Add IPv6 DHCP Appliance	{base_path}/{version}/v6dhcpserver/add?{query}	Yes
getV6scopeList(subnetAddress, orgName, draw, start, length, filterRules, sort, order, callback)	List IPv6 DHCP Scopes	{base_path}/{version}/v6scope/list?{query}	Yes
deleteScope(body, callback)	IPv6 Scope Delete	{base_path}/{version}/v6scope/delete?{query}	Yes
getScopeValidateRequestData(subAdr, organizationName, callback)	Scope Validation Request	{base_path}/{version}/v6scope/validate_request?{query}	Yes
autoProvision(body, callback)	Scope Create	{base_path}/{version}/v6scope/autoprovision?{query}	Yes
deleteSingleScope(body, callback)	IPv6 Scope Delete	{base_path}/{version}/v6scope/singledelete?{query}	Yes
templateList(page, rows, q, filterRules, callback)	List IPv6 DHCP Option Templates	{base_path}/{version}/v6templates/option-template-list?{query}	Yes
pageList(serverTypeCode, entityTypeCode, referenceType, referenceId, page, rows, q, filterRules, inEdit, organizationName, callback)	Template Page	{base_path}/{version}/v6templates/page/{pathv1}/{pathv2}?{query}	Yes
templateParamsList(templateId, templateName, organizationName, viewAll, callback)	List Configured Options Of IPv6 DHCP Option Template	{base_path}/{version}/v6templates/list-params?{query}	Yes
v6paramSearch(draw, start, length, filterRules, sort, order, callback)	IPv6 Template Parameter Name Search	{base_path}/{version}/v6templates/v6params-name/search?{query}	Yes
v6paramValueSearch(draw, start, length, filterRules, sort, order, callback)	IPv4 Template Parameter Value Search	{base_path}/{version}/v6templates/v6params-value/search?{query}	Yes
postV6templatesUpdate(body, callback)	Updates IPv6 DHCP Option Template	{base_path}/{version}/v6templates/update?{query}	Yes
postV6templatesCreate(body, callback)	Add IPv6 DHCP Option Template	{base_path}/{version}/v6templates/create?{query}	Yes
postIpv6networkDelete(body, callback)	Delete IPV6 Network	{base_path}/{version}/ipv6network/delete?{query}	Yes
getIpv6networkPage(draw, start, length, q, filterRules, sort, order, callback)	IPv6 Network list	{base_path}/{version}/ipv6network/page?{query}	Yes
postIpv6networkEdit(body, callback)	Update IPv6 Network	{base_path}/{version}/ipv6network/edit?{query}	Yes
networkFinder(subnetAddress, organizationName, callback)	Subnet Property Finder	{base_path}/{version}/ipv6network/subnets/ip/{pathv1}/{pathv2}?{query}	Yes
getStats(id, address, callback)	IPv6 Network Statistics	{base_path}/{version}/ipv6network/stats?{query}	Yes
searchNetworks(page, rows, callback)	Search Networks	{base_path}/{version}/ipv6network/search?{query}	Yes
getIpv6networkIpv6subnetsNetworkIdNwMaskLengthNwStartAddressAllocType(networkId, nwMaskLength, nwStartAddress, allocType, callback)	IPV6 Subnet List	{base_path}/{version}/ipv6network/ipv6subnets/{pathv1}/{pathv2}/{pathv3}/{pathv4}?{query}	Yes
postIpv6networkAdd(body, callback)	Add IPV6 Network	{base_path}/{version}/ipv6network/add?{query}	Yes
postIpv6objectDeleteMultiple(body, callback)	Delete IPv6 Objects	{base_path}/{version}/ipv6object/delete-multiple?{query}	Yes
getIpv6objectPage(subnetId, organization, subnetAddress, draw, start, length, q, filterRules, sort, order, callback)	IPV6 object list	{base_path}/{version}/ipv6object/page?{query}	Yes
getIpv6objectSearch(draw, start, length, filterRules, sort, order, callback)	Search Objects	{base_path}/{version}/ipv6object/search?{query}	Yes
postIpv6objectEdit(body, callback)	Update IPv6 Object	{base_path}/{version}/ipv6object/edit?{query}	Yes
ping(ip, callback)	Ping IPv6 Address	{base_path}/{version}/ipv6object/tools/ping?{query}	Yes
jobexecute(body, callback)	Schedule Object Job	{base_path}/{version}/ipv6object/schedObjectOperation?{query}	Yes
schedAdd(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jobId, callback)	Scheduled object add operation.	{base_path}/{version}/ipv6object/sched_add?{query}	Yes
getDHCPDetails(id, address, callback)	Object DHCP Details	{base_path}/{version}/ipv6object/getDHCPDetails?{query}	Yes
traceroute(ip, callback)	Trace Route Object	{base_path}/{version}/ipv6object/tools/traceroute?{query}	Yes
ipv6DuplicateResult(name, domainName, orgName, ipAddr, callback)	Object Duplicate Name Checker	{base_path}/{version}/ipv6object/IPv6duplicateNameChecker?{query}	Yes
getIpv6objectGet(id, address, organizationName, callback)	Get IPv6 Object	{base_path}/{version}/ipv6object/get?{query}	Yes
postIpv6objectRrDelete(body, callback)	Resource Record Delete	{base_path}/{version}/ipv6object/rr/delete?{query}	Yes
postIpv6objectRrAdd(body, callback)	Network Resource Record Add	{base_path}/{version}/ipv6object/rr/add?{query}	Yes
postIpv6objectAdd(body, callback)	Add IPv6 Object	{base_path}/{version}/ipv6object/add?{query}	Yes
postIpv6subnetgroupDeleteAll(body, callback)	IPV6 Subnet Group Delete All	{base_path}/{version}/ipv6subnetgroup/deleteAll?{query}	Yes
listSubnets(subnetGrpId, subnetGrpName, orgName, draw, start, length, filterRules, sort, order, callback)	List Subnets present in the given Subnet Group	{base_path}/{version}/ipv6subnetgroup/listSubnets?{query}	Yes
disassociateSubnet(fullAddress, orgName, callback)	Disassociate Subnet	{base_path}/{version}/ipv6subnetgroup/disassociate?{query}	Yes
getSubnet(id, name, organization, callback)	IPV6 Subnet Group Get	{base_path}/{version}/ipv6subnetgroup/get?{query}	Yes
postIpv6subnetgroupUpdate(body, callback)	IPV6 Subnet Group Update	{base_path}/{version}/ipv6subnetgroup/update?{query}	Yes
getIpv6subnetgroupList(callback)	IPV6 Subnet Group List	{base_path}/{version}/ipv6subnetgroup/list?{query}	Yes
getIpv6subnetgroupListbyorg(organizationId, organizationName, callback)	IPV6 Subnet Group Organization List	{base_path}/{version}/ipv6subnetgroup/listbyorg?{query}	Yes
postIpv6subnetgroupAdd(body, callback)	IPv6 Subnet Group Add	{base_path}/{version}/ipv6subnetgroup/add?{query}	Yes
postIpv6subnetDelete(body, orgName, callback)	Deletes IPv6 subnets	{base_path}/{version}/ipv6subnet/delete?{query}	Yes
getIpv6subnetPaged(networkAddress, orgName, draw, start, length, q, filterRules, sort, order, callback)	Subnet list page	{base_path}/{version}/ipv6subnet/paged?{query}	Yes
postIpv6subnetEdit(body, callback)	IPv6 Subnet Edit	{base_path}/{version}/ipv6subnet/edit?{query}	Yes
createSingle(body, callback)	IPv6 Subnet Add	{base_path}/{version}/ipv6subnet/add?{query}	Yes
searchSubnets(page, rows, callback)	Subnet Search	{base_path}/{version}/ipv6subnet/search?{query}	Yes
getIpv6SubnetDetails(subnetAddress, orgName, callback)	IPv6 Subnet Details	{base_path}/{version}/ipv6subnet/getIpv6SubnetDetails?{query}	Yes
getSubNetByAddress(address, organizationName, callback)	Get Subnet	{base_path}/{version}/ipv6subnet/ip/{pathv1}/{pathv2}?{query}	Yes
getIpv6subnetActiveLeases(page, rows, serverAddress, v4serverAddress, subnetAddress, organizationName, callback)	List Active Leases	{base_path}/{version}/ipv6subnet/activeLeases?{query}	Yes
getIpv6subnetListv6subnet(networkIp, orgName, page, rows, q, filterRules, sort, order, callback)	Subnet List Page	{base_path}/{version}/ipv6subnet/listv6subnet?{query}	Yes
getCloudAttributeNames(type, subnetID, callback)	getCloudAttributeNames	{base_path}/{version}/importcloud/attr?{query}	Yes
getClousHostedSubnets(organization, callback)	getClousHostedSubnets	{base_path}/{version}/importcloud/subnet/page?{query}	Yes
updateAutoImportSubnets(body, callback)	updateAutoImportSubnets	{base_path}/{version}/importcloud/updateAutoImportSubnets?{query}	Yes
doImport(body, callback)	Import from cloud	{base_path}/{version}/importcloud/import?{query}	Yes
getImportSupportedTypes(callback)	Supported Import File Types	{base_path}/{version}/import/supported_types?{query}	Yes
listFields(type, callback)	Import Field's Type	{base_path}/{version}/import/fields?{query}	Yes
postImportType(type, body, callback)	Import	{base_path}/{version}/import/{pathv1}?{query}	Yes
postRoothintsEdit(body, callback)	Internet Root Hint Edit	{base_path}/{version}/roothints/edit?{query}	Yes
getRoothintsList(callback)	Internet Root Hint List	{base_path}/{version}/roothints/list?{query}	Yes
getRoothintsSync(callback)	Internet Root Hints Sync	{base_path}/{version}/roothints/sync?{query}	Yes
postLocationDelete(body, callback)	Delete Location	{base_path}/{version}/location/delete?{query}	Yes
postLocationUpdate(body, callback)	Edit Location	{base_path}/{version}/location/update?{query}	Yes
getFullLocations(organizationName, organizationId, page, rows, q, draw, start, length, inEdit, callback)	Get Location	{base_path}/{version}/location/getFullLocations?{query}	Yes
locationPage(page, rows, callback)	Search Location	{base_path}/{version}/location/search?{query}	Yes
getLocationReferences(body, callback)	Location List References	{base_path}/{version}/location/locationReferences?{query}	Yes
getLocReferences(page, rows, tables, id, count, callback)	Location List References	{base_path}/{version}/location/references?{query}	Yes
postLocationGet(body, callback)	Get Location	{base_path}/{version}/location/get?{query}	Yes
postLocationAdd(body, callback)	Add Location	{base_path}/{version}/location/add?{query}	Yes
getLogcatList(callback)	Log Categories List	{base_path}/{version}/logcat/list?{query}	Yes
postLogchannelDelete(id, channel, callback)	Delete Log Channels	{base_path}/{version}/logchannel/delete?{query}	Yes
postLogchannelEdit(body, callback)	Update Log Channels	{base_path}/{version}/logchannel/edit?{query}	Yes
logChannelPage(page, rows, callback)	Search Log Channels	{base_path}/{version}/logchannel/search?{query}	Yes
searchLogChannelReferences(page, rows, tables, id, count, callback)	Log Channel References	{base_path}/{version}/logchannel/references?{query}	Yes
getLogchannelGet(channel, callback)	Get Log Channel	{base_path}/{version}/logchannel/get?{query}	Yes
getLogchannelList(callback)	List of Log Channel	{base_path}/{version}/logchannel/list?{query}	Yes
postLogchannelAdd(body, callback)	Add Log Channel	{base_path}/{version}/logchannel/add?{query}	Yes
postServicesManage(body, callback)	Manage Appliance Services	{base_path}/{version}/services/manage?{query}	Yes
postServicesGetStatus(body, callback)	Appliance Status	{base_path}/{version}/services/getStatus?{query}	Yes
getMirroredzoneGetdetails(name, id, callback)	Get Mirrored Zone Details	{base_path}/{version}/mirroredzone/getdetails?{query}	Yes
postMirroredzoneEdit(body, callback)	Edit Mirrored Zone	{base_path}/{version}/mirroredzone/edit?{query}	Yes
getMirroredzoneListbypage(draw, start, length, filterRules, q, sort, order, callback)	Mirrored Zones List	{base_path}/{version}/mirroredzone/listbypage?{query}	Yes
postMirroredzoneDelete(body, callback)	Delete Mirrored Zone	{base_path}/{version}/mirroredzone/delete?{query}	Yes
postMirroredzoneAdd(body, callback)	Add Mirrored Zones	{base_path}/{version}/mirroredzone/add?{query}	Yes
postMonitorEdit(body, callback)	Monitoring Service	{base_path}/{version}/monitor/edit?{query}	Yes
updateServiceStatus(body, status, callback)	Monitoring Service	{base_path}/{version}/monitor/updateServiceStatus?{query}	Yes
changeMonitoring(body, callback)	Enable or Disable Monitoring	{base_path}/{version}/monitor/monitoring?{query}	Yes
listMonitorServiceConfig(callback)	List Monitoring Services	{base_path}/{version}/monitor/listconfig?{query}	Yes
updateMonitorService(body, callback)	Update Monitoring Service	{base_path}/{version}/monitor/update?{query}	Yes
changeMultiMonitoring(body, callback)	Enable or Disable Monitoring	{base_path}/{version}/monitor/multimonitoring?{query}	Yes
enableDisableMonitoring(body, callback)	Enables or Disables Monitoring on specified resources	{base_path}/{version}/monitor/monitoringUpdate?{query}	Yes
getMonitoringServiceDetails(serviceName, callback)	Monitoring Service Details	{base_path}/{version}/monitor/getServiceDetails?{query}	Yes
getMonitoringHierachy(callback)	Monitoring Hierachy Details	{base_path}/{version}/monitor/monitoring_hierarchy?{query}	Yes
monitorServiceConfigHistory(serviceName, draw, start, length, filterRules, q, sort, order, callback)	Monitoring Services History	{base_path}/{version}/monitor/history?{query}	Yes
getMsgcertmgmtCertlist(callback)	List Certificate	{base_path}/{version}/msgcertmgmt/certlist?{query}	Yes
postMsgcertmgmtDuplicateAlias(body, callback)	Duplicate Alias check	{base_path}/{version}/msgcertmgmt/duplicateAlias?{query}	Yes
getMsgcertmgmtCertValidate(cfile, callback)	Validation Certificate	{base_path}/{version}/msgcertmgmt/certValidate?{query}	Yes
getMsgcertmgmtAllcertValidDays(callback)	Get number of days all certificates are valid	{base_path}/{version}/msgcertmgmt/allcertValidDays?{query}	Yes
postMsgcertmgmtCertDelete(body, callback)	Delete Certificate	{base_path}/{version}/msgcertmgmt/certDelete?{query}	Yes
postMsgcertmgmtChangeKeystorePassword(body, callback)	Change Keystore Password	{base_path}/{version}/msgcertmgmt/changeKeystorePassword?{query}	Yes
postMsgcertmgmtJettyRestart(callback)	Restart Jetty Server	{base_path}/{version}/msgcertmgmt/jettyRestart?{query}	Yes
keystorageValidate(body, callback)	Validate Keystore	{base_path}/{version}/msgcertmgmt/keystoreValidate?{query}	Yes
msgcertificateImport(body, callback)	Import Message Certificate	{base_path}/{version}/msgcertmgmt/msgcertImport?{query}	Yes
msgcreateSelfSignedCert(body, callback)	Create and Import a Self-Signed Message Certificate	{base_path}/{version}/msgcertmgmt/createSelfSignedCert?{query}	Yes
certPublishToRemotes(body, callback)	Publish Certificate	{base_path}/{version}/msgcertmgmt/certPublish?{query}	Yes
truststoreDownload(callback)	Download Truststore	{base_path}/{version}/msgcertmgmt/truststoreDownload?{query}	Yes
postNetworkDelete(body, callback)	Network Delete	{base_path}/{version}/network/delete?{query}	Yes
getNetworkPaged(draw, start, length, filterRules, q, sort, order, callback)	Network Details	{base_path}/{version}/network/paged?{query}	Yes
postNetworkEdit(body, callback)	Edit Network	{base_path}/{version}/network/edit?{query}	Yes
getNextAvailableNetwork(orgId, orgName, mask, callback)	Get next available network	{base_path}/{version}/network/getNextAvailableNetwork?{query}	Yes
postNetworkAddMultiple(body, callback)	Network Add	{base_path}/{version}/network/add_multiple?{query}	Yes
getRRDataEdit(ownerName, callback)	Network Resource Record Expand View Edit	{base_path}/{version}/network/getRRDataExpandViewEdit/{pathv1}?{query}	Yes
getNetworkSubnetsIpSubnetAddressOrganizationName(subnetAddress, organizationName, callback)	Subnet Property Finder	{base_path}/{version}/network/subnets/ip/{pathv1}/{pathv2}?{query}	Yes
networkPropertyFinder(networkAddress, organizationName, callback)	Network Property Finder	{base_path}/{version}/network/propertyFinder/ip/{pathv1}?{query}	Yes
getNetworkStats(id, address, callback)	Network Statistics	{base_path}/{version}/network/stats?{query}	Yes
getNetworkSearch(page, rows, callback)	Search Networks	{base_path}/{version}/network/search?{query}	Yes
getNetworkDetailsByIP(addr1, addr2, addr3, addr4, organizationName, callback)	Network Details by IP	{base_path}/{version}/network/detailsByIP?{query}	Yes
createNextFreeNetwork(orgName, name, zoneTemplate, mask, body, callback)	Network Add	{base_path}/{version}/network/add_next?{query}	Yes
getNetworkGetRRData(networkId, ipAddress, organizationName, callback)	Network Resource Record List	{base_path}/{version}/network/getRRData?{query}	Yes
postNetworkRrEdit(existingOwner, existingData, body, callback)	Network Resource Record Update	{base_path}/{version}/network/rr/edit?{query}	Yes
getNetworkList(page, rows, callback)	Network List	{base_path}/{version}/network/list?{query}	Yes
postNetworkRrDelete(body, callback)	Delete Resource Records	{base_path}/{version}/network/rr/delete?{query}	Yes
check(body, callback)	Associated Servers Check	{base_path}/{version}/network/associated-servers-check?{query}	Yes
postNetworkRrAdd(body, callback)	Network Resource Record Add	{base_path}/{version}/network/rr/add?{query}	Yes
postNetworkAdd(body, callback)	Network Add	{base_path}/{version}/network/add?{query}	Yes
postOspatchUpload(body, callback)	Patch Upload	{base_path}/{version}/ospatch/upload?{query}	Yes
osPatchList(callback)	Firmware Patch List	{base_path}/{version}/ospatch/list?{query}	Yes
deployAPatch(patchName, appliances, callback)	Deploy a Firmware Patch	{base_path}/{version}/ospatch/deploy?{query}	Yes
getObjectSearch(draw, start, length, filterRules, sort, order, callback)	List Object Search	{base_path}/{version}/object/search?{query}	Yes
getObjectPaged(subnetId, subnetAddress, draw, start, length, orgName, filterRules, sort, order, callback)	Object List	{base_path}/{version}/object/paged?{query}	Yes
postObjectEdit(body, callback)	Object Edit	{base_path}/{version}/object/edit?{query}	Yes
getObjectToolsPing(ip, callback)	Ping IP Address	{base_path}/{version}/object/tools/ping?{query}	Yes
listUnused(subnetId, subnetAddress, organizationName, callback)	Unused Object List	{base_path}/{version}/object/list/unused?{query}	Yes
getIPAddress(fqdn, organizationName, callback)	Get IP Address	{base_path}/{version}/object/getip?{query}	Yes
getNextFreeIp(subnetAddress, organizationName, callback)	Next Free IP	{base_path}/{version}/object/nextfreeip?{query}	Yes
postObjectSchedObjectOperation(body, callback)	Schedule Object Job	{base_path}/{version}/object/schedObjectOperation?{query}	Yes
postObjectSchedAdd(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jobId, callback)	Scheduled object add operation.	{base_path}/{version}/object/sched_add?{query}	Yes
validateVMWareAuthSource(objectIP, objectName, domainName, body, callback)	Validate VMWare Object	{base_path}/{version}/object/validatevmwareobject?{query}	Yes
schedEdit(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jobId, callback)	Edit Schedule Operation	{base_path}/{version}/object/sched_edit?{query}	Yes
schedDeleteMultiple(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jobId, callback)	Schedule Multiple Object Delete	{base_path}/{version}/object/sched_deletemultiple?{query}	Yes
delMultiple(body, callback)	Object Delete	{base_path}/{version}/object/delete-multiple?{query}	Yes
getObjectReferences(addressList, organizationName, callback)	Get Object References	{base_path}/{version}/object/get-referenced-rrs?{query}	Yes
updateNSMultipleForobject(body, callback)	Object Dynamic NS Flag Update	{base_path}/{version}/object/update-multiple-ns?{query}	Yes
getForUser(id, address, organizationName, callback)	Object for User	{base_path}/{version}/object/getforuser?{query}	Yes
getObjectGetDHCPDetails(id, address, orgName, callback)	Object DHCP Details	{base_path}/{version}/object/getDHCPDetails?{query}	Yes
getRRDataAdd(ownerName, data, callback)	Object Resource Record Details	{base_path}/{version}/object/getObjectRRDataExpandView/{pathv1}?{query}	Yes
generateCsvForSearch(callback)	CSV export of Object Search Grid	{base_path}/{version}/object/csvforsearch?{query}	Yes
searchObjectReferences(page, rows, tables, id, count, callback)	Find Object References	{base_path}/{version}/object/references?{query}	Yes
duplicateResult(name, domainName, orgName, ipAddr, callback)	Object Duplicate Name Checker	{base_path}/{version}/object/duplicateNameChecker?{query}	Yes
pingcheck(address, callback)	Ping before create	{base_path}/{version}/object/pingcheck?{query}	Yes
getObjectToolsTraceroute(ip, callback)	Trace Route Object	{base_path}/{version}/object/tools/traceroute?{query}	Yes
postObjectTraverse(body, callback)	Resource Record Traverse	{base_path}/{version}/object/traverse?{query}	Yes
dcObjectslist(organizationId, organizationName, callback)	Domain Controller Objects	{base_path}/{version}/object/dcobjectlist?{query}	Yes
dcObjectslistByDomain(organizationId, organizationName, domainName, callback)	DC object List by Domain	{base_path}/{version}/object/dcobjectlistbydomain?{query}	Yes
deleteLeaseRequest(objectAddress, serverAddress, callback)	Delete Active DHCP Lease	{base_path}/{version}/object/deleteDHCPLease?{query}	Yes
getSubnetAddress(address, callback)	Subnet Address	{base_path}/{version}/object/getSnAddr?{query}	Yes
syncObjectToDNSServers(objectIps, organizationName, callback)	Sync Objects	{base_path}/{version}/object/sync?{query}	Yes
exportRRs(address, fileName, scope, defaultARec, callback)	Export Resource Records	{base_path}/{version}/object/exportRRs?{query}	Yes
multiEdit(body, callback)	MultiObject Edit	{base_path}/{version}/object/multiedit?{query}	Yes
getFingerprintData(mac, callback)	Get Fingerprint Information	{base_path}/{version}/object/getFingerPrintData?{query}	Yes
getLeaseCount(organizationName, callback)	Get Active and Expired Lease Counts	{base_path}/{version}/object/getLeaseCounts?{query}	Yes
getNextFreeIP(subnetId, subnetAddr, orgName, callback)	Get the next available free IP in a given subnet.	{base_path}/{version}/object/getNextFreeIP?{query}	Yes
getDiscoveredObjectData(id, callback)	Object Discovered Details	{base_path}/{version}/object/getDiscoveredData?{query}	Yes
changeReference(existingIP, newIP, organizationName, callback)	Object Resource Record Update	{base_path}/{version}/object/changeReference?{query}	Yes
reclaimDHCPObjects(body, callback)	Objects Reclaim	{base_path}/{version}/object/reclaimObjects?{query}	Yes
postObjectRrEdit(existingOwner, existingData, body, callback)	Object Resource Record Update	{base_path}/{version}/object/rr/edit?{query}	Yes
getObjectList(subnetId, subnetAddress, page, rows, organizationName, callback)	Object List	{base_path}/{version}/object/list?{query}	Yes
getObjectListCriteria(subnetId, subnetAddress, classCode, allocType, page, rows, callback)	Object List by Criteria	{base_path}/{version}/object/listCriteria?{query}	Yes
postObjectRrDelete(body, callback)	Resource Record Delete	{base_path}/{version}/object/rr/delete?{query}	Yes
postObjectAdd(body, callback)	Object Add	{base_path}/{version}/object/add?{query}	Yes
postObjectRrAdd(body, callback)	Object Resource Record Add	{base_path}/{version}/object/rr/add?{query}	Yes
export(name, body, callback)	Export Organization Data	{base_path}/{version}/orgbulkops/export?{query}	Yes
exportOrganizationData(name, body, callback)	Export Organization Data	{base_path}/{version}/orgbulkops/orgexport?{query}	Yes
downloadZipFile(fileName, callback)	Export Organization Data	{base_path}/{version}/orgbulkops/download?{query}	Yes
getProgressStatus(operationCode, callback)	Get the IPAM statistics	{base_path}/{version}/orgbulkops/getProgressStatus?{query}	Yes
getOrgStatus(operationCode, callback)	TIMS-7003: You are not authorized to perform this operation.	{base_path}/{version}/orgbulkops/getProgressAllStatus?{query}	Yes
postOrgbulkopsImport(body, callback)	Import Organization Data	{base_path}/{version}/orgbulkops/import?{query}	Yes
postOrganizationDelete(body, callback)	Organization Delete	{base_path}/{version}/organization/delete?{query}	Yes
orgRootZone(body, callback)	Enable Root Zone	{base_path}/{version}/organization/enablerootzone?{query}	Yes
isRootZoneEnabled(callback)	Is Root Zone Enabled	{base_path}/{version}/organization/isrootzoneenabled?{query}	Yes
rootZoneEnabledList(callback)	Root Zone Enabled List	{base_path}/{version}/organization/rootzoneenabledlist?{query}	Yes
organizationPage(page, rows, callback)	Search Organization	{base_path}/{version}/organization/search?{query}	Yes
getOrganizationGet(name, callback)	Get Organization	{base_path}/{version}/organization/get?{query}	Yes
postOrganizationUpdate(body, callback)	Organization Edit	{base_path}/{version}/organization/update?{query}	Yes
getOrganizationList(callback)	Organization List	{base_path}/{version}/organization/list?{query}	Yes
postOrganizationAdd(body, callback)	Organization Add	{base_path}/{version}/organization/add?{query}	Yes
paramUserDefCreate(body, callback)	User Defined DHCP Options Create	{base_path}/{version}/params/dhcp-option-custom-create?{query}	Yes
paramUserDefUpdate(body, callback)	User Defined DHCP Options Edit	{base_path}/{version}/params/dhcp-option-custom-update?{query}	Yes
customFolderCreate(body, callback)	Create Custom Folder	{base_path}/{version}/params/custom-folder-create?{query}	Yes
customFolderUpdate(body, callback)	Edit Custom Folder	{base_path}/{version}/params/custom-folder-update?{query}	Yes
postParamsCustomFolderDelete(folderName, callback)	Delete Custom Folder	{base_path}/{version}/params/custom-folder-delete?{query}	Yes
paramUserDefDelete(name, subOption, groupName, callback)	User Defined DHCP Options Delete	{base_path}/{version}/params/dhcp-option-custom-delete?{query}	Yes
dhcpGroupsList(callback)	Custom Folders List	{base_path}/{version}/params/groupsList?{query}	Yes
dhcpGroupSearch(page, rows, callback)	Custom Folders Search List	{base_path}/{version}/params/search?{query}	Yes
v6ParamsList(callback)	IPV6 Param List	{base_path}/{version}/params/v6ParamsList?{query}	Yes
objectMove(body, callback)	Object Move	{base_path}/{version}/qmove/object?{query}	Yes
objectScheduleMoveCheck(body, callback)	Object Move	{base_path}/{version}/qmove/objectSchedChecks?{query}	Yes
postRpzTemplateModify(body, callback)	Edit DNS Response Zone Policy(RPZ) Template	{base_path}/{version}/rpz/template/modify?{query}	Yes
getRpzTemplateAssocList(address, templateName, orgName, callback)	List DNS Remote Association with RPZ Template	{base_path}/{version}/rpz/template/assoc/list?{query}	Yes
postRpzTemplateAssocUpdate(address, templateName, callback)	Update DNS Remote Instances Associated with Template	{base_path}/{version}/rpz/template/assoc/update?{query}	Yes
policyFileslist(callback)	List the Response Policy Zone (RPZ) rules files.	{base_path}/{version}/rpz/policy/fileslist?{query}	Yes
updatePolicyFile(body, callback)	Update RPZ policy file	{base_path}/{version}/rpz/policy/updatepolicyfile?{query}	Yes
deletePolicyFile(pfile, callback)	Delete RPZ policy file	{base_path}/{version}/rpz/policy/deletepolicyfile?{query}	Yes
getPolicyFileRules(page, rows, callback)	List the Response Policy Zone (RPZ) rules from the temporary table.	{base_path}/{version}/rpz/policy/getpolicyfilerules?{query}	Yes
resetEditMode(callback)	Reset the exclusive edit mode lock.	{base_path}/{version}/rpz/policy/reseteditmode?{query}	Yes
emptyPolicyRulesTable(callback)	Empty policy rule table	{base_path}/{version}/rpz/policy/emptypolicyrulestable?{query}	Yes
loadPolicyFileRules(body, callback)	Load the Response Policy Zone(RPZ) policy rules from specified file into the temporary table.	{base_path}/{version}/rpz/policy/loadpolicyfilerules?{query}	Yes
policyfileDownload(pfile, callback)	Download the Response Policy Zone (RPZ) rules file.	{base_path}/{version}/rpz/policy/policyfiledownload?{query}	Yes
policyfileValidate(pfile, callback)	Validate the RPZ rules in the file.	{base_path}/{version}/rpz/policy/policyfilevalidate?{query}	Yes
policyfileImport(body, callback)	Import the Response Policy Zone (RPZ) policy rules file.	{base_path}/{version}/rpz/policy/policyfileImport?{query}	Yes
policyruleDelete(body, callback)	Delete the Response Zone Policy(RPZ) rules file	{base_path}/{version}/rpz/policy/policyruleDelete?{query}	Yes
updatePolicyRule(body, callback)	Add or Update the Response Policy Zone (RPZ) policy rule in the temporary table in the TCPWave IPAM. Below example shows sample request JSON: { "policy_trigger":"yahoo1.com", "policy_rr":"CNAME", "policy_rhvalue":"xen.tcpwave.com." }	{base_path}/{version}/rpz/policy/updatePolicyRule?{query}	Yes
postRpzTemplateAdd(body, callback)	Add DNS Response Zone Policy(RPZ) Template	{base_path}/{version}/rpz/template/add?{query}	Yes
getRpzTemplateGet(name, callback)	Get DNS Response Policy Zone(RPZ) Template	{base_path}/{version}/rpz/template/get?{query}	Yes
getRpzTemplateList(orgName, callback)	List DNS Response Zone Policy(RPZ) templates	{base_path}/{version}/rpz/template/list?{query}	Yes
postRpzTemplateDelete(name, callback)	Delete DNS Response Zone Policy(RPZ) Template	{base_path}/{version}/rpz/template/delete?{query}	Yes
postRevzoneMultidelete(body, callback)	Reverse Zone Delete Multiple	{base_path}/{version}/revzone/multidelete?{query}	Yes
getRevZone(body, callback)	Reverse Zone Get	{base_path}/{version}/revzone/getRevZone?{query}	Yes
revZonePageList(draw, start, length, filterRules, sort, order, callback)	Reverse Zone List	{base_path}/{version}/revzone/page?{query}	Yes
getNetworkMask(address, orgId, orgName, callback)	Get Network Mask For a Subnet	{base_path}/{version}/revzone/getNetworkMask?{query}	Yes
zoneForceSync(zoneOrgNames, callback)	Reverse Zone Force Sync	{base_path}/{version}/revzone/forcesynczones?{query}	Yes
zonePage(page, rows, callback)	Reverse Zone Search	{base_path}/{version}/revzone/search?{query}	Yes
getRevzoneGet(revZoneId, revZoneName, orgName, callback)	Get RR List	{base_path}/{version}/revzone/get?{query}	Yes
postRevzoneRrEdit(existingOwner, existingData, body, callback)	Reverse Zone Resource Record Update	{base_path}/{version}/revzone/rr/edit?{query}	Yes
postRevzoneUpdate(body, callback)	Reverse Zone Edit	{base_path}/{version}/revzone/update?{query}	Yes
postRevzoneRrDelete(body, callback)	Delete Resource Records	{base_path}/{version}/revzone/rr/delete?{query}	Yes
postRevzoneAdd(body, callback)	Reverse Zone Add	{base_path}/{version}/revzone/add?{query}	Yes
postRevzoneRrAdd(body, callback)	Reverse Zone Resource Record Add	{base_path}/{version}/revzone/rr/add?{query}	Yes
getRoleList(callback)	Admin Role List	{base_path}/{version}/role/list?{query}	Yes
configure(body, callback)	Configure root access authentication on appliances	{base_path}/{version}/rootaccessmgmt/configure?{query}	Yes
listVaultTypes(callback)	Supported Vault Types	{base_path}/{version}/rootaccessmgmt/list_vault_types?{query}	Yes
getVaultDetails(callback)	Get Vault preferences	{base_path}/{version}/rootaccessmgmt/get?{query}	Yes
getLogLevel(callback)	Get Debug level	{base_path}/{version}/sched/opers/loginfo?{query}	Yes
getJobExecStatusAfter(exectime, callback)	Get Job Execution status	{base_path}/{version}/sched/execstatus/after/{pathv1}?{query}	Yes
getJobIdStatus(id, page, rows, utcdiff, callback)	Get Scheduled Jobs	{base_path}/{version}/sched/execstatus/{pathv1}?{query}	Yes
deleteSchedExecstatusId(id, callback)	Delete All Job Execution status	{base_path}/{version}/sched/execstatus/{pathv1}?{query}	Yes
addExecStatus(body, callback)	Add Schedule Job Execution Status	{base_path}/{version}/sched/execstatus/add?{query}	Yes
postSchedJobExecute(body, callback)	Scheduled Job Execution	{base_path}/{version}/sched/job/execute?{query}	Yes
displayList(utcdiff, callback)	Currently Available Scheduled Tasks List	{base_path}/{version}/sched/job/displayList?{query}	Yes
jobexecuteNow(jid, callback)	Execute Scheduled Job Now	{base_path}/{version}/sched/job/executeNow?{query}	Yes
multipleDelete(body, callback)	Scheduled job multi delete	{base_path}/{version}/sched/job/multipleDelete?{query}	Yes
purgeJobs(body, callback)	Purge Job	{base_path}/{version}/sched/job/purgeJobs?{query}	Yes
ipamDelete(id, callback)	Current Scheduled Job Delete	{base_path}/{version}/sched/job/ipamDelete/{pathv1}?{query}	Yes
ipamEdit(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, utcdiff, callback)	Scheduled Job Edit	{base_path}/{version}/sched/job/ipamEdit?{query}	Yes
ipamAdd(repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jid, jtype, jdata, jarg, utcdiff, callback)	Scheduled Job Add	{base_path}/{version}/sched/job/ipamAdd?{query}	Yes
jobTypeList(callback)	List Scheduled Jobs Type	{base_path}/{version}/sched/job/jobTypeList?{query}	Yes
getSchedJobGetserversyncscheduledetails(ip, entity, callback)	Scheduled Appliance Sync Details	{base_path}/{version}/sched/job/getserversyncscheduledetails?{query}	Yes
getSchedJobId(id, callback)	Get Scheduled Job	{base_path}/{version}/sched/job/{pathv1}?{query}	Yes
deleteSchedJobId(id, callback)	Delete Scheduled Job	{base_path}/{version}/sched/job/{pathv1}?{query}	Yes
postSchedJobEdit(body, callback)	Scheduled Job Edit	{base_path}/{version}/sched/job/edit?{query}	Yes
getSchedJobList(callback)	Scheduled Tasks List	{base_path}/{version}/sched/job/list?{query}	Yes
postSchedJobAdd(body, callback)	Schedule Job Add	{base_path}/{version}/sched/job/add?{query}	Yes
postSchedhandlerExecute(body, callback)	Schedule Object Job	{base_path}/{version}/schedhandler/execute?{query}	Yes
postSchedhandlerSchedule(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, jobId, callback)	Schedule an operation	{base_path}/{version}/schedhandler/schedule?{query}	Yes
deleteFromScheduledRpt(reportType, ids, callback)	Audit Report Delete	{base_path}/{version}/Scheduledreports/delete?{query}	Yes
getScheduledreportsScheduledreportlist(reportType, draw, start, length, filterRules, callback)	Scheduled Audit Report List	{base_path}/{version}/Scheduledreports/Scheduledreportlist?{query}	Yes
subscribeToScheduledRpt(reportType, period, body, callback)	Subscribe Audit Report	{base_path}/{version}/Scheduledreports/subscribe?{query}	Yes
getScopeList(subnetAddress, orgName, filterRules, draw, start, length, sort, order, serverType, callback)	Scope List	{base_path}/{version}/scope/list?{query}	Yes
createScope(body, callback)	Scope Create	{base_path}/{version}/scope/create?{query}	Yes
postScopeDelete(body, callback)	Scope Delete	{base_path}/{version}/scope/delete?{query}	Yes
getScopeValidateRequest(minAddr, maxAddr, organizationName, callback)	Scope Validation Request	{base_path}/{version}/scope/validate_request?{query}	Yes
getIPAMSearchResults(searchTerm, searchCategory, searchType, fieldName, fieldKey, orgId, orgName, callback)	Get IPAM Search details	{base_path}/{version}/search/getIPAMSearchResults?{query}	Yes
rebuildIndex(callback)	Rebuild Search Index	{base_path}/{version}/search/rebuildIndex?{query}	Yes
licenseCheck(callback)	Check Valid license	{base_path}/{version}/server_license/check?{query}	Yes
updateRemoteLicense(address, license, serverType, serverName, callback)	Remote license Update	{base_path}/{version}/server_license/update_remote?{query}	Yes
postServerLicenseAdd(body, callback)	License Add	{base_path}/{version}/server_license/add?{query}	Yes
getServerLicenseList(serverType, callback)	Server license List	{base_path}/{version}/server_license/list?{query}	Yes
getServerDebugSetting(serverType, address, debugPref, callback)	Server Debug Setting	{base_path}/{version}/server/debug-setting?{query}	Yes
getServerGetProcessorsCount(address, applianceType, callback)	Get number of Processors	{base_path}/{version}/server/getProcessorsCount?{query}	Yes
getConfigForClone(address, organization, callback)	Server Get Clone Configuration	{base_path}/{version}/server/getCloneConfiguration?{query}	Yes
getAllServerAddresses(serverType, callback)	DNS Server List	{base_path}/{version}/server/list?{query}	Yes
getIPDetails(address, organization, nicType, callback)	Object Details	{base_path}/{version}/server/getObjectDetailsForNIC?{query}	Yes
sameSubnetCheck(body, nicType, callback)	Check Objects	{base_path}/{version}/server/checkObjectsInSameSubnet?{query}	Yes
isDNSDHCP(address, callback)	DNS, DHCP and Both	{base_path}/{version}/server/isDNSDHCP?{query}	Yes
getDuplexSetting(device, nicType, address, applianceType, callback)	Get NIC duplex settings	{base_path}/{version}/server/getDuplexSettings?{query}	Yes
getRtTables(nicType, address, applianceType, callback)	Get Routing Tables	{base_path}/{version}/server/getRtTables?{query}	Yes
getRoutes(nicType, address, applianceType, callback)	Get Routes of Network	{base_path}/{version}/server/getRoutes?{query}	Yes
getAttachedNICs(nicType, address, applianceType, callback)	GET Attached Network Interfaces	{base_path}/{version}/server/getAttachedNics?{query}	Yes
dnsTunnelDetection(serverType, address, detect, callback)	Enable/Disable DNS Tunnel Detection	{base_path}/{version}/server/dnstunneldetection?{query}	Yes
getPatchHistory(address, applianceType, callback)	Get patch deployment history	{base_path}/{version}/server/getPatchHistory?{query}	Yes
syncNics(syncStatus, address, applianceType, callback)	Sync Network Interfaces	{base_path}/{version}/server/syncNics?{query}	Yes
changeRemoteNIC(syncStatus, appliance, callback)	Update the value of NIC from CLI	{base_path}/{version}/server/changeRemoteNIC?{query}	Yes
getServerGet(address, organization, callback)	Object Details	{base_path}/{version}/server/get?{query}	Yes
getServersyncGet(serverId, address, serverType, orgName, isV6, callback)	Appliance Sync Status GET	{base_path}/{version}/serversync/get?{query}	Yes
listO(organizationId, organizationName, callback)	Subnet Group Organization List	{base_path}/{version}/subnetgroup/listbyorg?{query}	Yes
subnetGroupPage(page, rows, callback)	Subnet Group Search	{base_path}/{version}/subnetgroup/search?{query}	Yes
searchSubnetGroupReferences(page, rows, tables, id, count, callback)	Subnet Group References	{base_path}/{version}/subnetgroup/references?{query}	Yes
getSubnetgroupListSubnets(subnetGrpId, subnetGrpName, orgName, draw, start, length, filterRules, sort, order, callback)	List Subnets present in the given Subnet Group	{base_path}/{version}/subnetgroup/listSubnets?{query}	Yes
postSubnetgroupDisassociate(fullAddress, orgName, callback)	Disassociate Subnet	{base_path}/{version}/subnetgroup/disassociate?{query}	Yes
getSubnetgroupGet(id, name, organization, callback)	Subnet Group Get	{base_path}/{version}/subnetgroup/get?{query}	Yes
postSubnetgroupUpdate(body, callback)	Subnet Group Edit	{base_path}/{version}/subnetgroup/update?{query}	Yes
postSubnetgroupDelete(body, callback)	Subnet Group Delete Multiple	{base_path}/{version}/subnetgroup/delete?{query}	Yes
postSubnetgroupAdd(body, callback)	Subnet Group Add	{base_path}/{version}/subnetgroup/add?{query}	Yes
postSubnetDelete(body, callback)	Subnet Statistics	{base_path}/{version}/subnet/delete?{query}	Yes
getSubnetPaged(networkAddress, orgName, draw, start, length, q, filterRules, sort, order, callback)	Subnet list page	{base_path}/{version}/subnet/paged?{query}	Yes
postSubnetEdit(body, callback)	Updating Subnet	{base_path}/{version}/subnet/edit?{query}	Yes
getSubnetData(orgName, objIp, subnetAddress, callback)	Subnet Details	{base_path}/{version}/subnet/getSubnetData?{query}	Yes
postSubnetAdd(body, callback)	Subnet Add	{base_path}/{version}/subnet/add?{query}	Yes
getSubnetSearch(draw, start, length, filterRules, sort, order, callback)	Subnet Search	{base_path}/{version}/subnet/search?{query}	Yes
routerList(subnetAddress, orgName, callback)	Router Details	{base_path}/{version}/subnet/routers?{query}	Yes
createAll(body, callback)	Subnet Add All	{base_path}/{version}/subnet/addall?{query}	Yes
getSubnetIpAddressOrganizationName(address, organizationName, callback)	Get Subnet	{base_path}/{version}/subnet/ip/{pathv1}/{pathv2}?{query}	Yes
getSubnetActiveLeases(page, rows, serverAddress, subnetAddress, organizationName, dhcpType, callback)	Active Leases List	{base_path}/{version}/subnet/activeLeases?{query}	Yes
getSubnetGetSubnetDetails(subnetId, subnetAddress, orgName, callback)	Subnet Details	{base_path}/{version}/subnet/getSubnetDetails?{query}	Yes
postSubnetMultiadd(body, callback)	Subnet Add Multiple	{base_path}/{version}/subnet/multiadd?{query}	Yes
getSubnetStats(id, address, callback)	Subnet Stats	{base_path}/{version}/subnet/stats?{query}	Yes
listInRange(networkIp, startSubnet, endSubnet, organizationName, callback)	Subnet Range List	{base_path}/{version}/subnet/listinrange?{query}	Yes
exMerge(body, callback)	Subnet Merge	{base_path}/{version}/subnet/merge?{query}	Yes
searchSubnetReferences(page, rows, tables, id, count, callback)	Get Subnet References	{base_path}/{version}/subnet/references?{query}	Yes
listFreeSubnets(ipAddress, organizationName, callback)	Free Subnet List	{base_path}/{version}/subnet/listFreeSubnets?{query}	Yes
getViewsAssociated(id, subnetAddress, organizationName, callback)	Subnet Details	{base_path}/{version}/subnet/getViewsAssociated?{query}	Yes
getSubnetGet(subnetId, address, organizationName, callback)	Subnet Details	{base_path}/{version}/subnet/get?{query}	Yes
split(body, callback)	Subnet Split	{base_path}/{version}/subnet/split?{query}	Yes
getSubnetTemplateSearch(draw, start, length, filterRules, sort, order, callback)	List Subnet Template Search elements	{base_path}/{version}/subnet_template/search?{query}	Yes
getSubnetTemplateDetails(name, orgName, callback)	Subnet Template Get	{base_path}/{version}/subnet_template/details?{query}	Yes
getSubnetTemplatePListbyorg(orgId, draw, start, length, orgName, q, inSubnetEdit, filterRules, sort, order, callback)	Subnet Template List By Organization	{base_path}/{version}/subnet_template/p_listbyorg?{query}	Yes
postSubnetTemplateEdit(body, callback)	Update Subnet Template	{base_path}/{version}/subnet_template/edit?{query}	Yes
getSubnetTemplateList(callback)	Subnet Template List	{base_path}/{version}/subnet_template/list?{query}	Yes
postSubnetTemplateDelete(name, orgName, callback)	Subnet Template Delete	{base_path}/{version}/subnet_template/delete?{query}	Yes
postSubnetTemplateAdd(body, callback)	Subnet Template Add	{base_path}/{version}/subnet_template/add?{query}	Yes
switchPage(draw, start, length, q, filterRules, sort, order, callback)	Switch Details	{base_path}/{version}/switchdisco/switchpage?{query}	Yes
vlanPage(draw, start, length, q, filterRules, sort, order, switchIP, callback)	Vlan Details	{base_path}/{version}/switchdisco/vlanpage?{query}	Yes
interfacePage(draw, start, length, q, filterRules, sort, order, switchIP, callback)	Interface Details	{base_path}/{version}/switchdisco/interfacepage?{query}	Yes
elementPage(draw, start, length, q, filterRules, sort, order, switchIP, callback)	Element Details	{base_path}/{version}/switchdisco/elementpage?{query}	Yes
getSwitch(switchIP, callback)	Switch Details	{base_path}/{version}/switchdisco/switchdetails?{query}	Yes
deleteSwitches(body, callback)	Deletes switch results	{base_path}/{version}/switchdisco/deleteSwitches?{query}	Yes
zoneTemplateParams(templateName, organizationId, organizationName, callback)	Zone Template Parameter List	{base_path}/{version}/templates/zoneparams?{query}	Yes
dnsTemplateParams(templateId, templateName, entityTypeCode, serverTypeCode, organizationId, organizationName, callback)	Option Template DNS Params List	{base_path}/{version}/templates/list/dnsparams?{query}	Yes
serversList(organizationId, callback)	Template List DNS Appliances	{base_path}/{version}/templates/listdnsservers?{query}	Yes
nsdTemplateParams(templateId, templateName, entityTypeCode, serverTypeCode, organizationId, organizationName, callback)	Option Template NSD Params List	{base_path}/{version}/templates/list/nsdparams?{query}	Yes
dataTypeList(datatypeFlag, callback)	Template List Data Types	{base_path}/{version}/templates/list-datatypes?{query}	Yes
getTemplatesListServerTypeCodeEntityTypeCode(serverTypeCode, entityTypeCode, referenceType, referenceId, q, filterRules, draw, start, length, callback)	Template List	{base_path}/{version}/templates/list/{pathv1}/{pathv2}?{query}	Yes
getTemplatesPageServerTypeCodeEntityTypeCode(serverTypeCode, entityTypeCode, referenceType, referenceId, q, filterRules, inEdit, draw, start, length, organizationName, callback)	Template Page	{base_path}/{version}/templates/page/{pathv1}/{pathv2}?{query}	Yes
dnsTemplateList(entityTypeCode, organizationId, organizationName, inEdit, callback)	DNS Template List	{base_path}/{version}/templates/dnstemplatelist?{query}	Yes
dhcpParamsList(serverType, entityType, callback)	DHCP Options Template List Params	{base_path}/{version}/templates/list/params/{pathv1}/{pathv2}?{query}	Yes
templateParamsListAllById(templateId, templateName, serverType, entityType, organizationName, callback)	Template List all params	{base_path}/{version}/templates/list-all/params?{query}	Yes
listCustomDefinedParams(templateId, templateName, callback)	User Defined DHCP Options List	{base_path}/{version}/templates/list-custom-defined-params?{query}	Yes
templateParamsListByName(templateName, callback)	Template Params List By Name	{base_path}/{version}/templates/list/paramsbyname/{pathv1}?{query}	Yes
dnsTemplateInfo(templateId, templateName, entityTypeCode, serverTypeCode, organizationId, organizationName, callback)	Option Template DNS Params List	{base_path}/{version}/templates/list/dnsTemplateInfo?{query}	Yes
nsdTemplateParamsInfo(templateId, templateName, entityTypeCode, serverTypeCode, organizationId, organizationName, callback)	Option Template NSD Params List	{base_path}/{version}/templates/list/nsdparamsinfo?{query}	Yes
templateCreate(body, callback)	Template Create	{base_path}/{version}/templates/create?{query}	Yes
templateUpdate(body, callback)	Zone Template Update	{base_path}/{version}/templates/update?{query}	Yes
policyTemplateUpdate(body, callback)	DHCP Policy Template Update	{base_path}/{version}/templates/dhcp-policy-template-update?{query}	Yes
templateDHCPUpdate(body, callback)	DHCP Option Template Update	{base_path}/{version}/templates/dhcp-option-template-update?{query}	Yes
templateDeleteByIds(body, callback)	Delete DHCP Option and Policy Templates	{base_path}/{version}/templates/delete/dhcpTmpl?{query}	Yes
templateDeleteByNames(body, callback)	Zone Template Delete	{base_path}/{version}/templates/delete/names?{query}	Yes
getZoneTemplateDetails(templateName, organizationId, organizationName, callback)	Zone Template Parameter List	{base_path}/{version}/templates/getZoneTemplateDetails?{query}	Yes
dhcpTemplateCreate(body, callback)	Add DHCP Option and Policy Templates	{base_path}/{version}/templates/dhcp-template-create?{query}	Yes
templatePage(draw, start, length, filterRules, sort, order, callback)	Template Search	{base_path}/{version}/templates/search?{query}	Yes
paramSearch(draw, start, length, filterRules, sort, order, callback)	Template Search	{base_path}/{version}/templates/params-name/search?{query}	Yes
paramValueSearch(draw, start, length, filterRules, sort, order, callback)	Template Search	{base_path}/{version}/templates/params-value/search?{query}	Yes
searchZoneTemplateReferences(page, rows, tables, id, count, callback)	Find DHCP Option Template References	{base_path}/{version}/templates/references?{query}	Yes
listSubOptions(templateId, templateName, callback)	DHCP Sub Options List	{base_path}/{version}/templates/list-template-option-spaces?{query}	Yes
getTimeZone(callback)	Time Zone of the Server	{base_path}/{version}/timezone/getTimeZone?{query}	Yes
getTimezoneList(callback)	Get list of all Time Zones	{base_path}/{version}/timezone/list?{query}	Yes
purge(body, callback)	UndoData Purge	{base_path}/{version}/undo/purge?{query}	Yes
postUndoPurgeAll(callback)	UndoData Purge	{base_path}/{version}/undo/purgeAll?{query}	Yes
getUndoList(draw, start, length, q, filterRules, sort, order, callback)	UndoData List	{base_path}/{version}/undo/list?{query}	Yes
postUndoRestore(body, callback)	UndoData Restore	{base_path}/{version}/undo/restore?{query}	Yes
getUser(serialNum, callback)	Get User ID	{base_path}/{version}/user_cert/get_user?{query}	Yes
getUserCertList(callback)	User Cert List	{base_path}/{version}/user_cert/list?{query}	Yes
postUserCertImport(cfile, user, callback)	User Cert Import	{base_path}/{version}/user_cert/import?{query}	Yes
getUsers(callback)	User List	{base_path}/{version}/user_cert/userlist?{query}	Yes
postUserCertDelete(body, callback)	User Cert Delete	{base_path}/{version}/user_cert/delete?{query}	Yes
postUserEdit(body, callback)	Admin Update	{base_path}/{version}/user/edit?{query}	Yes
searchAdminReferences(page, rows, tables, id, count, callback)	Lists Admin References	{base_path}/{version}/user/references?{query}	Yes
sessionUser(callback)	Session User Information	{base_path}/{version}/user/session_user?{query}	Yes
delLogin(loginName, callback)	Admin Delete	{base_path}/{version}/user/deleteLogin?{query}	Yes
getChangeTicket(callback)	Get Change Ticket	{base_path}/{version}/user/change_ticket?{query}	Yes
postUserChangeTicket(body, callback)	Update Change Ticket	{base_path}/{version}/user/change_ticket?{query}	Yes
getInternalUser(callback)	Internal User Information	{base_path}/{version}/user/getInternalUser?{query}	Yes
userPage(page, rows, orgId, orgName, callback)	Searches User Page	{base_path}/{version}/user/search?{query}	Yes
expandedPermissions(userId, loginName, callback)	User Permission List	{base_path}/{version}/user/permexpndlist?{query}	Yes
listPermissions(callback)	Permission List.	{base_path}/{version}/user/listpermission?{query}	Yes
getUserGet(id, firstName, middleName, lastName, emailId, callback)	Admin Details	{base_path}/{version}/user/get?{query}	Yes
clone(userId, cfirstName, cmiddleName, clastName, cemailId, body, callback)	Admin Clone	{base_path}/{version}/user/clone?{query}	Yes
getUserPage(orgId, orgName, grpId, grpName, draw, start, length, q, filterRules, sort, order, callback)	Admin List Page	{base_path}/{version}/user/page?{query}	Yes
getUserList(orgId, orgName, grpId, grpName, callback)	Admin List	{base_path}/{version}/user/list?{query}	Yes
permissions(userId, loginName, callback)	Admin List Permissions	{base_path}/{version}/user/permlist?{query}	Yes
postUserAdd(body, callback)	Admin Add	{base_path}/{version}/user/add?{query}	Yes
postV6auditreportsCsvreport(body, action, callback)	CSV Report	{base_path}/{version}/v6auditreports/csvreport?{query}	Yes
postV6auditreportsPdfreport(body, callback)	PDF Report	{base_path}/{version}/v6auditreports/pdfreport?{query}	Yes
postV6auditreportsEmailreport(body, callback)	Email Report	{base_path}/{version}/v6auditreports/emailreport?{query}	Yes
postV6auditreportsSchedEmailreport(body, repeat, frequency, runtime, starttime, endtime, day, description, repeatInterval, repeatCount, adminName, adminRole, callback)	Schedule Report Email	{base_path}/{version}/v6auditreports/sched_emailreport?{query}	Yes
getV6auditreportsV6networkslist(actionType, orgId, page, rows, q, callback)	IPv6 Network List	{base_path}/{version}/v6auditreports/v6networkslist?{query}	Yes
getMonitReportRecordsForGrid(reportType, fromDate, toDate, ipAddressDomainName, orgId, organization, draw, start, length, filterRules, action, sort, order, callback)	IPv6 Audit	{base_path}/{version}/v6auditreports/reportlist?{query}	Yes
getAuditSubnetGrpList(orgId, page, rows, q, callback)	IPv6 Subnet Group List (Audit Report)	{base_path}/{version}/v6auditreports/v6subnetgrplist?{query}	Yes
getIPv6NetworkList(callback)	IPv6 Network List (Audit Report)	{base_path}/{version}/v6auditreports/ipv6Network?{query}	Yes
getIPv6SubnetList(callback)	IPv6 Subnet List (Audit Report)	{base_path}/{version}/v6auditreports/ipv6Subnet?{query}	Yes
listForServer(organizationId, organizationName, serverId, serverIp, callback)	View List For Server	{base_path}/{version}/view/listforserver?{query}	Yes
postViewEdit(body, callback)	View Edit	{base_path}/{version}/view/edit?{query}	Yes
listViewsForZone(organizationId, organizationName, zoneName, callback)	View List for Zone	{base_path}/{version}/view/listforzone?{query}	Yes
listForZoneTemplate(organizationId, organizationName, templateId, templateName, callback)	View List For Zone Template	{base_path}/{version}/view/listforzonetemplate?{query}	Yes
checkViewListAssociatedWithTemplate(organizationId, organizationName, templateId, templateName, callback)	View List Associated with template	{base_path}/{version}/view/listassociatedwithtemplate?{query}	Yes
listForZone(viewId, viewName, organizationId, callback)	Zone List for View	{base_path}/{version}/view/zonelistforview?{query}	Yes
listcountries(callback)	Countries List	{base_path}/{version}/view/countries?{query}	Yes
getViewGet(organizationId, organizationName, viewId, viewName, callback)	View Get	{base_path}/{version}/view/get?{query}	Yes
getViewList(organizationId, organizationName, applyOrg, callback)	View List	{base_path}/{version}/view/list?{query}	Yes
postViewDelete(organizationId, organizationName, body, callback)	View Delete	{base_path}/{version}/view/delete?{query}	Yes
postViewCreate(body, callback)	View Create	{base_path}/{version}/view/create?{query}	Yes
updateWidgetStatus(widgetName, status, callback)	Network Statistics	{base_path}/{version}/widget/update?{query}	Yes
getWidgetList(category, callback)	Network Statistics	{base_path}/{version}/widget/list?{query}	Yes
postWsdhcpserverDelete(address, callback)	Microsoft DHCP Appliance Delete	{base_path}/{version}/wsdhcpserver/delete?{query}	Yes
getWsdhcpserverPage(organizationName, draw, start, length, filterRules, q, sort, order, callback)	Microsoft DHCP Appliance List	{base_path}/{version}/wsdhcpserver/page?{query}	Yes
getWsdhcpserverDhcpActiveLeases(serverIp, organizationName, callback)	Get DHCP Appliances Active Leases	{base_path}/{version}/wsdhcpserver/dhcpActiveLeases?{query}	Yes
restartDHCPService(serverIp, orgName, callback)	Restart DHCP service on Microsoft DHCP Appliance	{base_path}/{version}/wsdhcpserver/restartService?{query}	Yes
syncConfig(address, organizationName, callback)	Generate appliance Configuration for sync	{base_path}/{version}/wsdhcpserver/syncConfig?{query}	Yes
listServers(orgName, callback)	Microsoft DHCP appliance list	{base_path}/{version}/wsdhcpserver/list?{query}	Yes
getApplianceDetails(ip, orgname, callback)	Get Appliance Configuration	{base_path}/{version}/wsdhcpserver/getdetails?{query}	Yes
updateDHCPappliance(body, callback)	Microsoft DHCP Appliance Update	{base_path}/{version}/wsdhcpserver/update?{query}	Yes
postWsdhcpserverAdd(body, callback)	Microsoft DHCP Appliance Add	{base_path}/{version}/wsdhcpserver/add?{query}	Yes
serverList(draw, start, length, filterRules, sort, order, callback)	The Microsoft DNS Appliance List	{base_path}/{version}/windowsdns/page?{query}	Yes
getWindowsdnsSearch(page, rows, callback)	Appliance Search	{base_path}/{version}/windowsdns/search?{query}	Yes
syncServer(ip, orgname, orgid, callback)	Server Configuration	{base_path}/{version}/windowsdns/sync?{query}	Yes
getAssociatedMicrosoftAppliance(templateName, orgname, callback)	Server Configuration	{base_path}/{version}/windowsdns/getassociatedmicrosoftappliances?{query}	Yes
getapplianceDetailsByOrg(orgName, orgId, callback)	Server Configuration	{base_path}/{version}/windowsdns/getdetailsbyorg?{query}	Yes
getWindowsdnsReferences(page, rows, tables, id, count, callback)	Microsoft Appliance References In Zones	{base_path}/{version}/windowsdns/references?{query}	Yes
createServer(body, callback)	Add Microsoft DNS Appliance	{base_path}/{version}/windowsdns/add?{query}	Yes
getapplianceDetails(ip, orgname, callback)	Server Configuration	{base_path}/{version}/windowsdns/getdetails?{query}	Yes
editServer(body, callback)	The Microsoft DNS appliance Edit	{base_path}/{version}/windowsdns/edit?{query}	Yes
deleteServer(ip, callback)	The Microsoft DNS appliance delete	{base_path}/{version}/windowsdns/delete?{query}	Yes
pingServer(body, callback)	The Microsoft DNS appliance ping and port availability check	{base_path}/{version}/windowsdns/pingPortCheck?{query}	Yes
modifyWorkflow(body, callback)	modifyWorkflow	{base_path}/{version}/workflow/modify?{query}	Yes
deleteWorkFlow(body, callback)	deleteWorkFlow	{base_path}/{version}/workflow/delete?{query}	Yes
getWorkFlowProfile(id, callback)	getWorkFlowProfile	{base_path}/{version}/workflow/profile?{query}	Yes
getWorkFlows(callback)	getWorkFlows	{base_path}/{version}/workflow/listrows?{query}	Yes
stageWorkflow(body, callback)	stageWorkflow	{base_path}/{version}/workflow/add?{query}	Yes
getZone(body, callback)	Zone Get	{base_path}/{version}/zone/getZone?{query}	Yes
postZoneMultidelete(body, callback)	Zone Delete Multiple	{base_path}/{version}/zone/multidelete?{query}	Yes
getZoneForcesynczones(zoneOrgNames, callback)	Zone Force Sync	{base_path}/{version}/zone/forcesynczones?{query}	Yes
getZoneSearch(page, rows, callback)	Zone Search	{base_path}/{version}/zone/search?{query}	Yes
getZoneGetZoneRRDataExpandViewOwnerName(ownerName, callback)	Zone RR Expand View	{base_path}/{version}/zone/getZoneRRDataExpandView/{pathv1}?{query}	Yes
getZoneListServers(type, name, organization, callback)	List Appliances	{base_path}/{version}/zone/list-servers?{query}	Yes
getZoneList(revZone, callback)	Zone List	{base_path}/{version}/zone/list?{query}	Yes
dnssecEnabledZoneList(orgName, callback)	Zone List	{base_path}/{version}/zone/dnssec_enabled_list?{query}	Yes
zonePageList(draw, start, length, filterRules, sort, order, callback)	Zone List	{base_path}/{version}/zone/page?{query}	Yes
postZoneMonitoring(body, callback)	Zone Monitoring Update	{base_path}/{version}/zone/monitoring?{query}	Yes
rootZoneList(callback)	Root Zone List	{base_path}/{version}/zone/root/list?{query}	Yes
rootZoneSearch(page, rows, callback)	Root Zone Search	{base_path}/{version}/zone/rootzone/search?{query}	Yes
proxyRootZoneList(callback)	Proxy Root Zone List	{base_path}/{version}/zone/proxyroot/list?{query}	Yes
proxyRootZoneSearchList(page, rows, callback)	Proxy Root Zone Search List	{base_path}/{version}/zone/proxyroot/search?{query}	Yes
createRootZone(body, callback)	Root Zone Add	{base_path}/{version}/zone/root/add?{query}	Yes
createProxyRootZone(body, callback)	Proxy Root Zone Add	{base_path}/{version}/zone/proxyroot/add?{query}	Yes
rootZoneMultiDelete(body, callback)	Root Zone Multiple Delete	{base_path}/{version}/zone/root/multidelete?{query}	Yes
rootProxyZoneMultiDelete(body, callback)	Proxy Root Zone Multiple Delete	{base_path}/{version}/zone/proxyroot/multidelete?{query}	Yes
updateRootZone(body, callback)	Root Zone Edit	{base_path}/{version}/zone/root/update?{query}	Yes
updateProxyRootZone(body, callback)	Proxy Root Zone Edit	{base_path}/{version}/zone/proxyroot/update?{query}	Yes
checkACNAMEconflict(ownerName, orgId, orgName, recordType, callback)	Zone Resource Record Check CNAME Conflict	{base_path}/{version}/zone/rr/checkACNAMEconflict?{query}	Yes
checkRROrphan(ownerName, orgId, orgName, recordType, externalRR, callback)	Zone Resource Record Check Orphan	{base_path}/{version}/zone/rr/checkRROrphan?{query}	Yes
rrPage(draw, start, length, filterRules, sort, order, callback)	Zone Resource Record Search	{base_path}/{version}/zone/search/rr?{query}	Yes
getZoneReferences(page, rows, tables, id, count, callback)	Lists Zone References	{base_path}/{version}/zone/references?{query}	Yes
getZoneReferencesRr(page, rows, tables, id, count, callback)	Find Zone Resource Record References	{base_path}/{version}/zone/references/rr?{query}	Yes
getZoneStatus(zoneName, orgName, callback)	Zone Status	{base_path}/{version}/zone/zoneStatus?{query}	Yes
getCommandResultForZone(zoneName, orgName, argc, callback)	Zone Command	{base_path}/{version}/zone/subsys?{query}	Yes
zoneListForServerView(serverId, serverIp, viewId, viewName, callback)	Zone List For Appliance View	{base_path}/{version}/zone/listforserverview?{query}	Yes
checkNSRecordInProxyServer(owner, data, orgName, callback)	Check NS Record In Proxy Root Zone	{base_path}/{version}/zone/check_ns_in_proxy?{query}	Yes
checkNSRecordInRootServer(owner, orgName, callback)	Zone Check NS Record In Root Zone	{base_path}/{version}/zone/check_ns_in_root?{query}	Yes
checkARecordExists(owner, callback)	Verification of A Resource Record	{base_path}/{version}/zone/check_for_A_RR?{query}	Yes
checkAAAARecordExists(owner, callback)	Verification of AAAA Resource Record	{base_path}/{version}/zone/check_for_AAAA_RR?{query}	Yes
checkMXRecordExists(owner, callback)	Verification of MX Resource Record	{base_path}/{version}/zone/check_for_MX_RR?{query}	Yes
checkRRIsRtdZOne(owner, zoneName, orgId, orgName, callback)	Check RR is Restricted Zone	{base_path}/{version}/zone/check_RR_is_rtd_zone?{query}	Yes
getResultForIsZoneFrozen(zoneName, orgName, callback)	Zone is Frozen or not	{base_path}/{version}/zone/isFrozen?{query}	Yes
getZoneTTLValue(domainName, orgName, callback)	Get Zone ttl	{base_path}/{version}/zone/getZoneTTL?{query}	Yes
getManagedDomainList(orgId, draw, start, length, orgName, q, inSubnetEdit, filterRules, sort, order, callback)	Managed Domains List By Organization	{base_path}/{version}/zone/managedDomainListbyorg?{query}	Yes
getDSRecords(orgId, orgName, id, name, callback)	Get DS(Delegation Signer) record for the Managed Zone	{base_path}/{version}/zone/getDSRecord?{query}	Yes
getDNSSECInfo(orgId, orgName, id, name, isKsk, callback)	Get DNSSEC Keys information for the Managed DNS Zone	{base_path}/{version}/zone/getDNSSECInfo?{query}	Yes
manualKeyRollover(orgId, orgName, id, name, isKsk, callback)	Manual Key Rollover for the Managed DNS Zone.	{base_path}/{version}/zone/manualKeyRollover?{query}	Yes
getZoneObjectARRList(orgId, orgName, id, name, start, length, filterRules, sort, order, callback)	Gets all the A records for a given zone in a given organization.	{base_path}/{version}/zone/getAllARecords?{query}	Yes
addDC(body, callback)	Add Domain Controllers	{base_path}/{version}/zone/addDC?{query}	Yes
deleteDC(body, callback)	Delete domain controllers	{base_path}/{version}/zone/deleteDC?{query}	Yes
checkDuplicateZoneRRName(name, domainName, orgName, callback)	Object Duplicate Name Checker	{base_path}/{version}/zone/checkDuplicateZoneRRName?{query}	Yes
zoneListByOrg(orgName, callback)	Zone List By Organization	{base_path}/{version}/zone/getzonelistbyorg?{query}	Yes
aliasResourceRecordsList(zonename, orgname, callback)	Zone List	{base_path}/{version}/zone/aliasRRslist?{query}	Yes
syncZoneWithCloud(zonename, orgname, syncType, cloudProviderType, callback)	Sync Zone with cloud	{base_path}/{version}/zone/synczonewithcloud?{query}	Yes
getGeoLocations(orgname, callback)	Geo Locations List	{base_path}/{version}/zone/geolocations?{query}	Yes
getHealthChecks(orgname, callback)	Health Check ids List	{base_path}/{version}/zone/healthchecks?{query}	Yes
importAliasResourceRecords(zonename, orgname, importType, callback)	importAliasResourceRecords	{base_path}/{version}/zone/importaliasrecords?{query}	Yes
getZoneData(domainName, orgName, callback)	Zone Get Data	{base_path}/{version}/zone/getZoneData?{query}	Yes
getZoneGet(zoneID, domainName, orgName, isProxy, callback)	Get RR List	{base_path}/{version}/zone/get?{query}	Yes
getZoneGetProxyRR(zoneID, domainName, orgID, orgName, isProxy, callback)	Get Proxy Root Zone RR List	{base_path}/{version}/zone/getProxyRR?{query}	Yes
postZoneClone(existingZone, newZone, orgName, callback)	Zone Clone	{base_path}/{version}/zone/clone?{query}	Yes
postZoneUpdate(body, callback)	Zone Edit	{base_path}/{version}/zone/update?{query}	Yes
postZoneRrEdit(existingOwner, existingData, body, callback)	Zone Resource Record Add	{base_path}/{version}/zone/rr/edit?{query}	Yes
postZoneRrDelete(body, callback)	Zone Resource Record Delete	{base_path}/{version}/zone/rr/delete?{query}	Yes
getZoneDeleteZoneName(zoneName, callback)	Zone Delete	{base_path}/{version}/zone/delete/{pathv1}?{query}	Yes
postZoneRrAdd(body, callback)	Zone Resource Record Add	{base_path}/{version}/zone/rr/add?{query}	Yes
postZoneAdd(body, callback)	Zone Add	{base_path}/{version}/zone/add?{query}	Yes
getCloudNetworkGetNextAvailableNetwork(cloudProviderName, organizationName, mask, callback)	Gets Next Available Network Address	{base_path}/{version}/cloudNetwork/getNextAvailableNetwork?{query}	Yes
createNetwork(body, callback)	Create Network in Cloud	{base_path}/{version}/cloudNetwork/createNetwork?{query}	Yes
deleteNetwork(body, callback)	Delete Network in Cloud	{base_path}/{version}/cloudNetwork/deleteNetwork?{query}	Yes
getNextAvailableSubnet(cloudProviderName, organizationName, mask, vpcId, networkAddress, callback)	Gets Next Available Network Address	{base_path}/{version}/cloudSubnet/getNextAvailableSubnet?{query}	Yes
createSubnet(body, callback)	Create Subnet in Cloud	{base_path}/{version}/cloudSubnet/createSubnet?{query}	Yes
deleteSubnet(body, callback)	Delete Subnet in Cloud	{base_path}/{version}/cloudSubnet/deleteSubnet?{query}	Yes
discover(all, body, callback)	Discover cloud hosted subnets	{base_path}/{version}/cloudSubnet/discover?{query}	Yes
getDiscoveryCommands(callback)	Discovery commands	{base_path}/{version}/cloudSubnet/discovery/getCmds?{query}	Yes
getDiscoveryCommandStatus(cmdId, callback)	Discovery command	{base_path}/{version}/cloudSubnet/discovery/getCmdStatus?{query}	Yes
discardCmds(body, callback)	Discard discovery results	{base_path}/{version}/cloudSubnet/discovery/discardCmds?{query}	Yes
getDiscoveredSubnets(cmdId, callback)	Discovered cloud subnet list	{base_path}/{version}/cloudSubnet/getDiscoveredSubnets?{query}	Yes
importDiscoverdSubnets(cmdId, body, callback)	Create the discovered cloud subnets	{base_path}/{version}/cloudSubnet/createDiscoverdSubnets?{query}	Yes
getVmwareAuthtypelist(callback)	getCloudAttributeNames	{base_path}/{version}/vmware/authtypelist?{query}	Yes
getAuthSource(objectId, ipType, callback)	getAuthSource	{base_path}/{version}/vmware/authsource?{query}	Yes
getV6subnetTemplateDetails(name, orgName, callback)	IPv6 Subnet Template Get	{base_path}/{version}/v6subnet_template/details?{query}	Yes
getV6subnetTemplatePListbyorg(orgId, draw, start, length, orgName, q, inSubnetEdit, filterRules, sort, order, callback)	IPv6 Subnet Template List By Organization	{base_path}/{version}/v6subnet_template/p_listbyorg?{query}	Yes
postV6subnetTemplateEdit(body, callback)	Update IPv6 Subnet Template	{base_path}/{version}/v6subnet_template/edit?{query}	Yes
getV6subnetTemplateList(callback)	IPv6 Subnet Template List	{base_path}/{version}/v6subnet_template/list?{query}	Yes
postV6subnetTemplateDelete(name, orgName, callback)	IPv6 Subnet Template Delete	{base_path}/{version}/v6subnet_template/delete?{query}	Yes
postV6subnetTemplateAdd(body, callback)	IPv6 Subnet Template Add	{base_path}/{version}/v6subnet_template/add?{query}	Yes

Authentication

This document will go through the steps for authenticating the TCPWave adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Basic Authentication

The TCPWave adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.

STEPS

1. Ensure you have access to a TCPWave server and that it is running
2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
3. Use the properties below for the properties.authentication field

   "authentication": {
   "auth_method": "basic user_password",
   "username": "<username>",
   "password": "<password>",
   "token": "",
   "token_timeout": 1800000,
   "token_cache": "local",
   "invalid_token_error": 401,
   "auth_field": "header.headers.Authorization",
   "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
   "auth_logging": false,
   "client_id": "",
   "client_secret": "",
   "grant_type": ""
   }

4. Restart the adapter. If your properties were set correctly, the adapter should go online.

Troubleshooting

• Make sure you copied over the correct username and password.
• Turn on debug level logs for the adapter in IAP Admin Essentials.
• Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
• Investigate the logs - in particular:
  • The FULL REQUEST log to make sure the proper headers are being sent with the request.
  • The FULL BODY log to make sure the payload is accurate.
  • The CALL RETURN log to see what the other system is telling us.
• Remember when you are done to turn auth_logging off as you do not want to log credentials.

Additional Information

Enhancements

Adding a Second Instance of an Adapter

You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.

Adding Adapter Calls

There are multiple ways to add calls to an existing adapter.

The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update.

mv updatePackage.zip adapter-tcpwave
cd adapter-tcpwave
npm run adapter:update

If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.

If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.

Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test

Adding Adapter Properties

While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.

Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Changing Adapter Authentication

Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.

Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Enhancing Adapter Integration Tests

The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.

Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.

As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.

Contributing

First off, thanks for taking the time to contribute!

The following is a set of rules for contributing.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.

How to Contribute

Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

Helpful Links

Adapter Technical Resources

Node Scripts

There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.

Run	Description
npm run adapter:install	Provides an easier way to install the adapter.
npm run adapter:checkMigrate	Checks whether your adapter can and should be migrated to the latest foundation.
npm run adapter:findPath	Can be used to see if the adapter supports a particular API call.
npm run adapter:migrate	Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.
npm run adapter:update	Provides an easier way to update your adapter after you download the update zip from Itential DevSite.
npm run adapter:revert	Allows you to revert after a migration or update if it resulted in issues.
npm run troubleshoot	Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.
npm run connectivity	Provides a connectivity check to the Servicenow system.
npm run healthcheck	Checks whether the configured healthcheck call works to Servicenow.
npm run basicget	Checks whether the basic get calls works to Servicenow.

Troubleshoot

Run npm run troubleshoot to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.

You also have the option to run individual commands to perform specific test:

• npm run healthcheck will perform a healthcheck request of with current setting.
• npm run basicget will perform some non-parameter GET request with current setting.
• npm run connectivity will perform networking diagnostics of the adatper endpoint.

Connectivity Issues

1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.

npm run troubleshoot

2. Verify the adapter properties are set up correctly.

Go into the Itential Platform GUI and verify/update the properties

3. Verify there is connectivity between the Itential Platform Server and Tcpwave Server.

ping the ip address of Tcpwave server
try telnet to the ip address port of Tcpwave
execute a curl command to the other system

4. Verify the credentials provided for Tcpwave.

login to Tcpwave using the provided credentials

5. Verify the API of the call utilized for Tcpwave Healthcheck.

Go into the Itential Platform GUI and verify/update the properties

Functional Issues

Adapter logs are located in /var/log/pronghorn. In older releases of the Itential Platform, there is a pronghorn.log file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.