@itentialopensource/adapter-moogsoft_saas

{ "id": "@itentialopensource/adapter-moogsoft_saas", "type": "Adapter", "export": "MoogsoftSaas", "title": "Moogsoft_saas", "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": "alertDetails", "summary": "alertDetails", "description": "Returns a single alert.", "input": [ { "name": "alertId", "type": "string", "info": "ID of the alert to return. Returns 400 (Invalid ID Supplied) if this value is anything other than a non-negative integer.: string", "required": true, "schema": { "title": "alertId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "MoogResponseAlertWebDto", "required": [ "status" ], "type": "object", "properties": { "data": { "title": "AlertDetails", "type": "object", "properties": { "assignee": { "type": "string", "description": "email of the user who is assigned to the incident/alert", "example": "test@moogsoft.com" }, "description": { "type": "string", "description": "description that usually contains the incident/alert ID, source and service", "example": "1 Source: www.your-source.com Affected retail, support\n" }, "first_event_time": { "type": "integer", "description": "Epoch timestamp in seconds of the first event for this incident", "format": "int64", "example": 1607985505 }, "last_event_time": { "type": "integer", "description": "Epoch timestamp in seconds of the last event for this incident", "format": "int64", "example": 1607985505 }, "severity": { "title": "Severity", "enum": [ "clear", "unknown", "warning", "minor", "major", "critical" ], "type": "string", "description": "Severity Level (case-insensitive)" }, "status": { "title": "Status", "enum": [ "error", "open", "in progress", "superseded", "resolved", "closed" ], "type": "string", "description": "Status for incidents and alerts (case-insensitive)" }, "alert_id": { "type": "integer", "format": "int64" }, "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "event_count": { "type": "integer", "format": "int32" }, "incidents": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" }, "last_status_change_time": { "type": "integer", "format": "int64" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "service": { "type": "array", "items": { "type": "string" }, "description": "" }, "source": { "type": "string" }, "tags": { "type": "object" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "active_incidents_count": { "type": "integer", "format": "int32" }, "service_count": { "type": "integer", "format": "int32" } } }, "status": { "type": "string", "description": "Success status indicator (always \"success\")", "example": "success" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/alertDetails" }, "task": true }, { "name": "updateAlert", "summary": "updateAlert", "description": "Updates a single alert.", "input": [ { "name": "alertId", "type": "number", "info": ": 123", "required": true, "schema": { "title": "alertId", "type": "number" } }, { "name": "body", "type": "object", "info": ": {\"assignee\": \"string\", \"status\": \"Must be one of [error, open, in progress, superseded, resolved, closed]\"}", "required": false, "schema": { "title": "AlertUpdateRequest", "type": "object", "properties": { "assignee": { "type": "string", "description": "Username of the assignee, specified as one string. Returns an error if the username is not found.", "example": "john.doe@company.com" }, "status": { "title": "Status", "enum": [ "error", "open", "in progress", "superseded", "resolved", "closed" ], "type": "string", "description": "Status for incidents and alerts (case-insensitive)" } } } } ], "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": "/updateAlert" }, "task": true }, { "name": "listAlerts", "summary": "listAlerts", "description": "Get a list of all alerts with matching criteria.", "input": [ { "name": "filter", "type": "string", "info": "Return only alerts that match this filter. To specify an alerts filter, do the following. Go to the Alerts table in the UI. Enter and validate your filter in the searc...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "incidentId", "type": "number", "info": "Returns alerts that belong to this incident ID. (Takes precedence over filter: 123", "required": false, "schema": { "title": "incidentId", "type": "number" } }, { "name": "limit", "type": "number", "info": "Maximum number of alerts to return. This is equivalent to the maximum number of alerts per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "sortBy", "type": "string", "info": "Field to sort by: string", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "sortOrder", "type": "string", "info": "Sort order: Must be one of [asc, desc]", "required": false, "schema": { "title": "sortOrder", "type": "string" } }, { "name": "start", "type": "number", "info": "Get the list of alerts starting at position [offset-1]. This is generally a multiple of the page size minus 1. If you are retrieving alerts 50 at a time, for example, set...(description truncated): 123", "required": false, "schema": { "title": "start", "type": "number" } }, { "name": "utcOffset", "type": "string", "info": "UTC Offset: string", "required": false, "schema": { "title": "utcOffset", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "MoogResponseAlertList", "required": [ "status", "data" ], "type": "object", "properties": { "status": { "type": "string", "description": "Success status indicator (always \"success\")", "example": "success" }, "data": { "title": "AlertList", "type": "object", "properties": { "result": { "type": "array", "items": { "title": "AlertDetails", "type": "object", "properties": { "assignee": { "type": "string", "description": "email of the user who is assigned to the incident/alert", "example": "test@moogsoft.com" }, "description": { "type": "string", "description": "description that usually contains the incident/alert ID, source and service", "example": "1 Source: www.your-source.com Affected retail, support\n" }, "first_event_time": { "type": "integer", "description": "Epoch timestamp in seconds of the first event for this incident", "format": "int64", "example": 1607985505 }, "last_event_time": { "type": "integer", "description": "Epoch timestamp in seconds of the last event for this incident", "format": "int64", "example": 1607985505 }, "severity": { "title": "Severity", "enum": [ "clear", "unknown", "warning", "minor", "major", "critical" ], "type": "string", "description": "Severity Level (case-insensitive)" }, "status": { "title": "Status", "enum": [ "error", "open", "in progress", "superseded", "resolved", "closed" ], "type": "string", "description": "Status for incidents and alerts (case-insensitive)" }, "alert_id": { "type": "integer", "format": "int64" }, "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "event_count": { "type": "integer", "format": "int32" }, "incidents": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" }, "last_status_change_time": { "type": "integer", "format": "int64" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "service": { "type": "array", "items": { "type": "string" }, "description": "" }, "source": { "type": "string" }, "tags": { "type": "object" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "active_incidents_count": { "type": "integer", "format": "int32" }, "service_count": { "type": "integer", "format": "int32" } } }, "description": "" } } } }, "description": "Alerts API AlertList response body" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAlerts" }, "task": true }, { "name": "updateAlerts", "summary": "updateAlerts", "description": "Updates bulk alerts.", "input": [ { "name": "body", "type": "object", "info": ": {\"assignee\": \"string\", \"status\": \"Must be one of [error, open, in progress, superseded, resolved, closed]\", \"ids\": \"array\"}", "required": false, "schema": { "title": "BulkAlertUpdateRequest", "required": [ "ids" ], "type": "object", "properties": { "assignee": { "type": "string", "description": "Username of the assignee, specified as one string. Returns an error if the username is not found.", "example": "john.doe@company.com" }, "status": { "title": "Status", "enum": [ "error", "open", "in progress", "superseded", "resolved", "closed" ], "type": "string", "description": "Status for incidents and alerts (case-insensitive)" }, "ids": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Unique alert ids to update" } } } } ], "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": "/updateAlerts" }, "task": true }, { "name": "incidentIds", "summary": "incidentIds", "description": "Get a list of all incidentIds for an alert.", "input": [ { "name": "alertId", "type": "number", "info": "ID of the alert to use. Returns 400 (Invalid ID Supplied) if this value is anything other than a non-negative integer.: 123", "required": true, "schema": { "title": "alertId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "MoogResponseIncidentIdList", "required": [ "status", "data" ], "type": "object", "properties": { "status": { "type": "string", "description": "Success status indicator (always \"success\")", "example": "success" }, "data": { "title": "IncidentIdList", "type": "object", "properties": { "result": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" } } } }, "description": "Alerts API IncidentIdList response body" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/incidentIds" }, "task": true }, { "name": "alertDtoColumnNames", "summary": "alertDtoColumnNames", "description": "Column names for filtering alerts in outbound integrations, returns a list of strings", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "MoogResponseColumnsDto", "required": [ "status" ], "type": "object", "properties": { "data": { "title": "ColumnsDto", "type": "object", "properties": { "fields": { "type": "array", "items": { "title": "ColumnInfo", "type": "object", "properties": { "internalName": { "type": "string" }, "type": { "type": "string" }, "uiName": { "type": "string" } } }, "description": "" } } }, "status": { "type": "string", "description": "Success status indicator (always \"success\")", "example": "success" } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/alertDtoColumnNames" }, "task": true }, { "name": "getAlertCount", "summary": "getAlertCount", "description": "Returns a count of all alerts that match the following criteria.", "input": [ { "name": "filter", "type": "string", "info": "Return only alerts that match this filter. To specify an alerts filter, do the following. Go to the Alerts table in the UI. Enter and validate your filter in the searc...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "Maximum number of alerts to count.: 123", "required": false, "schema": { "title": "limit", "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": "/getAlertCount" }, "task": true }, { "name": "search", "summary": "search", "description": "Search for alerts matching the following criteria.", "input": [ { "name": "eventTime", "type": "number", "info": "Event time for the alerts. Must be a UNIX timestamp. Not used if not present.: 123", "required": false, "schema": { "title": "eventTime", "type": "number" } }, { "name": "namespace", "type": "string", "info": "Namespace of the alerts to search: string", "required