{
  "id": "@itentialopensource/adapter-ns1_cloud",
  "type": "Adapter",
  "export": "Ns1Cloud",
  "title": "Ns1_cloud",
  "src": "adapter.js",
  "roles": [
    "admin"
  ],
  "methods": [
    {
      "name": "iapUpdateAdapterConfiguration",
      "summary": "Updates the adapter configuration",
      "description": "Updates the adapter configuration file with the provided changes",
      "input": [
        {
          "name": "configFile",
          "type": "string",
          "info": "The name of the file to change",
          "required": true,
          "schema": {
            "title": "configFile",
            "type": "string"
          }
        },
        {
          "name": "changes",
          "type": "object",
          "info": "JSON object containing the configuration changes",
          "required": true,
          "schema": {
            "title": "changes",
            "type": "object"
          }
        },
        {
          "name": "entity",
          "type": "string",
          "info": "The entity in which the changes are being made",
          "required": false,
          "schema": {
            "title": "entity",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "The type of file to change - action, schema, or mock",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "action",
          "type": "string",
          "info": "The action to be changed",
          "required": false,
          "schema": {
            "title": "action",
            "type": "string"
          }
        },
        {
          "name": "replace",
          "type": "boolean",
          "info": "True to replace entire mock data, false to merge/append",
          "required": false,
          "schema": {
            "title": "replace",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUpdateAdapterConfiguration"
      },
      "task": true
    },
    {
      "name": "iapSuspendAdapter",
      "summary": "Suspends the adapter",
      "description": "Suspends the adapter",
      "input": [
        {
          "name": "mode",
          "type": "enum",
          "enumerals": [
            "pause",
            "error"
          ],
          "info": "How incoming requests are handled. Defaults to 'pause'",
          "description": "How incoming requests are handled. Defaults to 'pause'",
          "schema": {
            "title": "mode",
            "type": "string"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapSuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapUnsuspendAdapter",
      "summary": "Unsuspends the adapter",
      "description": "Unsuspends the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUnsuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterQueue",
      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
      "description": "Return the requests that are waiting in the queue if throttling is enabled",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter queue",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetAdapterQueue"
      },
      "task": true
    },
    {
      "name": "iapFindAdapterPath",
      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
      "description": "Provides the ability to see if a particular API path is supported by the adapter",
      "input": [
        {
          "name": "apiPath",
          "type": "string",
          "info": "The API Path you want to check - make sure to not include base path and version",
          "description": "The API Path you want to check - make sure to not include base path and version",
          "schema": {
            "title": "apiPath",
            "type": "string"
          },
          "required": true
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapFindAdapterPath"
      },
      "task": true
    },
    {
      "name": "iapTroubleshootAdapter",
      "summary": "Runs troubleshoot script for adapter",
      "description": "Runs troubleshoot script for adapter",
      "input": [
        {
          "name": "props",
          "type": "object",
          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
          "required": true,
          "schema": {
            "title": "props",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapTroubleshootAdapter"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterHealthcheck",
      "summary": "Runs healthcheck script for adapter",
      "description": "Runs healthcheck script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "Whether healthcheck passed or failed",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterHealthcheck"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterConnectivity",
      "summary": "Runs connectivity check script for adapter",
      "description": "Runs connectivity check script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterConnectivity"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterBasicGet",
      "summary": "Runs basicGet script for adapter",
      "description": "Runs basicGet script for adapter",
      "input": [
        {
          "name": "maxCalls",
          "required": false,
          "type": "number",
          "info": "How many GET endpoints to test (defaults to 5)",
          "schema": {
            "title": "maxCalls",
            "type": "number",
            "default": 5
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterBasicGet"
      },
      "task": true
    },
    {
      "name": "iapMoveAdapterEntitiesToDB",
      "summary": "Moves entities from an adapter into the Itential Platform database",
      "description": "Moves entities from an adapter into the Itential Platform database",
      "input": [],
      "output": {
        "name": "res",
        "type": "object",
        "description": "A JSON Object containing status, code and the response from the mongo transaction",
        "schema": {
          "title": "res",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapMoveAdapterEntitiesToDB"
      },
      "task": true
    },
    {
      "name": "iapDeactivateTasks",
      "summary": "Deactivate the inputted tasks",
      "description": "Deactivate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to deactivate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapDeactivateTasks"
      },
      "task": true
    },
    {
      "name": "iapActivateTasks",
      "summary": "Activate the inputted tasks",
      "description": "activate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to activate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapActivateTasks"
      },
      "task": true
    },
    {
      "name": "iapPopulateEntityCache",
      "summary": "Populate the cache for the given entities",
      "description": "Populate the cache for the given entities",
      "input": [
        {
          "name": "entityTypes",
          "type": "array",
          "info": "the entity type(s) to populate",
          "required": true,
          "schema": {
            "title": "entityTypes",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapPopulateEntityCache"
      },
      "task": true
    },
    {
      "name": "iapRetrieveEntitiesCache",
      "summary": "Retrieves data from cache for specified entity type",
      "description": "Retrieves data from cache for specified entity type",
      "input": [
        {
          "name": "entityType",
          "type": "string",
          "info": "entity of which to retrieve",
          "required": true,
          "schema": {
            "title": "entityType",
            "type": "string"
          }
        },
        {
          "name": "options",
          "type": "object",
          "info": "settings of which data to return and how to return it",
          "required": false,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRetrieveEntitiesCache"
      },
      "task": true
    },
    {
      "name": "getDevice",
      "summary": "Get the Appliance",
      "description": "Get the Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevice"
      },
      "task": false
    },
    {
      "name": "getDevicesFiltered",
      "summary": "Get Appliances that match the filter",
      "description": "Get Appliances that match the filter",
      "input": [
        {
          "name": "options",
          "type": "object",
          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
          "required": true,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "array",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "array"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevicesFiltered"
      },
      "task": false
    },
    {
      "name": "isAlive",
      "summary": "Checks the status for the provided Appliance",
      "description": "Checks the status for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/isAlive"
      },
      "task": false
    },
    {
      "name": "getConfig",
      "summary": "Gets a config for the provided Appliance",
      "description": "Gets a config for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        },
        {
          "name": "format",
          "type": "string",
          "info": "The format to be returned - this is ignored as we always return json",
          "required": false,
          "schema": {
            "title": "format",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getConfig"
      },
      "task": false
    },
    {
      "name": "iapGetDeviceCount",
      "summary": "Gets a device count from the system",
      "description": "Gets a device count from the system",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetDeviceCount"
      },
      "task": false
    },
    {
      "name": "iapExpandedGenericAdapterRequest",
      "summary": "Makes the requested generic call with additional options",
      "description": "Makes the requested generic call with additional options via metadata",
      "input": [
        {
          "name": "metadata",
          "type": "object",
          "info": "metadata for the call (optional)",
          "description": "metadata for the call - allows for many enhancements (optional)",
          "schema": {
            "title": "metadata",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "pathVars",
          "type": "object",
          "info": "the parameters to be put within the url path (optional)",
          "description": "the parameters to be put within the url path (optional)",
          "schema": {
            "title": "pathVars",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapExpandedGenericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequest",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequestNoBasePath",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequestNoBasePath"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterLint",
      "summary": "Run the adapter lint script to return the results",
      "description": "Run the adapter lint script to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "string",
        "description": "A string containing the run results",
        "schema": {
          "title": "result",
          "type": "string"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterLint"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterTests",
      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterTests"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterInventory",
      "summary": "Provide inventory information abbout the adapter",
      "description": "Provide inventory information abbout the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapGetAdapterInventory"
      },
      "task": true
    },
    {
      "name": "getZones",
      "summary": "View a list of active zones",
      "description": "Returns all active zones and basic zone configuration details for each.\n\n**Note**: For users with over 2500 zones, the response will be paginated to 2500 zones per page. To access the following zones, request the link in the **Link** response header, this follows the Web Linking standard (RFC 5988)",
      "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": "/getZones"
      },
      "task": true
    },
    {
      "name": "getZonesZone",
      "summary": "View zone details",
      "description": "Returns a single active zone and its basic configuration details. For convenience, a list of records in the zone, and some basic details of each record, is also included.\n\nNote: For zones with over 2500 records, the response will be paginated to 2500 records per page. To access the following records, request the link in the Link response header, this follows the Web Linking standard (RFC 5988)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "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": "/getZonesZone"
      },
      "task": true
    },
    {
      "name": "postZonesZone",
      "summary": "Modify a zone",
      "description": "Modifies the basic details of a DNS zone. You must include a JSON body in the request, in which you may include ttl (SOA record TTL), refresh, retry, expiry, or nx_ttl values, as in a SOA record. You may not change the zone name or other details.\n\nIf you are modifying a secondary zone, you can change the primary_ip and primary_port. You can also change enabled in the secondary object to convert a zone between primary and secondary behavior. Note that when converting a secondary to a primary zone...(description truncated)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "DNS Zone Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/postZonesZone"
      },
      "task": true
    },
    {
      "name": "putZonesZone",
      "summary": "Create a new zone",
      "description": "You must include a JSON body in the request with basic details of the zone. The only required element in the body is zone, the zone domain name. You can create a standard zone (which has its own configuration and records), a linked zone (pointing to an existing standard zone, reusing its configuration and records), or a secondary zone (which replicates DNS records from an external primary DNS server). For non-linked zones, you may specify optional zone configuration by including ttl (SOA record ...(description truncated)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "DNS Zone Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/putZonesZone"
      },
      "task": true
    },
    {
      "name": "deleteAZoneAllAssociatedRecords",
      "summary": "Delete a zone & all associated records",
      "description": "Deletes an existing DNS zone and all of its associated records.\n\nNote: NS1 servers will not respond to queries for the zone or any of the records after it is deleted, and you cannot recover the deleted zone. There is no request body required, and there is no response other than the HTTP status code.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "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": "/deleteAZoneAllAssociatedRecords"
      },
      "task": true
    },
    {
      "name": "getZonesZoneDnssec",
      "summary": "View DNSSEC details for a zone",
      "description": "Returns public key information including DNSKEY and DS record information.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "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": "/getZonesZoneDnssec"
      },
      "task": true
    },
    {
      "name": "getImportZonefileZone",
      "summary": "View status of zone file import",
      "description": "Get the status, and if finished, results of, a zone file import job launched with a PUT request to /import/zonefile/:zone. The jobid is the value of the id field in the response of an asynchronous import request. If the zone file import is finished, the response includes the fields response (body containing import request results), and response_code (final HTTP status code for the import request).",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "Import Job ID: string",
          "required": true,
          "schema": {
            "title": "zone",
            "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": "/getImportZonefileZone"
      },
      "task": true
    },
    {
      "name": "putImportZonefileZone",
      "summary": "Import a zone from a zone file",
      "description": "Upload a zone file, using form encoding (multipart/form-data) with the zone file as the content of the zonefile form parameter. The zone must not already exist in your account. It will be created, as will all records in the zone file. Any round-robin records (e.g., multiple A records for the same domain) will be treated as answers for a single combined record in your account. Existing NS records will be replaced, as will some details of SOA records.\n\nThere are two modes: synchronous (default) an...(description truncated)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "zoneFile",
          "type": "string",
          "info": "DNS Zone File: string",
          "required": false,
          "schema": {
            "title": "zoneFile",
            "type": "string"
          }
        },
        {
          "name": "async",
          "type": "boolean",
          "info": "Run Asynchronously: boolean",
          "required": false,
          "schema": {
            "title": "async",
            "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": "/putImportZonefileZone"
      },
      "task": true
    },
    {
      "name": "getSearch",
      "summary": "Search zones and records",
      "description": "Returns all zones and records that match a query string q. You can limit the max number of results and you can restrict the type of results to zone, record, or all. Entries in the response without domain/type are zones, and those with domain/type are records.",
      "input": [
        {
          "name": "q",
          "type": "string",
          "info": "Query Parameters: string",
          "required": false,
          "schema": {
            "title": "q",
            "type": "string"
          }
        },
        {
          "name": "max",
          "type": "number",
          "info": "Max Number of Results: 123",
          "required": false,
          "schema": {
            "title": "max",
            "type": "number"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "Type of Results: Must be one of [zone, record, all]",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getSearch"
      },
      "task": true
    },
    {
      "name": "getNetworks",
      "summary": "List available networks",
      "description": "Some customers may have access to DNS networks other than the primary NSONE Global Network. This endpoint lists all networks for which you may create zones and records. You will generally always have access to the NSONE Global Network (network 0).",
      "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": "/getNetworks"
      },
      "task": true
    },
    {
      "name": "getZonesZoneDomainType",
      "summary": "View record configuration details",
      "description": "Returns full configuration for a DNS record including basic config, answers, regions, filter chain configuration, and all metadata tables and data feeds attached to entities in the record. (Note that regions might be any specified grouping, not necessarily a geo-related region. For this reason, the NS1 web portal at my.nsone.net uses the word \"group\" instead of \"region\".)\n\nYou must fully specify zone, domain, and record type, e.g., example.com/www.example.com/A returns the A record for www.examp...(description truncated)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getZonesZoneDomainType"
      },
      "task": true
    },
    {
      "name": "postZonesZoneDomainType",
      "summary": "Update record configuration",
      "description": "Modifies configuration details for an existing DNS record.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "DNS Record Configuration Parameters: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/postZonesZoneDomainType"
      },
      "task": true
    },
    {
      "name": "putZonesZoneDomainType",
      "summary": "Create a new DNS record",
      "description": "Creates a new DNS record in the specified zone, for the specified domain, of the given record type. Currently supported record types are: A, AAAA, ALIAS, AFSDB, CERT, CNAME, DNAME, HINFO, MX, NAPTR, NS, PTR, RP, SPF, SRV, TXT. The answer field within each entry in the answers list must be a list of the RDATA fields for a DNS record of the specified type.\n\n  You may not create multiple records of the same type for the same domain name in a zone — instead, add new answers to the existing record. T...(description truncated)",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "Record Creation Parameters: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/putZonesZoneDomainType"
      },
      "task": true
    },
    {
      "name": "deleteZonesZoneDomainType",
      "summary": "Delete a record",
      "description": "Removes an existing record and all associated answers and configuration details. We will no longer respond for this record once it is deleted, and it cannot be recovered, so use caution. Note: This operation deletes all answers associated with the domain and record type. If you want to delete individual answers, do a POSToperation to update the record's answers list. This method has no response other than the HTTP status code.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteZonesZoneDomainType"
      },
      "task": true
    },
    {
      "name": "getMetatypes",
      "summary": "View available metadata",
      "description": "Returns a list of available metadata fields for use in configuring records, including descriptions (in HTML).",
      "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": "/getMetatypes"
      },
      "task": true
    },
    {
      "name": "getFiltertypes",
      "summary": "View available filters",
      "description": "Returns a list of available FILTERS for use in configuring dynamic records, including descriptions (in HTML), configuration options, and metadata inputs used by the filter, along with any restrictions on record types where the filter may be used.",
      "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": "/getFiltertypes"
      },
      "task": true
    },
    {
      "name": "getMetatypesGeo",
      "summary": "View available geographic metadata",
      "description": "Returns a list of available geographic metadata used by the “Geo-target Country” and “Geo-fence Country” filters . Note that the response will be long. The example response below is truncated for readability.",
      "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": "/getMetatypesGeo"
      },
      "task": true
    },
    {
      "name": "viewAvailableDataSourcesTypes",
      "summary": "View available data sources types",
      "description": "Returns a list of all available data source types. For any third party data sources, you must have an account with the provider. Frequently, there are additional steps you must take with the provider to connect your data source — these are explained in the desc field which is HTML. Response includes any config options for the data source, required or optional; and any feed_config options for data feeds connected to the source.",
      "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": "/viewAvailableDataSourcesTypes"
      },
      "task": true
    },
    {
      "name": "getDataSources",
      "summary": "View active data sources",
      "description": "Returns a list of all connected data sources, and for each data source, all connected feeds including connected metadata table destinations.",
      "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": "/getDataSources"
      },
      "task": true
    },
    {
      "name": "putDataSources",
      "summary": "Connect a new data source",
      "description": "Creates a new data source. You may create multiple data sources of the same type, e.g., to correspond to different accounts with a data provider. The config for the source must contain fields corresponding to the config description in /data/sourcetypes for the sourcetype you specify. Some data sources are immediately connected; others enter a pending state awaiting activity from the data source, e.g., a verification request. See the documentation for the source from /data/sourcetypes.",
      "input": [
        {
          "name": "config",
          "type": "object",
          "info": "config: object",
          "required": false,
          "schema": {
            "title": "config",
            "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": "/putDataSources"
      },
      "task": true
    },
    {
      "name": "getDataSourcesSourceid",
      "summary": "View a single data source",
      "description": "Returns the details for a single data source, including configuration, all connected data feeds, and within data feeds, any connected metadata table (destinations).",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "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": "/getDataSourcesSourceid"
      },
      "task": true
    },
    {
      "name": "postDataSourcesSourceid",
      "summary": "Modify a data source",
      "description": "Modifies basic details or configuration of a data source. You must include a JSON body in the request. You may update name and config details.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "Data Source Configuration: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/postDataSourcesSourceid"
      },
      "task": true
    },
    {
      "name": "deleteDataSourcesSourceid",
      "summary": "Delete a data source",
      "description": "Removes an existing data source and all connected feeds from the source. By extension, all metadata tables connected to those feeds will no longer receive updates. We will no longer accept updates on the Feed URL for this data source. This method has no response other than the HTTP status code.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "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": "/deleteDataSourcesSourceid"
      },
      "task": true
    },
    {
      "name": "getDataFeedsSourceid",
      "summary": "View active data feeds for a source",
      "description": "Returns all data feeds connected to a source. Includes config details for each feed which match the feed_config specification from /data/sourcetypes, and also includes a list of metadata tables that are destinations for each feed.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "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": "/getDataFeedsSourceid"
      },
      "task": true
    },
    {
      "name": "postDataFeedsSourceid",
      "summary": "Publish data from a data source",
      "description": "This is the Feed URL for a data source. Many data sources connect directly to this URL to feed data to NSONE, and in general you must configure them to do so according to the instructions for the data source (see /data/sourcetypes). The request sent to this URL depends on the type of the data source — usually, each data source has its own request protocol. For convenience, this URL accepts GET, PUT, and POST requests, but POST is preferred.\n\nYou can feed data to the Feed URL directly for your NS...(description truncated)",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "update: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/postDataFeedsSourceid"
      },
      "task": true
    },
    {
      "name": "putDataFeedsSourceid",
      "summary": "Connect a new data feed to a data source",
      "description": "Given an existing data source, connects a new data feed to the source with a given (freeform) name and config matching the specification in feed_config from /data/sourcetypes. In this example, we connect a Rackspace Cloud Monitoring Alarm (using the Rackspace Alarm id and Entity id for the Alarm). To subsequently connect the feed to destinations (such as record answers), you should modify the record to connect a specific metadata key (which the feed is compatible with) via a feed pointer object ...(description truncated)",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "Data Feed Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/putDataFeedsSourceid"
      },
      "task": true
    },
    {
      "name": "getDataFeedsSourceidFeedid",
      "summary": "View data feed details",
      "description": "Returns the details of a single data feed, including config details and any record, region, or answer metadata table destinations.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "feedid",
          "type": "string",
          "info": "Data Feed ID: string",
          "required": true,
          "schema": {
            "title": "feedid",
            "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": "/getDataFeedsSourceidFeedid"
      },
      "task": true
    },
    {
      "name": "modifyADataFeed",
      "summary": "Modify a data feed",
      "description": "You may update name or config.\n\nTo connect the feed to destinations (such as record answers), you should instead modify the record to connect a specific metadata key (which the feed is compatible with) via a feed pointer object to this feed id. See the documention for /zones/:zone/:domain/:type.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "feedid",
          "type": "string",
          "info": "Data Feed ID: string",
          "required": true,
          "schema": {
            "title": "feedid",
            "type": "string"
          }
        },
        {
          "name": "dataFeed",
          "type": "object",
          "info": "Data Feed Object: object",
          "required": false,
          "schema": {
            "title": "dataFeed",
            "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": "/modifyADataFeed"
      },
      "task": true
    },
    {
      "name": "deleteDataFeedsSourceidFeedid",
      "summary": "Disconnect a data feed",
      "description": "The feed will be disconnected from the data source and all attached destination metadata tables. The data source will not be removed and updates to remaining connected data feeds will still be processed.",
      "input": [
        {
          "name": "sourceid",
          "type": "string",
          "info": "Data Source ID: string",
          "required": true,
          "schema": {
            "title": "sourceid",
            "type": "string"
          }
        },
        {
          "name": "feedid",
          "type": "string",
          "info": "Data Feed ID: string",
          "required": true,
          "schema": {
            "title": "feedid",
            "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": "/deleteDataFeedsSourceidFeedid"
      },
      "task": true
    },
    {
      "name": "getMonitoringJobs",
      "summary": "List monitoring jobs",
      "description": "Returns the list of all monitoring jobs for the account, including configuration and current status details. Job status is shown per region, including the \"global\" region indicating the overal status of the monitoring job computed based on the status policy from the regional statuses. Status values both globally and per region include up, down, and pending.",
      "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": "/getMonitoringJobs"
      },
      "task": true
    },
    {
      "name": "putMonitoringJobs",
      "summary": "Create a new monitoring job",
      "description": "Create a new monitoring job",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "Monitoring Job Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/putMonitoringJobs"
      },
      "task": true
    },
    {
      "name": "getMonitoringJobsJobid",
      "summary": "View monitoring job details",
      "description": "Returns details for a specific monitoring jobs based on its id, including configuration and current status details. Job status is shown per region, including the \"global\" region indicating the overal status of the monitoring job computed based on the status policyfrom the regional statuses. Status values both globally and per region include up, down, and pending.",
      "input": [
        {
          "name": "jobid",
          "type": "string",
          "info": "Monitoring Job ID: string",
          "required": true,
          "schema": {
            "title": "jobid",
            "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": "/getMonitoringJobsJobid"
      },
      "task": true
    },
    {
      "name": "postMonitoringJobsJobid",
      "summary": "Update details of a monitoring job",
      "description": "Change the configuration details of an existing monitoring job. See the documentation for PUT /monitoring/jobs for a detailed explanation of the input.",
      "input": [
        {
          "name": "jobid",
          "type": "string",
          "info": "Monitoring Job ID: string",
          "required": true,
          "schema": {
            "title": "jobid",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "string",
          "info": "Monitoring Job Object: string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/postMonitoringJobsJobid"
      },
      "task": true
    },
    {
      "name": "removeAMonitoringJob",
      "summary": "Remove a monitoring job",
      "description": "Immediately terminates and deletes an existing monitoring job. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "jobid",
          "type": "string",
          "info": "Monitoring Job ID: string",
          "required": true,
          "schema": {
            "title": "jobid",
            "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": "/removeAMonitoringJob"
      },
      "task": true
    },
    {
      "name": "getMonitoringHistoryJobid",
      "summary": "View historical status of monitoring job",
      "description": "Returns historical status details of a monitoring job (if jobid is included in the URL) or of all monitoring jobs under the account (if no jobid is specified). You may restrict the time period to show with start and end (Unix timestamps) or by specifying a period (one of 1h, 24h, or 30d); limit the number of results with limit; and restrict to results from a specific region code. You may also specify exact (a boolean, if true you must also specify start): then, the status as of the exact start a...(description truncated)",
      "input": [
        {
          "name": "jobid",
          "type": "string",
          "info": "Monitoring Job ID: string",
          "required": true,
          "schema": {
            "title": "jobid",
            "type": "string"
          }
        },
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp (defaults to current time): 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": ": Must be one of [1h, 24h, 30d]",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "limit",
          "type": "number",
          "info": "Maximum number of results: 123",
          "required": false,
          "schema": {
            "title": "limit",
            "type": "number"
          }
        },
        {
          "name": "region",
          "type": "string",
          "info": "Region Code: string",
          "required": false,
          "schema": {
            "title": "region",
            "type": "string"
          }
        },
        {
          "name": "exact",
          "type": "boolean",
          "info": "Exact Match: boolean",
          "required": false,
          "schema": {
            "title": "exact",
            "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": "/getMonitoringHistoryJobid"
      },
      "task": true
    },
    {
      "name": "getMonitoringMetricJobid",
      "summary": "View historical metrics for monitoring job",
      "description": "Returns historical metrics generated by monitoring jobs, such as response time, packet loss, TCP connect time, etc. The metrics in the response depend on the job — metrics available for each job type are returned by /monitoring/jobtypes. If you include a jobid in the URL, only metrics for that job are returned; otherwise, metrics for all jobs are returned subject to the other filtering parameters, which include:\n\n  - region: a region code; may be either global or a specific region as listed in /...(description truncated)",
      "input": [
        {
          "name": "jobid",
          "type": "string",
          "info": "Monitoring Job ID: string",
          "required": true,
          "schema": {
            "title": "jobid",
            "type": "string"
          }
        },
        {
          "name": "region",
          "type": "string",
          "info": "Region code: string",
          "required": false,
          "schema": {
            "title": "region",
            "type": "string"
          }
        },
        {
          "name": "metric",
          "type": "string",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "metric",
            "type": "string"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": ": Must be one of [1h, 24h, 30d]",
          "required": false,
          "schema": {
            "title": "period",
            "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": "/getMonitoringMetricJobid"
      },
      "task": true
    },
    {
      "name": "getMonitoringJobtypes",
      "summary": "List available monitoring job types",
      "description": "Returns the list of all available monitoring jobs types, and details of configuration options for each job type.",
      "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": "/getMonitoringJobtypes"
      },
      "task": true
    },
    {
      "name": "getMonitoringRegions",
      "summary": "List available monitoring regions",
      "description": "List available monitoring regions description:Returns the list of all available monitoring regions, including display name for the region, the region code to use when provisioning, and the list of all subnets from which monitoring traffic is generated in each region. The response below is using subnets from the documentation address blocks (RFC 5737 and RFC 3849) do not use them in your access lists.",
      "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": "/getMonitoringRegions"
      },
      "task": true
    },
    {
      "name": "getLists",
      "summary": "List all notification lists",
      "description": "Returns all configured notification lists. Each list consists of a name, an id for use in connecting notification lists in monitoring jobs, and a notify_list of configured notifiers.",
      "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": "/getLists"
      },
      "task": true
    },
    {
      "name": "putLists",
      "summary": "Create a new notification list",
      "description": "Creates a new list for notifications. You may specify a freeform display name for the list. The notify_list itself is a list of notifier objects including notifier type and a config dictionary with configuration details for the given notifier type. Available notifiers are indicated in /notifytypes. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails).",
      "input": [
        {
          "name": "list",
          "type": "string",
          "info": "Notification List Object: string",
          "required": false,
          "schema": {
            "title": "list",
            "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": "/putLists"
      },
      "task": true
    },
    {
      "name": "getListsListid",
      "summary": "View notification list details",
      "description": "Gets the details and notifiers associated with a specific notification list.",
      "input": [
        {
          "name": "listid",
          "type": "string",
          "info": "Notification List ID: string",
          "required": true,
          "schema": {
            "title": "listid",
            "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": "/getListsListid"
      },
      "task": true
    },
    {
      "name": "postListsListid",
      "summary": "Update a notification list",
      "description": "Add or remove entries or otherwise update a notification list.",
      "input": [
        {
          "name": "listid",
          "type": "string",
          "info": "Notification List ID: string",
          "required": true,
          "schema": {
            "title": "listid",
            "type": "string"
          }
        },
        {
          "name": "list",
          "type": "object",
          "info": "Notification List Object: object",
          "required": false,
          "schema": {
            "title": "list",
            "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": "/postListsListid"
      },
      "task": true
    },
    {
      "name": "deleteListsListid",
      "summary": "Remove a notification list",
      "description": "Immediately deletes an existing notification list. Any monitoring jobs configured to notify this list will stop sending notifications until reconfigured to notify a different list. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "listid",
          "type": "string",
          "info": "Notification List ID: string",
          "required": true,
          "schema": {
            "title": "listid",
            "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": "/deleteListsListid"
      },
      "task": true
    },
    {
      "name": "getNotifytypes",
      "summary": "List available notification types",
      "description": "Returns the list of all available notifiers for delivery of monitoring status notifications, and details of configuration options for each notification type.",
      "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": "/getNotifytypes"
      },
      "task": true
    },
    {
      "name": "getAccountSettings",
      "summary": "View account contact details and settings",
      "description": "Returns the basic contact details associated with your account.",
      "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": "/getAccountSettings"
      },
      "task": true
    },
    {
      "name": "postAccountSettings",
      "summary": "Modify contact details and settings",
      "description": "You may change most of your basic contact details, except customerid.",
      "input": [
        {
          "name": "accountDetails",
          "type": "object",
          "info": "Account Details Object: object",
          "required": false,
          "schema": {
            "title": "accountDetails",
            "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": "/postAccountSettings"
      },
      "task": true
    },
    {
      "name": "getAccountUsagewarnings",
      "summary": "View overage alert settings",
      "description": "Returns toggles and thresholds used when sending overage warning alert messages to users with billing notifications enabled.",
      "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": "/getAccountUsagewarnings"
      },
      "task": true
    },
    {
      "name": "postAccountUsagewarnings",
      "summary": "Modify overage alerting settings",
      "description": "Changes alerting toggles and thresholds for overage warning alert messages. First thresholds (warning_1) must be smaller than second ones (warning_2) and all thresholds must be percentages between 0 and 100.",
      "input": [
        {
          "name": "accountDetails",
          "type": "object",
          "info": "Account Details Object: object",
          "required": false,
          "schema": {
            "title": "accountDetails",
            "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": "/postAccountUsagewarnings"
      },
      "task": true
    },
    {
      "name": "getAccountUsers",
      "summary": "View all account users",
      "description": "Returns a list of all users with access to the account. Notification settings (notify) and access restrictions (permissions) are included. If any specific access right is omitted from permissionsthen it defaults to true (allowed). In the example below, \"New User\" is only allowed to manage the example.com zone and can do nothing else in the account; \"API Example\" has full permissions.\n\nUsers may belong to \"Teams\" in which case they inherit the permissions of the Teams. If a user belongs to multip...(description truncated)",
      "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": "/getAccountUsers"
      },
      "task": true
    },
    {
      "name": "getAccountUsersUsername",
      "summary": "View user details",
      "description": "Returns the details for a single user.",
      "input": [
        {
          "name": "username",
          "type": "string",
          "info": "Account User Name: string",
          "required": true,
          "schema": {
            "title": "username",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getAccountUsersUsername"
      },
      "task": true
    },
    {
      "name": "updateAUserSDetails",
      "summary": "Update a user's details",
      "description": "Change contact details, notification settings, or access rights for a user.\n\nIf the user belongs to any Teams or you are adding the user to their first Team, you may not directly set permissions for the user. If you are removing the user from all Teams to which they belong, and you do not explicitly set permissions, their permissions will be set equivalently to what they were as a member of the Teams. You can restrict access to this user by adding IP addresses or CIDR blocks in the ip_whitelist ...(description truncated)",
      "input": [
        {
          "name": "username",
          "type": "string",
          "info": "Account User Name: string",
          "required": true,
          "schema": {
            "title": "username",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "NS1 User Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/updateAUserSDetails"
      },
      "task": true
    },
    {
      "name": "addUserToAccount",
      "summary": "Add user to account",
      "description": "Creates a new user. An invitation email will be sent to the user's email address, which they can click to set a password and log into my.nsone.net. The user cannot log in until they accept the invitation and set a password.\n\nIf you add the user to one or more Teams, they will inherit the permissions of those teams and any permissions you include in the request body will be ignored. If the user is not added to any Teams, then you may explicitly set permissions for the user. You can restrict acces...(description truncated)",
      "input": [
        {
          "name": "username",
          "type": "string",
          "info": "Account User Name: string",
          "required": true,
          "schema": {
            "title": "username",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "NS1 User Object: object",
          "required": false,
          "schema": {
            "title": "body",
            "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": "/addUserToAccount"
      },
      "task": true
    },
    {
      "name": "deleteAccountUsersUsername",
      "summary": "Remove a user",
      "description": "Deletes a user from the account. They will no longer be able to log into my.nsone.net. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "username",
          "type": "string",
          "info": "Account User Name: string",
          "required": true,
          "schema": {
            "title": "username",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteAccountUsersUsername"
      },
      "task": true
    },
    {
      "name": "postAccountReinviteUsername",
      "summary": "Resend invitation to a user",
      "description": "In case a new user did not receive their invitation email, or in case the invitation has expired, you may re-send the invitation. However, if the user has already logged in, you may not re-send the invitation — they should click the \"Forgot Password\" link to verify their email address and reset their password. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "username",
          "type": "string",
          "info": "Account User Name: string",
          "required": true,
          "schema": {
            "title": "username",
            "type": "string"
          }
        },
        {
          "name": "user",
          "type": "object",
          "info": "NS1 User Object: object",
          "required": false,
          "schema": {
            "title": "user",
            "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": "/postAccountReinviteUsername"
      },
      "task": true
    },
    {
      "name": "getAccountApikeys",
      "summary": "View all API keys",
      "description": "Returns a list of all API Keys under the account, including access rights (permissions) and the actual key to be used when contacting the NSONE API. API keys may belong to teams with the same semantics as Users.",
      "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": "/getAccountApikeys"
      },
      "task": true
    },
    {
      "name": "putAccountApikeys",
      "summary": "Create a new API Key",
      "description": "Creates a new API Key. You should explicitly restrict access rights for the API Key to include only what the application requires. If you add the API Key to one or more Teams, you may not directly set its permissions and the API Key will inherit access rights from its Teams. The new API Key string is returned in the key field in the response — keep it secret, keep it safe. If it is compromised, delete the API Key immediately. You can restrict access to this key by adding IP addresses or CIDR blo...(description truncated)",
      "input": [
        {
          "name": "key",
          "type": "object",
          "info": "API Key Object: object",
          "required": false,
          "schema": {
            "title": "key",
            "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": "/putAccountApikeys"
      },
      "task": true
    },
    {
      "name": "getAccountApikeysKeyid",
      "summary": "View API key details",
      "description": "Returns details, including permissions, for a single API Key. Note: do not use the API Key itself as the keyid in the URL — use the id of the key. Keep the API Key string secret — it grants access to your account!",
      "input": [
        {
          "name": "keyid",
          "type": "string",
          "info": "API Key ID: string",
          "required": true,
          "schema": {
            "title": "keyid",
            "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": "/getAccountApikeysKeyid"
      },
      "task": true
    },
    {
      "name": "postAccountApikeysKeyid",
      "summary": "Modify details of an API Key",
      "description": "Change name or access rights for an API Key. You can restrict access to this user by adding IP addresses or CIDR blocks in the ip_whitelist array property. i.e. ip_whitelist: ['104.20.48.182', '104.20.49.0/24'].",
      "input": [
        {
          "name": "keyid",
          "type": "string",
          "info": "API Key ID: string",
          "required": true,
          "schema": {
            "title": "keyid",
            "type": "string"
          }
        },
        {
          "name": "key",
          "type": "object",
          "info": "API Key Object: object",
          "required": false,
          "schema": {
            "title": "key",
            "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": "/postAccountApikeysKeyid"
      },
      "task": true
    },
    {
      "name": "deleteAnAPIKey",
      "summary": "Delete an API Key",
      "description": "Deletes an API Key. Any applications, scripts, or tools you have that are using this API Key will no longer be able to access your account. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "keyid",
          "type": "string",
          "info": "API Key ID: string",
          "required": true,
          "schema": {
            "title": "keyid",
            "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": "/deleteAnAPIKey"
      },
      "task": true
    },
    {
      "name": "getAccountTeams",
      "summary": "View all teams",
      "description": "Returns a list of all teams associated with the account—including access rights (permissions) associated with users and API keys in the team.",
      "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": "/getAccountTeams"
      },
      "task": true
    },
    {
      "name": "putAccountTeams",
      "summary": "Create a new Team",
      "description": "Creates a new Team. You should explicitly restrict access rights for the Team to include only what team members will require. Once you have created a Team, you may add Users and API Keys to the team by adding the Team to the team field in the User and API Key objects. You can restrict access to this team by adding IP whitelist records in the ip_whitelist array property. Compared to users and apikeys, teams support names on whitelist records. i.e. ip_whitelist: [ {'name': 'Home Whitelist', 'value...(description truncated)",
      "input": [
        {
          "name": "team",
          "type": "object",
          "info": "Team Object: object",
          "required": false,
          "schema": {
            "title": "team",
            "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": "/putAccountTeams"
      },
      "task": true
    },
    {
      "name": "getAccountTeamsTeamid",
      "summary": "View team details",
      "description": "Returns details, including permissions, for a single Team.",
      "input": [
        {
          "name": "teamid",
          "type": "string",
          "info": "Team ID: string",
          "required": true,
          "schema": {
            "title": "teamid",
            "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": "/getAccountTeamsTeamid"
      },
      "task": true
    },
    {
      "name": "postAccountTeamsTeamid",
      "summary": "Modify details of a Team",
      "description": "Change name or access rights for a Team. You can restrict access to this team by adding IP whitelist records in the ip_whitelist array property. Compared to users and apikeys, teams support names on whitelist records. i.e. ip_whitelist: [ {'name': 'Home Whitelist', 'values': ['104.20.48.182'], {'name': 'Multi Whitelist', 'values': ['104.20.49.0/24', '104.20.50.1']} ].",
      "input": [
        {
          "name": "teamid",
          "type": "string",
          "info": "Team ID: string",
          "required": true,
          "schema": {
            "title": "teamid",
            "type": "string"
          }
        },
        {
          "name": "team",
          "type": "object",
          "info": "Team Object: object",
          "required": false,
          "schema": {
            "title": "team",
            "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": "/postAccountTeamsTeamid"
      },
      "task": true
    },
    {
      "name": "deleteAccountTeamsTeamid",
      "summary": "Delete a Team",
      "description": "Deletes a Team. Any Users or API Keys that belong to the Team will be removed from the Team. If they belong to other Teams, they will take on the permissions from the remaining Teams. If they only belong to the Team being deleted, they will be explicitly given permissions equivalent to those of the Team. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "teamid",
          "type": "string",
          "info": "Team ID: string",
          "required": true,
          "schema": {
            "title": "teamid",
            "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": "/deleteAccountTeamsTeamid"
      },
      "task": true
    },
    {
      "name": "getAccountWhitelist",
      "summary": "View all IP whitelists",
      "description": "Returns all the (global) IP Whitelist records for the account.",
      "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": "/getAccountWhitelist"
      },
      "task": true
    },
    {
      "name": "putAccountWhitelist",
      "summary": "Create a new IP Whitelist Record",
      "description": "Creates a new IP Whitelist Record.",
      "input": [
        {
          "name": "whitelist",
          "type": "object",
          "info": "IP Whitelist Object: object",
          "required": false,
          "schema": {
            "title": "whitelist",
            "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": "/putAccountWhitelist"
      },
      "task": true
    },
    {
      "name": "getAccountWhitelistId",
      "summary": "View IP whitelist record details",
      "description": "Get a specific IP whitelist record by its unique ID.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "IP Whitelist ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "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": "/getAccountWhitelistId"
      },
      "task": true
    },
    {
      "name": "postAccountWhitelistId",
      "summary": "Modify details of an IP Whitelist Record",
      "description": "Updates the properties of an existing IP Whitelist Record.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "Whitelist ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "whitelist",
          "type": "object",
          "info": "IP Whitelist Object: object",
          "required": false,
          "schema": {
            "title": "whitelist",
            "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": "/postAccountWhitelistId"
      },
      "task": true
    },
    {
      "name": "deleteAccountWhitelistId",
      "summary": "Delete an IP Whitelist Record",
      "description": "Delete an IP Whitelist Record",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "Whitelist ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "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": "/deleteAccountWhitelistId"
      },
      "task": true
    },
    {
      "name": "getAccountPlantypes",
      "summary": "View self-service subscription plans",
      "description": "Returns details of all currently available self service subscription plans and associated pricing. Each subscription plan is uniquely identified by the plan type and period.\n\nNote: details are returned regardless of your current plan, but at this time only users on the startup, starter, or basic plan types may change their subscription automatically. Users currently on other plans should contact support@ns1.com.",
      "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": "/getAccountPlantypes"
      },
      "task": true
    },
    {
      "name": "getAccountPlan",
      "summary": "View current subscription plan details",
      "description": "Returns details of the current subscription for the account, including all applicable fees, charges, discounts, etc. The current balance, if any, is also returned.",
      "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": "/getAccountPlan"
      },
      "task": true
    },
    {
      "name": "postAccountPlan",
      "summary": "Change your subscription plan",
      "description": "If you are on the startup, starter, or basic plan, and you have a valid credit card on file, you may call this method to instantly pay for and upgrade to a new subscription plan. You may change to a basic or advanced plan with a monthly, quarterly, semiannual, or annual term. Note: In this case, you will be charged the full price of the new plan as indicated in the recurring_cost field in the plan description. If you are currently on any other plan, you do not have a payment method on file, or y...(description truncated)",
      "input": [
        {
          "name": "plan",
          "type": "string",
          "info": "NS1 Subscription Plan: string",
          "required": false,
          "schema": {
            "title": "plan",
            "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": "/postAccountPlan"
      },
      "task": true
    },
    {
      "name": "getAccountInvoices",
      "summary": "List invoices",
      "description": "Lists basic details of all historical and current invoices for the account.",
      "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": "/getAccountInvoices"
      },
      "task": true
    },
    {
      "name": "downloadAnInvoice",
      "summary": "Download an invoice",
      "description": "The invoice is returned in PDF format. This method will directly return a PDF. The Content-Type and Content-Dispositionheaders will be set accordingly. However, if there is an error, the usual JSON error will be returned.\n\nThere are certain cases, such as in some browsers, where you will be unable to send the X-NSONE-Key authentication header to download a file intended to be saved to the user's filesystem, due to restrictions on some kinds of AJAX/XHR requests. In this case, you may use an alte...(description truncated)",
      "input": [
        {
          "name": "invoiceid",
          "type": "string",
          "info": "Invoice ID: string",
          "required": true,
          "schema": {
            "title": "invoiceid",
            "type": "string"
          }
        },
        {
          "name": "authtoken",
          "type": "string",
          "info": "Authentication Token: string",
          "required": false,
          "schema": {
            "title": "authtoken",
            "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": "/downloadAnInvoice"
      },
      "task": true
    },
    {
      "name": "getAccountBillataglance",
      "summary": "View bill at a glance",
      "description": "Returns current usage and charges that will appear on the next invoice.",
      "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": "/getAccountBillataglance"
      },
      "task": true
    },
    {
      "name": "getAccountPaymentmethods",
      "summary": "View list of active payment methods",
      "description": "This method returns the list of all payment methods (credit cards) attached to the account.",
      "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": "/getAccountPaymentmethods"
      },
      "task": true
    },
    {
      "name": "addANewPaymentMethod",
      "summary": "Add a new payment method",
      "description": "Adds a new credit card to the account. If you set default to true it will become the new default card we charge for new invoices. We will do a small pre-authorization charge to the credit card, which will be refunded.",
      "input": [
        {
          "name": "paymentMethod",
          "type": "object",
          "info": "Payment Method Object: object",
          "required": false,
          "schema": {
            "title": "paymentMethod",
            "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": "/addANewPaymentMethod"
      },
      "task": true
    },
    {
      "name": "getAccountPaymentmethodsId",
      "summary": "View payment method details",
      "description": "This method returns just the details for a single payment method given its id.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "Payment Method ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "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": "/getAccountPaymentmethodsId"
      },
      "task": true
    },
    {
      "name": "makeAPaymentMethodTheDefault",
      "summary": "Make a payment method the default",
      "description": "Calling this method — with no request body — sets the requested payment method as the default one, and it will be charged for future invoices. You may not modify other details associated with an existing payment method — add a new one instead. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "Payment Method ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "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": "/makeAPaymentMethodTheDefault"
      },
      "task": true
    },
    {
      "name": "deleteAPaymentMethod",
      "summary": "Delete a payment method",
      "description": "Deletes a credit card. You may not delete the last credit card from the account — add another one first. There is no response other than the HTTP status code.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "Payment Method ID: string",
          "required": true,
          "schema": {
            "title": "id",
            "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": "/deleteAPaymentMethod"
      },
      "task": true
    },
    {
      "name": "getAccountActivity",
      "summary": "View account activity log",
      "description": "Returns entries from the account activity log. By default, the most recent 20 entries are returned — get more by setting limit. You can also restrict the results to entries later than some start (Unix timestamp) or earlier than some end. If you specify a resource_type, only entries for resources of that type are returned. You may also restrict by user and resource_id. Activity log entries include a user_type which is one of \"user\", \"apikey\", or \"system\" depending on where the activity came from,...(description truncated)",
      "input": [
        {
          "name": "limit",
          "type": "number",
          "info": "Return Limit: 123",
          "required": false,
          "schema": {
            "title": "limit",
            "type": "number"
          }
        },
        {
          "name": "start",
          "type": "number",
          "info": "Start Date Range: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "End Date Range: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "resourceType",
          "type": "string",
          "info": "Resource Type: string",
          "required": false,
          "schema": {
            "title": "resourceType",
            "type": "string"
          }
        },
        {
          "name": "user",
          "type": "string",
          "info": "User Name: string",
          "required": false,
          "schema": {
            "title": "user",
            "type": "string"
          }
        },
        {
          "name": "resourceId",
          "type": "string",
          "info": "Resource ID: string",
          "required": false,
          "schema": {
            "title": "resourceId",
            "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": "/getAccountActivity"
      },
      "task": true
    },
    {
      "name": "getStatsQps",
      "summary": "Account-wide DNS queries per second",
      "description": "Returns current queries per second (QPS) for the account. Queries per second (QPS) are reported by the NS1 API for Managed DNS networks using the same method for calculating account, zone, and record-level stats: After five minutes of lag time, NS1 collects data for the next two minutes (minutes 6 and 7), and then the data is averaged from two minutes (120 seconds) to one second to render the final QPS result.",
      "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": "/getStatsQps"
      },
      "task": true
    },
    {
      "name": "getStatsQpsZone",
      "summary": "Zone-level queries per second",
      "description": "Returns current queries per second (QPS) for a specific zone. Queries per second (QPS) are reported by the NS1 API for Managed DNS networks using the same method for calculating account, zone, and record-level stats: After five minutes of lag time, NS1 collects data for the next two minutes (minutes 6 and 7), and then the data is averaged from two minutes (120 seconds) to one second to render the final QPS result.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "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": "/getStatsQpsZone"
      },
      "task": true
    },
    {
      "name": "getStatsQpsZoneDomainType",
      "summary": "Record-level queries per second",
      "description": "Returns current queries per second (QPS) for a specific record. Queries per second (QPS) are reported by the NS1 API for Managed DNS networks using the same method for calculating account, zone, and record-level stats: After five minutes of lag time, NS1 collects data for the next two minutes (minutes 6 and 7), and then the data is averaged from two minutes (120 seconds) to one second to render the final QPS result.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getStatsQpsZoneDomainType"
      },
      "task": true
    },
    {
      "name": "getStatsUsage",
      "summary": "View account-wide usage statistics",
      "description": "Returns statistics and graphs for the entire account over a given period. Stats are returned as a list of stats \"objects\" containing various stats fields that correspond to the given entity. If domain, rectype and zone fields are present in the object, the stats are for the given record; if only the zone field is present, the stats are aggregate stats for the zone; and if none of the fields is present, the stats are aggregate stats for the entire account.\n\nYou may specify the following query par...(description truncated)",
      "input": [
        {
          "name": "period",
          "type": "string",
          "info": "Relative time. Possible values: '1h', '24h', '30d' (Default: '24h'): Must be one of [1h, 24h, 30d]",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "aggregate",
          "type": "boolean",
          "info": "If set, returns aggregated stats across all zones and billing tiers (even if expand and by_tier are true). (Default: true): boolean",
          "required": false,
          "schema": {
            "title": "aggregate",
            "type": "boolean"
          }
        },
        {
          "name": "byTier",
          "type": "boolean",
          "info": "If set, returns stats and graphs for each billing tier (in records_by_tier and queries_by_tier in each stats object). (Default: false): boolean",
          "required": false,
          "schema": {
            "title": "byTier",
            "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": "/getStatsUsage"
      },
      "task": true
    },
    {
      "name": "getStatsUsageZone",
      "summary": "View zone-level usage statistics",
      "description": "See /stats/usage for a detailed explanation of the output and query parameters.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Relative time. Possible values: '1h', '24h', '30d' (Default: '24h'): Must be one of [1h, 24h, 30d]",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "expand",
          "type": "boolean",
          "info": "If set, breaks down stats by zone, and if unset, shows aggregate stats for the entire account. (Default: false): boolean",
          "required": false,
          "schema": {
            "title": "expand",
            "type": "boolean"
          }
        },
        {
          "name": "aggregate",
          "type": "boolean",
          "info": "If set, returns aggregated stats across all zones and billing tiers (even if expand and by_tier are true). (Default: true): boolean",
          "required": false,
          "schema": {
            "title": "aggregate",
            "type": "boolean"
          }
        },
        {
          "name": "byTier",
          "type": "boolean",
          "info": "If set, returns stats and graphs for each billing tier (in records_by_tier and queries_by_tier in each stats object). The first element corresponds to STATIC records/quer...(description truncated): boolean",
          "required": false,
          "schema": {
            "title": "byTier",
            "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": "/getStatsUsageZone"
      },
      "task": true
    },
    {
      "name": "viewRecordLevelUsageStatistics",
      "summary": "View record-level usage statistics",
      "description": "See /stats/usage for a detailed explanation of the output and query parameters. The expand, by_tier, and aggregate flags are ignored for record usage.",
      "input": [
        {
          "name": "zone",
          "type": "string",
          "info": "DNS Zone Name: string",
          "required": true,
          "schema": {
            "title": "zone",
            "type": "string"
          }
        },
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Relative time. Possible values: '1h', '24h', '30d' (Default: '24h'): Must be one of [1h, 24h, 30d]",
          "required": false,
          "schema": {
            "title": "period",
            "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": "/viewRecordLevelUsageStatistics"
      },
      "task": true
    },
    {
      "name": "getPulsarApps",
      "summary": "List pulsar apps",
      "description": "Returns all Pulsar applications in your account.",
      "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": "/getPulsarApps"
      },
      "task": true
    },
    {
      "name": "getPulsarAppsAppID",
      "summary": "View application details",
      "description": "Returns details for a single Pulsar application.",
      "input": [
        {
          "name": "appID",
          "type": "string",
          "info": "Application ID: string",
          "required": true,
          "schema": {
            "title": "appID",
            "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": "/getPulsarAppsAppID"
      },
      "task": true
    },
    {
      "name": "getPulsarAppsAppIDJobs",
      "summary": "Get list of all jobs for an App",
      "description": "Returns a list of all Pulsar jobs in an app.",
      "input": [
        {
          "name": "appID",
          "type": "string",
          "info": "Application ID: string",
          "required": true,
          "schema": {
            "title": "appID",
            "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": "/getPulsarAppsAppIDJobs"
      },
      "task": true
    },
    {
      "name": "getPulsarAppsAppIDJobsJobID",
      "summary": "View job details",
      "description": "Returns details for a single Pulsar job.",
      "input": [
        {
          "name": "appID",
          "type": "string",
          "info": "Application ID: string",
          "required": true,
          "schema": {
            "title": "appID",
            "type": "string"
          }
        },
        {
          "name": "jobID",
          "type": "string",
          "info": "Pulsar Job ID: string",
          "required": true,
          "schema": {
            "title": "jobID",
            "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": "/getPulsarAppsAppIDJobsJobID"
      },
      "task": true
    },
    {
      "name": "getPulsarAppsAppIDJobsJobIDData",
      "summary": "View aggregated performance data",
      "description": "Allowed parameters: start, end, period, geo, asn, agg",
      "input": [
        {
          "name": "appID",
          "type": "string",
          "info": "Application ID: string",
          "required": true,
          "schema": {
            "title": "appID",
            "type": "string"
          }
        },
        {
          "name": "jobID",
          "type": "string",
          "info": "Pulsar Job ID: string",
          "required": true,
          "schema": {
            "title": "jobID",
            "type": "string"
          }
        },
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp. Any data from before this time will be excluded. Defaults to 1 hour before current time: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp. Any data from after this time will be excluded. Defaults to current time.: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Can be used instead of start & end time. If set, will set end time to current time and start time to whatever time is specified by this period. If start time is set, peri...(description truncated): string",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "geo",
          "type": "string",
          "info": "Geographic region. Will filter data to only include results from the specified region. Must be either a 2 letter ISO country code, or US states can also be specified with...(description truncated): string",
          "required": false,
          "schema": {
            "title": "geo",
            "type": "string"
          }
        },
        {
          "name": "agg",
          "type": "string",
          "info": "Specifies a method to use to aggregate data. When there are multiple categories of data being grouped into one (e.x., you query for all geo rather than individual geo reg...(description truncated): string",
          "required": false,
          "schema": {
            "title": "agg",
            "type": "string"
          }
        },
        {
          "name": "asn",
          "type": "number",
          "info": "Specifies an Autonomous System Number to filter for: 123",
          "required": false,
          "schema": {
            "title": "asn",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getPulsarAppsAppIDJobsJobIDData"
      },
      "task": true
    },
    {
      "name": "getPulsarAppsAppIDJobsJobIDAvailability",
      "summary": "View availability data",
      "description": "Returns availability score per resource over time.",
      "input": [
        {
          "name": "appID",
          "type": "string",
          "info": "Application ID: string",
          "required": true,
          "schema": {
            "title": "appID",
            "type": "string"
          }
        },
        {
          "name": "jobID",
          "type": "string",
          "info": "Pulsar Job ID: string",
          "required": true,
          "schema": {
            "title": "jobID",
            "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": "/getPulsarAppsAppIDJobsJobIDAvailability"
      },
      "task": true
    },
    {
      "name": "viewDecisionsForAccount",
      "summary": "View decisions for account",
      "description": "Returns total count of Pulsar decisions per resource.",
      "input": [
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp. Any data from before this time will be excluded. Defaults to 1 hour before current time: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp. Any data from after this time will be excluded. Defaults to current time.: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Can be used instead of start & end time. If set, will set end time to current time and start time to whatever time is specified by this period. If start time is set, peri...(description truncated): string",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "geo",
          "type": "string",
          "info": "Geographic region. Will filter data to only include results from the specified region. Must be either a 2 letter ISO country code, or US states can also be specified with...(description truncated): string",
          "required": false,
          "schema": {
            "title": "geo",
            "type": "string"
          }
        },
        {
          "name": "agg",
          "type": "string",
          "info": "Specifies a method to use to aggregate data. When there are multiple categories of data being grouped into one (e.x., you query for all geo rather than individual geo reg...(description truncated): string",
          "required": false,
          "schema": {
            "title": "agg",
            "type": "string"
          }
        },
        {
          "name": "asn",
          "type": "number",
          "info": "Specifies an Autonomous System Number to filter for: 123",
          "required": false,
          "schema": {
            "title": "asn",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/viewDecisionsForAccount"
      },
      "task": true
    },
    {
      "name": "viewInsufficientDecisionDataForAccount",
      "summary": "View insufficient decision data for account",
      "description": "Returns total count of insufficient data where Pulsar could not make a decision.",
      "input": [
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp. Any data from before this time will be excluded. Defaults to 1 hour before current time: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp. Any data from after this time will be excluded. Defaults to current time.: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Can be used instead of start & end time. If set, will set end time to current time and start time to whatever time is specified by this period. If start time is set, peri...(description truncated): string",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "geo",
          "type": "string",
          "info": "Geographic region. Will filter data to only include results from the specified region. Must be either a 2 letter ISO country code, or US states can also be specified with...(description truncated): string",
          "required": false,
          "schema": {
            "title": "geo",
            "type": "string"
          }
        },
        {
          "name": "agg",
          "type": "string",
          "info": "Specifies a method to use to aggregate data. When there are multiple categories of data being grouped into one (e.x., you query for all geo rather than individual geo reg...(description truncated): string",
          "required": false,
          "schema": {
            "title": "agg",
            "type": "string"
          }
        },
        {
          "name": "asn",
          "type": "number",
          "info": "Specifies an Autonomous System Number to filter for: 123",
          "required": false,
          "schema": {
            "title": "asn",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/viewInsufficientDecisionDataForAccount"
      },
      "task": true
    },
    {
      "name": "getPulsarQueryDecisionRecordDomainType",
      "summary": "View decisions for record",
      "description": "Returns count of Pulsar decisions per resource for a specific record.",
      "input": [
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "DNS Record Type: string",
          "required": true,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp. Any data from before this time will be excluded. Defaults to 1 hour before current time: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp. Any data from after this time will be excluded. Defaults to current time.: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Can be used instead of start & end time. If set, will set end time to current time and start time to whatever time is specified by this period. If start time is set, peri...(description truncated): string",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "geo",
          "type": "string",
          "info": "Geographic region. Will filter data to only include results from the specified region. Must be either a 2 letter ISO country code, or US states can also be specified with...(description truncated): string",
          "required": false,
          "schema": {
            "title": "geo",
            "type": "string"
          }
        },
        {
          "name": "agg",
          "type": "string",
          "info": "Specifies a method to use to aggregate data. When there are multiple categories of data being grouped into one (e.x., you query for all geo rather than individual geo reg...(description truncated): string",
          "required": false,
          "schema": {
            "title": "agg",
            "type": "string"
          }
        },
        {
          "name": "asn",
          "type": "number",
          "info": "Specifies an Autonomous System Number to filter for: 123",
          "required": false,
          "schema": {
            "title": "asn",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getPulsarQueryDecisionRecordDomainType"
      },
      "task": true
    },
    {
      "name": "getPulsarQueryDecisionRecordUndeterminedDomainRectype",
      "summary": "View insufficient decision data for account",
      "description": "Returns total count of insufficient data where Pulsar could not make a decision.",
      "input": [
        {
          "name": "domain",
          "type": "string",
          "info": "DNS Domain Name: string",
          "required": true,
          "schema": {
            "title": "domain",
            "type": "string"
          }
        },
        {
          "name": "rectype",
          "type": "string",
          "info": ": string",
          "required": true,
          "schema": {
            "title": "rectype",
            "type": "string"
          }
        },
        {
          "name": "start",
          "type": "number",
          "info": "Absolute start time in UNIX timestamp. Any data from before this time will be excluded. Defaults to 1 hour before current time: 123",
          "required": false,
          "schema": {
            "title": "start",
            "type": "number"
          }
        },
        {
          "name": "end",
          "type": "number",
          "info": "Absolute end time in UNIX timestamp. Any data from after this time will be excluded. Defaults to current time.: 123",
          "required": false,
          "schema": {
            "title": "end",
            "type": "number"
          }
        },
        {
          "name": "period",
          "type": "string",
          "info": "Can be used instead of start & end time. If set, will set end time to current time and start time to whatever time is specified by this period. If start time is set, peri...(description truncated): string",
          "required": false,
          "schema": {
            "title": "period",
            "type": "string"
          }
        },
        {
          "name": "geo",
          "type": "string",
          "info": "Geographic region. Will filter data to only include results from the specified region. Must be either a 2 letter ISO country code, or US states can also be specified with...(description truncated): string",
          "required": false,
          "schema": {
            "title": "geo",
            "type": "string"
          }
        },
        {
          "name": "agg",
          "type": "string",
          "info": "Specifies a method to use to aggregate data. When there are multiple categories of data being grouped into one (e.x., you query for all geo rather than individual geo reg...(description truncated): string",
          "required": false,
          "schema": {
            "title": "agg",
            "type": "string"
          }
        },
        {
          "name": "asn",
          "type": "number",
          "info": "Specifies an Autonomous System Number to filter for: 123",
          "required": false,
          "schema": {
            "title": "asn",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getPulsarQueryDecisionRecordUndeterminedDomainRectype"
      },
      "task": true
    }
  ],
  "views": []
}