Kibana

Learn how to use Kibana with Composio

Overview

SLUG

KIBANA

Description

Kibana is a visualization and analytics platform for Elasticsearch, offering dashboards, data exploration, and monitoring capabilities for gaining insights from data

Authentication Details

username
stringRequired
password
stringRequired
full
stringDefaults to https://localhost:5601Required
full
stringDefaults to https://localhost:5601Required
generic_api_key
stringRequired

Tools

SLUG: KIBANA_DELETE_ACTION

Tool to delete an action in kibana. use when you need to remove a specific action by its id, optionally within a specific space.

Action Parameters

action_id
stringRequired
space_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_ALERTING_RULES

Tool to delete an alerting rule in kibana. use when you need to remove a specific alerting rule by its id.

Action Parameters

id
stringRequired
kbn_xsrf
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_CONNECTORS

Tool to delete a connector in kibana. use when you need to remove an existing connector.

Action Parameters

id
stringRequired
space_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_FLEET_OUTPUT

Tool to delete a specific output configuration in kibana fleet. use when you need to remove an existing output by its id.

Action Parameters

elastic_api_version
stringDefaults to 2023-10-31
kbn_xsrf
stringDefaults to true
output_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_FLEET_PROXY

Tool to delete a specific fleet proxy configuration by its id. use when you need to remove an existing proxy setup.

Action Parameters

kbnXsrf
stringDefaults to true
proxyId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_LIST

Deletes a list. use when you want to delete a list by its id.

Action Parameters

delete_references
boolean
id
stringRequired
ignore_references
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_OSQUERY_SAVED_QUERIES

Tool to delete a saved osquery query by its id. use when you need to remove a specific osquery saved query.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_DELETE_SAVED_OBJECTS

Tool to delete a saved object in kibana. use when you need to remove a specific saved object like a visualization or dashboard.

Action Parameters

force
boolean
id
stringRequired
kbn_xsrf
stringDefaults to true
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_FIND_ALERTS

Tool to find and/or aggregate detection alerts in kibana. use this to retrieve a list of alerts, optionally filtering them with a query and performing aggregations.

Action Parameters

aggs
object
query
objectRequired
runtime_mappings
object
size
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_ACTION_TYPES

Tool to fetch the list of available action types (e.g., '.slack', '.email', '.webhook') in kibana. use this to discover the 'actiontypeid' needed when creating a new action.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_ALERTING_RULES

Tool to retrieve a list of alerting rules in kibana. use when you need to get a paginated set of rules based on specified conditions.

Action Parameters

default_search_operator
stringDefaults to OR
fields
array
filter
string
filter_consumers
array
has_reference
object
page
integerDefaults to 1
per_page
integerDefaults to 10
search
string
search_fields
array
sort_field
string
sort_order
string

Action Response

data
arrayRequired
error
string
page
integerRequired
per_page
integerRequired
successful
booleanRequired
total
integerRequired

SLUG: KIBANA_GET_ALERT_TYPES

Tool to retrieve available alert types in kibana. use when you need to get a list of all possible alert types and their metadata.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_CASES

Tool to retrieve a list of cases in kibana. use when you need to find or list existing security or operational cases, potentially filtering by various attributes like status, assignee, or severity.

Action Parameters

assignees
array
defaultSearchOperator
string
from_date_param
string
owner
array
page
integerDefaults to 1
perPage
integerDefaults to 20
reporters
array
search
string
searchFields
array
severity
string
sortField
stringDefaults to createdAt
sortOrder
stringDefaults to desc
status
string
tags
array
to_date_param
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_CONNECTORS

Tool to retrieve a list of all connectors in kibana. use this tool when you need to get information about available connectors.

Action Parameters

space_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_DATA_VIEWS

Tool to retrieve a list of data views available in kibana. use when you need to get a list of available data views, optionally filtering by a name pattern.

Action Parameters

pattern
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_DETECTION_ENGINE_RULES_FIND

Retrieves a list of detection engine rules based on specified criteria. use this tool to find detection rules.

Action Parameters

fields
array
filter
string
gaps_range_end
string
gaps_range_start
string
page
integerDefaults to 1
per_page
integerDefaults to 20
sort_field
string
sort_order
stringDefaults to desc

Action Response

data
arrayRequired
error
string
page
integerRequired
perPage
integerRequired
successful
booleanRequired
total
integerRequired

SLUG: KIBANA_GET_ENDPOINT_LIST_ITEMS

Tool to retrieve all items from an endpoint exception list. use when you need to get a list of endpoint exceptions, for example, to check existing exceptions before adding a new one.

Action Parameters

filter
string
page
integer
per_page
integer
sort_field
string
sort_order
string

Action Response

data
arrayRequired
error
string
page
integerRequired
per_page
integerRequired
pit
string
successful
booleanRequired
total
integerRequired

SLUG: KIBANA_GET_ENTITY_STORE_ENGINES

Retrieves the list of engines from the entity store.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_ENTITY_STORE_ENTITIES_LIST

Tool to list entity records in the entity store with support for paging, sorting, and filtering. use when you need to retrieve a list of entities such as users, hosts, or services.

Action Parameters

entity_types
arrayRequired
filterQuery
string
page
integer
per_page
integer
sort_field
string
sort_order
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: KIBANA_GET_ENTITY_STORE_STATUS

Tool to retrieve the status of the entity store in kibana. use this to check if the entity store is operational.

Action Parameters

Action Response

data
object
error
string
successful
booleanRequired