{ "id": "@itentialopensource/adapter-splunk", "type": "Adapter", "export": "Splunk", "title": "Splunk", "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": "getDataCommandsByName", "summary": "getDataCommandsByName", "description": "getDataCommandsByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "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": "/getDataCommandsByName" }, "task": true }, { "name": "getSavedSearches", "summary": "getSavedSearches", "description": "getSavedSearches", "input": [ { "name": "earliestTime10202022", "type": "string", "info": "earliest_time10-20-2022: string", "required": true, "schema": { "title": "earliestTime10202022", "type": "string" } }, { "name": "latestTime", "type": "string", "info": "latest_time: string", "required": true, "schema": { "title": "latestTime", "type": "string" } }, { "name": "listDefaultActionArgs", "type": "string", "info": "listDefaultActionArgs: string", "required": true, "schema": { "title": "listDefaultActionArgs", "type": "string" } }, { "name": "addOrphanField", "type": "string", "info": "add_orphan_field: string", "required": true, "schema": { "title": "addOrphanField", "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": "/getSavedSearches" }, "task": true }, { "name": "deleteSavedSearchesByName", "summary": "deleteSavedSearchesByName", "description": "deleteSavedSearchesByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "type": "string", "definitions": {} } } ], "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": "/deleteSavedSearchesByName" }, "task": true }, { "name": "getSavedSearchesByName", "summary": "getSavedSearchesByName", "description": "getSavedSearchesByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "earliestTime10202022", "type": "string", "info": "earliest_time10-20-2022: string", "required": true, "schema": { "title": "earliestTime10202022", "type": "string" } }, { "name": "latestTime", "type": "string", "info": "latest_time: string", "required": true, "schema": { "title": "latestTime", "type": "string" } }, { "name": "listDefaultActionArgs", "type": "string", "info": "listDefaultActionArgs: string", "required": true, "schema": { "title": "listDefaultActionArgs", "type": "string" } }, { "name": "addOrphanField", "type": "string", "info": "add_orphan_field: string", "required": true, "schema": { "title": "addOrphanField", "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": "/getSavedSearchesByName" }, "task": true }, { "name": "postSavedSearches", "summary": "postSavedSearches", "description": "postSavedSearches", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "actions": "email", "action.email.to": "nobody@example.com, info@example.com", "search": "my search here" }, "definitions": {} } } ], "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": "/postSavedSearches" }, "task": true }, { "name": "postSavedSearchesAcknowledge", "summary": "postSavedSearchesAcknowledge", "description": "postSavedSearchesAcknowledge", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "key": "string" }, "definitions": {} } } ], "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": "/postSavedSearchesAcknowledge" }, "task": true }, { "name": "postSavedSearchesDispatchByName", "summary": "postSavedSearchesDispatchByName", "description": "postSavedSearchesDispatchByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "trigger_actions": true, "dispatchAs": "owner", "dispatch.adhoc_search_level": "verbose", "dispatch.now": true, "force_dispatch": true, "replay_speed": 1, "replay_et": "earliest", "replay_lt": "latest" }, "definitions": {} } } ], "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": "/postSavedSearchesDispatchByName" }, "task": true }, { "name": "getSavedSearchesHistoryByName", "summary": "getSavedSearchesHistoryByName", "description": "getSavedSearchesHistoryByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "savedsearch", "type": "string", "info": "savedsearch: string", "required": true, "schema": { "title": "savedsearch", "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": "/getSavedSearchesHistoryByName" }, "task": true }, { "name": "postSavedSearchesReschedule", "summary": "postSavedSearchesReschedule", "description": "postSavedSearchesReschedule", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "schedule_time": "2012-08-15T14:11:01Z" }, "definitions": {} } } ], "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": "/postSavedSearchesReschedule" }, "task": true }, { "name": "getSavedSearchesScheduledItemsByName", "summary": "getSavedSearchesScheduledItemsByName", "description": "getSavedSearchesScheduledItemsByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "earliestTime", "type": "string", "info": "earliest_time: string", "required": true, "schema": { "title": "earliestTime", "type": "string" } }, { "name": "latestTime", "type": "string", "info": "latest_time: string", "required": true, "schema": { "title": "latestTime", "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": "/getSavedSearchesScheduledItemsByName" }, "task": true }, { "name": "getSavedSearchesSupresssByName", "summary": "getSavedSearchesSupresssByName", "description": "getSavedSearchesSupresssByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "expiration", "type": "string", "info": "expiration: string", "required": true, "schema": { "title": "expiration", "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": "/getSavedSearchesSupresssByName" }, "task": true }, { "name": "getScheduledViews", "summary": "getScheduledViews", "description": "getScheduledViews", "input": [ { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "f", "type": "string", "info": "f: string", "required": true, "schema": { "title": "f", "type": "string" } }, { "name": "offset", "type": "string", "info": "offset: string", "required": true, "schema": { "title": "offset", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "sort_dir: string", "required": true, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "sort_key: string", "required": true, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortMode", "type": "string", "info": "sort_mode: string", "required": true, "schema": { "title": "sortMode", "type": "string" } }, { "name": "summarize", "type": "string", "info": "summarize: string", "required": true, "schema": { "title": "summarize", "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": "/getScheduledViews" }, "task": true }, { "name": "deleteScheduledViewByName", "summary": "deleteScheduledViewByName", "description": "deleteScheduledViewByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "type": "string", "definitions": {} } } ], "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": "/deleteScheduledViewByName" }, "task": true }, { "name": "getScheduledViewByName", "summary": "getScheduledViewByName", "description": "getScheduledViewByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "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": "/getScheduledViewByName" }, "task": true }, { "name": "postScheduledViewByName", "summary": "postScheduledViewByName", "description": "postScheduledViewByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "action.email.to": "user1@test.com,user2@test.com", "action.email*": "", "cron_schedule": "*/5 * * * * ", "description": "description", "disabled": false, "is_scheduled": true, "next_scheduled_time": "" }, "definitions": {} } } ], "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": "/postScheduledViewByName" }, "task": true }, { "name": "postScheduledViewDispatch", "summary": "postScheduledViewDispatch", "description": "postScheduledViewDispatch", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "dispatch.now": true, "force_dispatch": true, "trigger_actions": true, "args.*": "$username$" }, "definitions": {} } } ], "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": "/postScheduledViewDispatch" }, "task": true }, { "name": "getScheduledViewHistory", "summary": "getScheduledViewHistory", "description": "getScheduledViewHistory", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "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": "/getScheduledViewHistory" }, "task": true }, { "name": "postScheduledViewHistory", "summary": "postScheduledViewHistory", "description": "postScheduledViewHistory", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "schedule_time": "2013-02-15T14:11:01Z" }, "definitions": {} } } ], "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": "/postScheduledViewHistory" }, "task": true }, { "name": "getScheduledViewScheduledTimes", "summary": "getScheduledViewScheduledTimes", "description": "getScheduledViewScheduledTimes", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "earliestTime", "type": "string", "info": "earliest_time: string", "required": true, "schema": { "title": "earliestTime", "type": "string" } }, { "name": "latestTime", "type": "string", "info": "latest_time: string", "required": true, "schema": { "title": "latestTime", "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": "/getScheduledViewScheduledTimes" }, "task": true }, { "name": "getSearchJobs", "summary": "getSearchJobs", "description": "getSearchJobs", "input": [ { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "f", "type": "string", "info": "f: string", "required": true, "schema": { "title": "f", "type": "string" } }, { "name": "offset", "type": "string", "info": "offset: string", "required": true, "schema": { "title": "offset", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "sort_dir: string", "required": true, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "sort_key: string", "required": true, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortMode", "type": "string", "info": "sort_mode: string", "required": true, "schema": { "title": "sortMode", "type": "string" } }, { "name": "summarize", "type": "string", "info": "summarize: string", "required": true, "schema": { "title": "summarize", "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": "/getSearchJobs" }, "task": true }, { "name": "postSearchJobs", "summary": "postSearchJobs", "description": "postSearchJobs", "input": [ { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "search_mode": "realtime", "indexedRealtime": 1, "indexedRealtimeOffset": "300", "adhoc_search_level": "verbose", "auto_cancel": 0, "auto_finalize_ec": 0, "auto_pause": 0, "id": "id", "max_count": 10000, "namespace": "namespace" }, "definitions": {} } } ], "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": "/postSearchJobs" }, "task": true }, { "name": "getSearchJobsExport", "summary": "getSearchJobsExport", "description": "getSearchJobsExport", "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": "/getSearchJobsExport" }, "task": true }, { "name": "postSearchJobsExport", "summary": "postSearchJobsExport", "description": "postSearchJobsExport", "input": [ { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "search": "string", "auto_cancel": 0, "auto_finalize_ec": 0, "max_time": 100, "rt_blocking": false }, "definitions": {} } } ], "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": "/postSearchJobsExport" }, "task": true }, { "name": "deleteSearchJobsById", "summary": "deleteSearchJobsById", "description": "deleteSearchJobsById", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "type": "string", "definitions": {} } } ], "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": "/deleteSearchJobsById" }, "task": true }, { "name": "getSearchJobsById", "summary": "getSearchJobsById", "description": "getSearchJobsById", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "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": "/getSearchJobsById" }, "task": true }, { "name": "postSearchJobsById", "summary": "postSearchJobsById", "description": "postSearchJobsById", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "custom.*": "string" }, "definitions": {} } } ], "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": "/postSearchJobsById" }, "task": true }, { "name": "postSearchJobsByIdControl", "summary": "postSearchJobsByIdControl", "description": "postSearchJobsByIdControl", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "action": "finalize" }, "definitions": {} } } ], "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": "/postSearchJobsByIdControl" }, "task": true }, { "name": "getSearchJobsByIdEvents", "summary": "getSearchJobsByIdEvents", "description": "getSearchJobsByIdEvents", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "maxLines", "type": "string", "info": "max_lines: string", "required": true, "schema": { "title": "maxLines", "type": "string" } }, { "name": "outputMode", "type": "string", "info": "output_mode: string", "required": true, "schema": { "title": "outputMode", "type": "string" } }, { "name": "truncationMode", "type": "string", "info": "truncation_mode: string", "required": true, "schema": { "title": "truncationMode", "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": "/getSearchJobsByIdEvents" }, "task": true }, { "name": "getSearchJobsByIdResults", "summary": "getSearchJobsByIdResults", "description": "getSearchJobsByIdResults", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "addSummaryToMetadata", "type": "string", "info": "add_summary_to_metadata: string", "required": true, "schema": { "title": "addSummaryToMetadata", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "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": "/getSearchJobsByIdResults" }, "task": true }, { "name": "getSearchJobsByIdResultsWithOptions", "summary": "getSearchJobsByIdResults with query data", "description": "getSearchJobsByIdResults with query data", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "queryData", "type": "object", "info": "query options object (e.g. addSummaryToMetadata, count, outputMode, f, offset)", "required": false, "schema": { "title": "queryData", "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": "/getSearchJobsByIdResultsWithOptions" }, "task": true }, { "name": "getSearchJobsByIdResultsPreview", "summary": "getSearchJobsByIdResultsPreview", "description": "getSearchJobsByIdResultsPreview", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "addSummaryToMetadata", "type": "string", "info": "add_summary_to_metadata: string", "required": true, "schema": { "title": "addSummaryToMetadata", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "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": "/getSearchJobsByIdResultsPreview" }, "task": true }, { "name": "getSearchJobsByIdResultsPreviewWithOptions", "summary": "getSearchJobsByIdResultsPreviewWithOptions", "description": "getSearchJobsByIdResultsPreviewWithOptions", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "queryData", "type": "object", "info": "query options object (e.g. addSummaryToMetadata, count, f, offset, outputMode)", "required": false, "schema": { "title": "queryData", "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": "/getSearchJobsByIdResultsPreviewWithOptions" }, "task": true }, { "name": "getSearchJobsSearchLogs", "summary": "getSearchJobsSearchLogs", "description": "getSearchJobsSearchLogs", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "attachment", "type": "string", "info": "attachment: string", "required": true, "schema": { "title": "attachment", "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": "/getSearchJobsSearchLogs" }, "task": true }, { "name": "getSearchJobsbyIdSummary", "summary": "getSearchJobsbyIdSummary", "description": "getSearchJobsbyIdSummary", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "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": "/getSearchJobsbyIdSummary" }, "task": true }, { "name": "getSearchJobsByIdTimeline", "summary": "getSearchJobsByIdTimeline", "description": "getSearchJobsByIdTimeline", "input": [ { "name": "searchId", "type": "string", "info": "search_id: string", "required": true, "schema": { "title": "searchId", "type": "string" } }, { "name": "outputTimeFormat", "type": "string", "info": "output_time_format: string", "required": true, "schema": { "title": "outputTimeFormat", "type": "string" } }, { "name": "timeFormat", "type": "string", "info": "time_format: string", "required": true, "schema": { "title": "timeFormat", "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": "/getSearchJobsByIdTimeline" }, "task": true }, { "name": "getSearchParser", "summary": "getSearchParser", "description": "getSearchParser", "input": [ { "name": "q", "type": "string", "info": "q: string", "required": true, "schema": { "title": "q", "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": "/getSearchParser" }, "task": true }, { "name": "getSearchScheduler", "summary": "getSearchScheduler", "description": "getSearchScheduler", "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": "/getSearchScheduler" }, "task": true }, { "name": "postSearchSchedulerStatus", "summary": "postSearchSchedulerStatus", "description": "postSearchSchedulerStatus", "input": [ { "name": "body", "type": "object", "info": "body: object", "required": true, "schema": { "example": { "disabled": false }, "definitions": {} } } ], "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": "/postSearchSchedulerStatus" }, "task": true }, { "name": "getSearchTimerParser", "summary": "getSearchTimerParser", "description": "getSearchTimerParser", "input": [ { "name": "time", "type": "string", "info": "time: string", "required": true, "schema": { "title": "time", "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": "/getSearchTimerParser" }, "task": true }, { "name": "getSearchTypeHead", "summary": "getSearchTypeHead", "description": "getSearchTypeHead", "input": [ { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "prefix", "type": "string", "info": "prefix: string", "required": true, "schema": { "title": "prefix", "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": "/getSearchTypeHead" }, "task": true }, { "name": "getAlertActions", "summary": "getAlertActions", "description": "getAlertActions", "input": [ { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "f", "type": "string", "info": "f: string", "required": true, "schema": { "title": "f", "type": "string" } }, { "name": "offset", "type": "string", "info": "offset: string", "required": true, "schema": { "title": "offset", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "sort_dir: string", "required": true, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "sort_key: string", "required": true, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortMode", "type": "string", "info": "sort_mode: string", "required": true, "schema": { "title": "sortMode", "type": "string" } }, { "name": "summarize", "type": "string", "info": "summarize: string", "required": true, "schema": { "title": "summarize", "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": "/getAlertActions" }, "task": true }, { "name": "getFiredAlerts", "summary": "getFiredAlerts", "description": "getFiredAlerts", "input": [ { "name": "count", "type": "string", "info": "count: string", "required": true, "schema": { "title": "count", "type": "string" } }, { "name": "f", "type": "string", "info": "f: string", "required": true, "schema": { "title": "f", "type": "string" } }, { "name": "offset", "type": "string", "info": "offset: string", "required": true, "schema": { "title": "offset", "type": "string" } }, { "name": "search", "type": "string", "info": "search: string", "required": true, "schema": { "title": "search", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "sort_dir: string", "required": true, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "sort_key: string", "required": true, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortMode", "type": "string", "info": "sort_mode: string", "required": true, "schema": { "title": "sortMode", "type": "string" } }, { "name": "summarize", "type": "string", "info": "summarize: string", "required": true, "schema": { "title": "summarize", "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": "/getFiredAlerts" }, "task": true }, { "name": "getFiredAlertsbyName", "summary": "getFiredAlertsbyName", "description": "getFiredAlertsbyName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "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": "/getFiredAlertsbyName" }, "task": true }, { "name": "deleteFiredAlertsByName", "summary": "deleteFiredAlertsByName", "description": "deleteFiredAlertsByName", "input": [ { "name": "name", "type": "string", "info": "name: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "type": "string", "definitions": {} } } ], "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": "/deleteFiredAlertsByName" }, "task": true }, { "name": "getDataCommands", "summary": "getDataCommands", "description": "getDataCommands", "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": "/getDataCommands" }, "task": true } ], "views": [] }