@itentialopensource/adapter-infoblox/pronghorn.json

Itential Infoblox Adapter

{
  "id": "@itentialopensource/adapter-infoblox",
  "title": "Infoblox",
  "type": "Adapter",
  "export": "Infoblox",
  "src": "adapter.js",
  "roles": [
    "admin",
    "pronghorn_admin"
  ],
  "methods": [
    {
      "name": "iapUpdateAdapterConfiguration",
      "summary": "Updates the adapter configuration",
      "description": "Updates the adapter configuration file with the provided changes",
      "input": [
        {
          "name": "configFile",
          "type": "string",
          "info": "The name of the file to change",
          "required": true,
          "schema": {
            "title": "configFile",
            "type": "string"
          }
        },
        {
          "name": "changes",
          "type": "object",
          "info": "JSON object containing the configuration changes",
          "required": true,
          "schema": {
            "title": "changes",
            "type": "object"
          }
        },
        {
          "name": "entity",
          "type": "string",
          "info": "The entity in which the changes are being made",
          "required": false,
          "schema": {
            "title": "entity",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "The type of file to change - action, schema, or mock",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "action",
          "type": "string",
          "info": "The action to be changed",
          "required": false,
          "schema": {
            "title": "action",
            "type": "string"
          }
        },
        {
          "name": "replace",
          "type": "boolean",
          "info": "True to replace entire mock data, false to merge/append",
          "required": false,
          "schema": {
            "title": "replace",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUpdateAdapterConfiguration"
      },
      "task": true
    },
    {
      "name": "iapSuspendAdapter",
      "summary": "Suspends the adapter",
      "description": "Suspends the adapter",
      "input": [
        {
          "name": "mode",
          "type": "enum",
          "enumerals": [
            "pause",
            "error"
          ],
          "info": "How incoming requests are handled. Defaults to 'pause'",
          "description": "How incoming requests are handled. Defaults to 'pause'",
          "schema": {
            "title": "mode",
            "type": "string"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapSuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapUnsuspendAdapter",
      "summary": "Unsuspends the adapter",
      "description": "Unsuspends the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUnsuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterQueue",
      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
      "description": "Return the requests that are waiting in the queue if throttling is enabled",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter queue",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetAdapterQueue"
      },
      "task": true
    },
    {
      "name": "iapFindAdapterPath",
      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
      "description": "Provides the ability to see if a particular API path is supported by the adapter",
      "input": [
        {
          "name": "apiPath",
          "type": "string",
          "info": "The API Path you want to check - make sure to not include base path and version",
          "description": "The API Path you want to check - make sure to not include base path and version",
          "schema": {
            "title": "apiPath",
            "type": "string"
          },
          "required": true
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapFindAdapterPath"
      },
      "task": true
    },
    {
      "name": "iapTroubleshootAdapter",
      "summary": "Runs troubleshoot script for adapter",
      "description": "Runs troubleshoot script for adapter",
      "input": [
        {
          "name": "props",
          "type": "object",
          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
          "required": true,
          "schema": {
            "title": "props",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapTroubleshootAdapter"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterHealthcheck",
      "summary": "Runs healthcheck script for adapter",
      "description": "Runs healthcheck script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "Whether healthcheck passed or failed",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterHealthcheck"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterConnectivity",
      "summary": "Runs connectivity check script for adapter",
      "description": "Runs connectivity check script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterConnectivity"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterBasicGet",
      "summary": "Runs basicGet script for adapter",
      "description": "Runs basicGet script for adapter",
      "input": [
        {
          "name": "maxCalls",
          "required": false,
          "type": "number",
          "info": "How many GET endpoints to test (defaults to 5)",
          "schema": {
            "title": "maxCalls",
            "type": "number",
            "default": 5
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterBasicGet"
      },
      "task": true
    },
    {
      "name": "iapMoveAdapterEntitiesToDB",
      "summary": "Moves entities from an adapter into the Itential Platform database",
      "description": "Moves entities from an adapter into the Itential Platform database",
      "input": [],
      "output": {
        "name": "res",
        "type": "object",
        "description": "A JSON Object containing status, code and the response from the mongo transaction",
        "schema": {
          "title": "res",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapMoveAdapterEntitiesToDB"
      },
      "task": true
    },
    {
      "name": "iapDeactivateTasks",
      "summary": "Deactivate the inputted tasks",
      "description": "Deactivate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to deactivate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapDeactivateTasks"
      },
      "task": true
    },
    {
      "name": "iapActivateTasks",
      "summary": "Activate the inputted tasks",
      "description": "activate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to activate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapActivateTasks"
      },
      "task": true
    },
    {
      "name": "iapPopulateEntityCache",
      "summary": "Populate the cache for the given entities",
      "description": "Populate the cache for the given entities",
      "input": [
        {
          "name": "entityTypes",
          "type": "array",
          "info": "the entity type(s) to populate",
          "required": true,
          "schema": {
            "title": "entityTypes",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapPopulateEntityCache"
      },
      "task": true
    },
    {
      "name": "iapRetrieveEntitiesCache",
      "summary": "Retrieves data from cache for specified entity type",
      "description": "Retrieves data from cache for specified entity type",
      "input": [
        {
          "name": "entityType",
          "type": "string",
          "info": "entity of which to retrieve",
          "required": true,
          "schema": {
            "title": "entityType",
            "type": "string"
          }
        },
        {
          "name": "options",
          "type": "object",
          "info": "settings of which data to return and how to return it",
          "required": false,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRetrieveEntitiesCache"
      },
      "task": true
    },
    {
      "name": "getDevice",
      "summary": "Get the Appliance",
      "description": "Get the Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevice"
      },
      "task": false
    },
    {
      "name": "getDevicesFiltered",
      "summary": "Get Appliances that match the filter",
      "description": "Get Appliances that match the filter",
      "input": [
        {
          "name": "options",
          "type": "object",
          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
          "required": true,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "array",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "array"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevicesFiltered"
      },
      "task": false
    },
    {
      "name": "isAlive",
      "summary": "Checks the status for the provided Appliance",
      "description": "Checks the status for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/isAlive"
      },
      "task": false
    },
    {
      "name": "getConfig",
      "summary": "Gets a config for the provided Appliance",
      "description": "Gets a config for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        },
        {
          "name": "format",
          "type": "string",
          "info": "The format to be returned - this is ignored as we always return json",
          "required": false,
          "schema": {
            "title": "format",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getConfig"
      },
      "task": false
    },
    {
      "name": "iapGetDeviceCount",
      "summary": "Gets a device count from the system",
      "description": "Gets a device count from the system",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetDeviceCount"
      },
      "task": false
    },
    {
      "name": "iapExpandedGenericAdapterRequest",
      "summary": "Makes the requested generic call with additional options",
      "description": "Makes the requested generic call with additional options via metadata",
      "input": [
        {
          "name": "metadata",
          "type": "object",
          "info": "metadata for the call (optional)",
          "description": "metadata for the call - allows for many enhancements (optional)",
          "schema": {
            "title": "metadata",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "pathVars",
          "type": "object",
          "info": "the parameters to be put within the url path (optional)",
          "description": "the parameters to be put within the url path (optional)",
          "schema": {
            "title": "pathVars",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapExpandedGenericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequest",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequestNoBasePath",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequestNoBasePath"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterLint",
      "summary": "Run the adapter lint script to return the results",
      "description": "Run the adapter lint script to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "string",
        "description": "A string containing the run results",
        "schema": {
          "title": "result",
          "type": "string"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterLint"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterTests",
      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterTests"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterInventory",
      "summary": "Provide inventory information abbout the adapter",
      "description": "Provide inventory information abbout the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapGetAdapterInventory"
      },
      "task": true
    },
    {
      "name": "createNetwork",
      "summary": "createNetwork",
      "description": "createNetwork will create a network",
      "input": [
        {
          "type": "string",
          "name": "network",
          "description": "network address",
          "schema": {
            "title": "network",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "comment",
          "description": "description on the new network",
          "schema": {
            "title": "comment",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createNetwork"
      },
      "task": true
    },
    {
      "name": "assignNextNetwork",
      "summary": "assignNextNetwork",
      "description": "assignNextNetwork will create a network from master block",
      "input": [
        {
          "type": "string",
          "name": "networkBlock",
          "description": "network address",
          "schema": {
            "title": "networkBlock",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "nextNetworkSubnetMask",
          "description": "SubnetMask of the next network",
          "schema": {
            "title": "nextNetworkSubnetMask",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "comment",
          "description": "description on the new network",
          "schema": {
            "title": "comment",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/assignNextNetwork"
      },
      "task": true
    },
    {
      "name": "assignNextNetworkByNetwork",
      "summary": "assignNextNetworkByNetwork",
      "description": "assignNextNetworkByNetwork will create a network from master block",
      "input": [
        {
          "type": "string",
          "name": "networkBlock",
          "description": "network address",
          "required": true,
          "schema": {
            "title": "networkBlock",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "nextNetworkSubnetMask",
          "description": "SubnetMask of the next network",
          "required": true,
          "schema": {
            "title": "nextNetworkSubnetMask",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "networkView",
          "description": "The network view to be returned",
          "required": false,
          "schema": {
            "title": "networkView",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "returnFields",
          "description": "The fields to be returned",
          "required": false,
          "schema": {
            "title": "returnFields",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "comment",
          "description": "description on the new network",
          "required": false,
          "schema": {
            "title": "comment",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/assignNextNetworkByNetwork"
      },
      "task": true
    },
    {
      "name": "assignNextNetworkByRef",
      "summary": "assignNextNetworkByRef",
      "description": "assignNextNetworkByRef will create a network from master block",
      "input": [
        {
          "type": "string",
          "name": "networkReference",
          "description": "network address",
          "required": true,
          "schema": {
            "title": "networkReference",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "nextNetworkSubnetMask",
          "description": "SubnetMask of the next network",
          "required": true,
          "schema": {
            "title": "nextNetworkSubnetMask",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "networkView",
          "description": "The network view to be returned",
          "required": false,
          "schema": {
            "title": "networkView",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "returnFields",
          "description": "The fields to be returned",
          "required": false,
          "schema": {
            "title": "returnFields",
            "type": "string"
          }
        },
        {
          "type": "string",
          "name": "comment",
          "description": "description on the new network",
          "required": false,
          "schema": {
            "title": "comment",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/assignNextNetworkByRef"
      },
      "task": true
    },
    {
      "name": "createNetworkContainer",
      "summary": "createNetworkContainer",
      "description": "createNetworkContainer will create a new network container",
      "input": [
        {
          "type": "object",
          "name": "payload",
          "description": "",
          "schema": {
            "title": "payload",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createNetworkContainer"
      },
      "task": true
    },
    {
      "name": "getNextAvailableIp",
      "summary": "getNextAvailableIp",
      "description": "getNextAvailableIp will get the next available IP from the network block",
      "input": [
        {
          "type": "string",
          "name": "networkRef",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkRef",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNextAvailableIp"
      },
      "task": true
    },
    {
      "name": "getNextAvailableIps",
      "summary": "getNextAvailableIps",
      "description": "getNextAvailableIps will get the next available IP's from the network block",
      "input": [
        {
          "type": "string",
          "name": "networkRef",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkRef",
            "type": "string"
          }
        },
        {
          "type": "number",
          "name": "number",
          "description": "number of IP's required from the block",
          "schema": {
            "title": "number",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNextAvailableIps"
      },
      "task": true
    },
    {
      "name": "getNextAvailableIpsWithQuery",
      "summary": "getNextAvailableIpsWithQuery",
      "description": "getNextAvailableIpsWithQuery will get the next available IP's from the network block",
      "input": [
        {
          "type": "string",
          "name": "networkRef",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkRef",
            "type": "string"
          }
        },
        {
          "type": "number",
          "name": "number",
          "description": "number of IP's required from the block",
          "schema": {
            "title": "number",
            "type": "string"
          }
        },
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": true,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNextAvailableIpsWithQuery"
      },
      "task": true
    },
    {
      "name": "getNetworkDetails",
      "summary": "getNetworkDetails",
      "description": "getNetworkDetails will get the details of the network",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "required": false,
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkDetails"
      },
      "task": true
    },
    {
      "name": "getNetworkDetailsWithQuery",
      "summary": "getNetworkDetails",
      "description": "getNetworkDetails will get the details of the network",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "required": false,
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        },
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": true,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkDetailsWithQuery"
      },
      "task": true
    },
    {
      "name": "getNetworkDetailsByFilter",
      "summary": "getNetworkDetailsByFilter",
      "description": "getNetworkDetailsByFilter will get the details of the network based on the filter",
      "input": [
        {
          "type": "object",
          "name": "filter",
          "description": "Filter to use",
          "schema": {
            "title": "filter",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkDetailsByFilter"
      },
      "task": true
    },
    {
      "name": "getNetworkContainerDetails",
      "summary": "getNetworkContainerDetails",
      "description": "getNetworkContainerDetails will get the container details",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkContainerDetails"
      },
      "task": true
    },
    {
      "name": "listNetworkContainers",
      "summary": "listNetworkContainers",
      "description": "listNetworkContainers will get a list of containers",
      "input": [
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": false,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listNetworkContainers"
      },
      "task": true
    },
    {
      "name": "getNetworkContainerDetailsWithQuery",
      "summary": "getNetworkContainerDetails",
      "description": "getNetworkContainerDetails will get the container details",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        },
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": true,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkContainerDetailsWithQuery"
      },
      "task": true
    },
    {
      "name": "deleteNetwork",
      "summary": "delete network via the container",
      "description": "This function will delete the network container which includes the things in the container. It will not just delete a network, for that use deleteNetworkv2",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block for the network container",
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteNetwork"
      },
      "task": true
    },
    {
      "name": "deleteNetworkv2",
      "summary": "delete only the network",
      "description": "This function will delete the network",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteNetworkv2"
      },
      "task": true
    },
    {
      "name": "deleteAuthZone",
      "summary": "deleteAuthZone",
      "description": "deleteAuthZone will delete the auth zone",
      "input": [
        {
          "type": "string",
          "name": "fqdnName",
          "description": "fqdnName",
          "schema": {
            "title": "fqdnName",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteAuthZone"
      },
      "task": true
    },
    {
      "name": "getAuthZoneDetailsByfqdnName",
      "summary": "getAuthZoneDetailsByfqdnName",
      "description": "getAuthZoneDetailsByfqdnName will get the auth zone details",
      "input": [
        {
          "type": "string",
          "name": "fqdnName",
          "description": "fqdnName",
          "schema": {
            "title": "fqdnName",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getAuthZoneDetailsByfqdnName"
      },
      "task": true
    },
    {
      "name": "getAuthZoneDetailsByfqdnNameWithQuery",
      "summary": "getAuthZoneDetailsByfqdnName",
      "description": "getAuthZoneDetailsByfqdnName will get the auth zone details",
      "input": [
        {
          "type": "string",
          "name": "fqdnName",
          "description": "fqdnName",
          "schema": {
            "title": "fqdnName",
            "type": "string"
          }
        },
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": true,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getAuthZoneDetailsByfqdnNameWithQuery"
      },
      "task": true
    },
    {
      "name": "getNetworkKeyByIP",
      "summary": "getNetworkKeyByIP",
      "description": "getNetworkKeyByIP will get the network key by IP",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "required": false,
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkKeyByIP"
      },
      "task": true
    },
    {
      "name": "getNetworkKeyByIPWithQuery",
      "summary": "getNetworkKeyByIP",
      "description": "getNetworkKeyByIP will get the network key by IP",
      "input": [
        {
          "type": "string",
          "name": "networkIP",
          "description": "Network IP of the block",
          "required": false,
          "schema": {
            "title": "networkIP",
            "type": "string"
          }
        },
        {
          "name": "query",
          "type": "object",
          "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
          "required": true,
          "schema": {
            "title": "query",
            "type": "object"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNetworkKeyByIPWithQuery"
      },
      "task": true
    },
    {
      "name": "getIpDetails",
      "summary": "getIpDetails",
      "description": "getIpDetails will get the details of the IP Address",
      "input": [
        {
          "type": "string",
          "name": "IPAddress",
          "description": "",
          "schema": {
            "title": "IPAddress",
            "type": "string"
          }
        }
      ],
      "output": {
        "type": "object",
        "name": "result",
        "description": "",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin",
        "pronghorn_admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getIpDetails"
      },
      "task": true
    },
    {
      "name": "getIpDetailsWithQuery",
      "summary": "getIpDetails",
      "description": "getIpDetails will get the d