@itentialopensource/adapter-datadog/pronghorn.json

This adapter integrates with system: Datadog.

{
  "id": "@itentialopensource/adapter-datadog",
  "type": "Adapter",
  "export": "Datadog",
  "title": "Datadog",
  "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": "createUser",
      "summary": "### Overview\n\nCreate a user for your organization.\n\n### ARGUMENTS\n\n* **`handle`** [*required*]: The user handle, must be a valid email.\n* **`name`** [*optional*, *default*=**None**]: The name of the user.\n* **`access_role`** [*optional*, *default*=**st**]: The access role of the user. Choose from:\n    *  **st** (standard user),\n    *  **adm** (admin user),\n    *  **ro** (read-only user).\n    *Note: users can be created with admin access role only with application keys belonging to administrators...(description truncated)",
      "description": "### Overview\n\nCreate a user for your organization.\n\n### ARGUMENTS\n\n* **`handle`** [*required*]: The user handle, must be a valid email.\n* **`name`** [*optional*, *default*=**None**]: The name of the user.\n* **`access_role`** [*optional*, *default*=**st**]: The access role of the user. Choose from:\n    *  **st** (standard user),\n    *  **adm** (admin user),\n    *  **ro** (read-only user).\n    *Note: users can be created with admin access role only with application keys belonging to administrators...(description truncated)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "POST body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/createUser"
      },
      "task": true
    },
    {
      "name": "getAllUsers",
      "summary": "### Overview\n\nGet all user for your organization.\n\n### Arguments\n\nThis endpoint takes no JSON argument.",
      "description": "### Overview\n\nGet all user for your organization.\n\n### Arguments\n\nThis endpoint takes no JSON argument.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/getAllUsers"
      },
      "task": true
    },
    {
      "name": "getUser",
      "summary": "### Overview\n\nGet a user details.\n\n### Arguments\n\n* **`user_handle`** [*required*]: The handle of the user.",
      "description": "### Overview\n\nGet a user details.\n\n### Arguments\n\n* **`user_handle`** [*required*]: The handle of the user.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/getUser"
      },
      "task": true
    },
    {
      "name": "updateUser",
      "summary": "### Overview\n\nUpdate a user informations,\n\n**Note**: It can only be used with application keys belonging to administrators.\n\n##### ARGUMENTS\n* **`id`** [*required*]: The handle of the user.\n* **`name`** [*optional*, *default*=**None**]: The new name of the user.\n* **`email`** [*optional*, *default*=**None**]: The new email of the user.\n* **`disabled`** [*optional*, *default*=**None**]: The new disabled status of the user.\n* **`access_role`** [*optional*, *default*=**st**]: The access role of the...(description truncated)",
      "description": "### Overview\n\nUpdate a user informations,\n\n**Note**: It can only be used with application keys belonging to administrators.\n\n##### ARGUMENTS\n* **`id`** [*required*]: The handle of the user.\n* **`name`** [*optional*, *default*=**None**]: The new name of the user.\n* **`email`** [*optional*, *default*=**None**]: The new email of the user.\n* **`disabled`** [*optional*, *default*=**None**]: The new disabled status of the user.\n* **`access_role`** [*optional*, *default*=**st**]: The access role of the...(description truncated)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "PUT body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/updateUser"
      },
      "task": true
    },
    {
      "name": "disableUser",
      "summary": "### Overview\n\nDelete a user from an organization.\n\n**Note**: This endpoint can only be used with application keys belonging to administrators.\n\n### Arguments\n\n* **`id`** [*required*]: The handle of the user.",
      "description": "### Overview\n\nDelete a user from an organization.\n\n**Note**: This endpoint can only be used with application keys belonging to administrators.\n\n### Arguments\n\n* **`id`** [*required*]: The handle of the user.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/disableUser"
      },
      "task": true
    },
    {
      "name": "authenticationCheck",
      "summary": "All requests to Datadog's API must be authenticated. Requests that write data require *reporting access* and require an `API key`. Requests that read data require *full access* and also require an `application key`.\n\n[Manage your account's API and application keys](https://app.datadoghq.com/account/settings#api).\n\nThis GET call just checks to see if an API call key is valid.",
      "description": "All requests to Datadog's API must be authenticated. Requests that write data require *reporting access* and require an `API key`. Requests that read data require *full access* and also require an `application key`.\n\n[Manage your account's API and application keys](https://app.datadoghq.com/account/settings#api).\n\nThis GET call just checks to see if an API call key is valid.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "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": "/authenticationCheck"
      },
      "task": true
    },
    {
      "name": "postACheckStatus",
      "summary": "### Overview\n\nThis POST call allows for you to POST check statuses for use with monitors\n\n### Arguments\n\n* **`check`** *[required]*: The text for the message\n\n* **`host_name`** *[required]*: The name of the host submitting the check\n\n* **`status`** *[optional]*: An integer for the status of the check:\n    * 0 : OK\n    * 1 : WARNING\n    * 2 : CRITICAL\n    * 3 : UNKNOWN\n\n\n* **`timestamp`** *[optional]*: POSIX timestamp of the event.\n\n* **`message`** *[optional]*:   A description of why this stat...(description truncated)",
      "description": "### Overview\n\nThis POST call allows for you to POST check statuses for use with monitors\n\n### Arguments\n\n* **`check`** *[required]*: The text for the message\n\n* **`host_name`** *[required]*: The name of the host submitting the check\n\n* **`status`** *[optional]*: An integer for the status of the check:\n    * 0 : OK\n    * 1 : WARNING\n    * 2 : CRITICAL\n    * 3 : UNKNOWN\n\n\n* **`timestamp`** *[optional]*: POSIX timestamp of the event.\n\n* **`message`** *[optional]*:   A description of why this stat...(description truncated)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "POST body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/postACheckStatus"
      },
      "task": true
    },
    {
      "name": "replyToComment",
      "summary": "### Overview\n\nThis POST call allows for you to POST status messages to a previous post via ID.\n\n### Arguments\n\n* **`message`** [*required*]: The comment text.\n\n* **`handle`** [*optional*, *default* = **application key owner**]: The handle of the user making the comment.\n\n* **`related_event_id`** [*optional*, *default* = **None**]: The id of another comment or event to reply to.",
      "description": "### Overview\n\nThis POST call allows for you to POST status messages to a previous post via ID.\n\n### Arguments\n\n* **`message`** [*required*]: The comment text.\n\n* **`handle`** [*optional*, *default* = **application key owner**]: The handle of the user making the comment.\n\n* **`related_event_id`** [*optional*, *default* = **None**]: The id of another comment or event to reply to.",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "POST body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/replyToComment"
      },
      "task": true
    },
    {
      "name": "editAComment",
      "summary": "### Overview\n\nThis POST call allows for you to change a previously posted comment by commentId\n\n### Arguments\n\n* **`message`** [*optional*, *default* = **original message**]: The comment text.\n\n* **`handle`** [*optional*, *default* = **Application key owner**]: The handle of the user making the comment.",
      "description": "### Overview\n\nThis POST call allows for you to change a previously posted comment by commentId\n\n### Arguments\n\n* **`message`** [*optional*, *default* = **original message**]: The comment text.\n\n* **`handle`** [*optional*, *default* = **Application key owner**]: The handle of the user making the comment.",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "PUT body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/editAComment"
      },
      "task": true
    },
    {
      "name": "deleteAComment",
      "summary": "### Overview\n\nThiscall allows for you to DELETE a previously posted comment by with a given  .\n\n### Arguments\n\nThis endpoint takes no JSON arguments.",
      "description": "### Overview\n\nThiscall allows for you to DELETE a previously posted comment by with a given  .\n\n### Arguments\n\nThis endpoint takes no JSON arguments.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/deleteAComment"
      },
      "task": true
    },
    {
      "name": "createADashboard",
      "summary": "### Overview\n\nCreate a Dashboard in Datadog.\n\n### Arguments\n\n* **`title`** [*required*]: Title of the dashboard.\n* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:\n    * **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com//graphing/widgets)\n    * **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.\n* **`layout_type`** [*required*]: Layout type of the dashboard. Available value...(description truncated)",
      "description": "### Overview\n\nCreate a Dashboard in Datadog.\n\n### Arguments\n\n* **`title`** [*required*]: Title of the dashboard.\n* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:\n    * **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com//graphing/widgets)\n    * **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.\n* **`layout_type`** [*required*]: Layout type of the dashboard. Available value...(description truncated)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "POST body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/createADashboard"
      },
      "task": true
    },
    {
      "name": "updateADashboard",
      "summary": "### Overview\n\nUpdate a Dashboard in Datadog.\n\n### Arguments\n\n* **`title`** [*required*]: Title of the dashboard.\n* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:\n    * **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com/graphing/widgets)\n    * **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.\n* **`layout_type`** [*required*]: Layout type of the dashboard. Available values...(description truncated)",
      "description": "### Overview\n\nUpdate a Dashboard in Datadog.\n\n### Arguments\n\n* **`title`** [*required*]: Title of the dashboard.\n* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:\n    * **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com/graphing/widgets)\n    * **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.\n* **`layout_type`** [*required*]: Layout type of the dashboard. Available values...(description truncated)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "PUT body parameter",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        },
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicationKey",
            "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": "/updateADashboard"
      },
      "task": true
    },
    {
      "name": "deleteADashboard",
      "summary": "### Overview\n\nDelete an existing dashboard.\n\n### Arguments\n\nThis end point takes no JSON arguments.",
      "description": "### Overview\n\nDelete an existing dashboard.\n\n### Arguments\n\nThis end point takes no JSON arguments.",
      "input": [
        {
          "name": "apiKey",
          "type": "string",
          "info": "Your Datadog API key",
          "required": true,
          "schema": {
            "title": "apiKey",
            "type": "string"
          }
        },
        {
          "name": "applicationKey",
          "type": "string",
          "info": "Your Datadog application key",
          "required": true,
          "schema": {
            "title": "applicatio