NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Kibana

kibana

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

AnalyticsDashboardsWeb del proveedor
Acciones
49
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (49)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Delete ActionKIBANA_DELETE_ACTIONAcción

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

Parámetros de entrada

  • space_idstring

    The space ID to delete the action from. If not provided, the default space is used.

  • action_idstringObligatorio

    The ID of the action to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Alerting RuleKIBANA_DELETE_ALERTING_RULESAcción

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

Parámetros de entrada

  • idstringObligatorio

    The ID of the rule to delete.

  • kbn_xsrfstringObligatorio

    A required header to protect against CSRF attacks.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ConnectorKIBANA_DELETE_CONNECTORSAcción

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

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the connector to be deleted.

  • space_idstring

    An identifier for the space. If not provided, the default space is used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Fleet OutputKIBANA_DELETE_FLEET_OUTPUTAcción

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

Parámetros de entrada

  • kbn_xsrfstring

    A header to protect against Cross-Site Request Forgery (CSRF) attacks. Typically 'true' or a generated token.

  • output_idstringObligatorio

    The ID of the output configuration to delete.

  • elastic_api_versionstring

    Specifies the API version to use. Defaults to '2023-10-31' if not provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Fleet ProxyKIBANA_DELETE_FLEET_PROXYAcción

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

Parámetros de entrada

  • kbnXsrfstring

    A header to protect against Cross-Site Request Forgery (CSRF) attacks. Typically 'true' or a generated token.

  • proxyIdstringObligatorio

    The ID of the proxy configuration to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ListKIBANA_DELETE_LISTAcción

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

Parámetros de entrada

  • idstringObligatorio

    List's id value.

  • delete_referencesboolean

    Determines whether exception items referencing this value list should be deleted.

  • ignore_referencesboolean

    Determines whether to delete value list without performing any additional checks of where this list may be utilized.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Osquery Saved QueryKIBANA_DELETE_OSQUERY_SAVED_QUERIESAcción

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

Parámetros de entrada

  • idstringObligatorio

    The ID of the saved Osquery query to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Saved ObjectKIBANA_DELETE_SAVED_OBJECTSAcción

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

Parámetros de entrada

  • idstringObligatorio

    The ID of the saved object to delete.

  • typestringObligatorio

    The type of the saved object.

  • forceboolean

    When true, forces the deletion of objects that exist in multiple namespaces.

  • kbn_xsrfstring

    A required header to protect against CSRF attacks. Defaults to 'true'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Find Kibana AlertsKIBANA_FIND_ALERTSAcción

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.

Parámetros de entrada

  • aggsobject

    Defines aggregations to be performed. Refer to Elasticsearch aggregation documentation.

  • sizeinteger

    Number of alerts to return. Defaults to a server-side limit if not specified.

  • queryobjectObligatorio

    Elasticsearch query to filter alerts. For example, to match all alerts: {"match_all": {}}

  • runtime_mappingsobject

    Defines runtime fields. Refer to Elasticsearch runtime fields documentation.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Action TypesKIBANA_GET_ACTION_TYPESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Alerting RulesKIBANA_GET_ALERTING_RULESAcción

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.

Parámetros de entrada

  • pageinteger

    Page number to return. Minimum value is 1; default is 1.

  • fieldsstring[]

    Fields to return in the `attributes` key of the response.

  • filterstring

    A KQL string to filter with an attribute from your saved object.

  • searchstring

    An Elasticsearch `simple_query_string` to filter the rules.

  • per_pageinteger

    Number of rules to return per page. Minimum value is 0; default is 10.

  • sort_fieldstring

    Field used to sort the results; must exist in the `attributes` key of the response.

  • sort_orderstringenum

    Sort order.

    ascdesc
  • has_referenceobject

    Filters rules with a relation to reference objects of a specific type and identifier.

  • search_fieldsstring[]

    Fields to perform the `simple_query_string` query against.

  • filter_consumersstring[]

    List of consumers to filter.

  • default_search_operatorstringenum

    Default operator for the `simple_query_string`. Default is `OR`.

    ORAND

Parámetros de salida

  • dataobject[]Obligatorio

    Array of rule objects.

  • pageintegerObligatorio

    Current page number.

  • errorstring

    Error if any occurred during the execution of the action

  • totalintegerObligatorio

    Total number of rules matching the query.

  • per_pageintegerObligatorio

    Number of rules returned per page.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Alert TypesKIBANA_GET_ALERT_TYPESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CasesKIBANA_GET_CASESAcción

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.

Parámetros de entrada

  • pageinteger

    The page number of objects to return.

  • tagsstring[]

    Filters cases by tags.

  • ownerstring[]

    Filters cases by owner. Valid values are `cases`, `observability`, and `securitySolution`.

  • searchstring

    Filters response objects using an Elasticsearch `simple_query_string` query.

  • statusstringenum

    Filters cases by status.

    openin-progressclosed
  • perPageinteger

    The number of objects to return per page.

  • severitystringenum

    Filters cases by severity.

    criticalhighmediumlow
  • assigneesstring[]

    Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles.

  • reportersstring[]

    Filters cases by reporters' usernames.

  • sortFieldstringenum

    Determines which field to sort results by.

    createdAtupdatedAt
  • sortOrderstringenum

    Determines the sorting order.

    ascdesc
  • searchFieldsstring[]

    Fields to perform the `simple_query_string` parsed query against.

  • to_date_paramstring

    Returns cases created before a specific date (ISO 8601 format).

  • from_date_paramstring

    Returns cases created after a specific date (ISO 8601 format).

  • defaultSearchOperatorstringenum

    The default operator to use for the `simple_query_string`.

    ORAND

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All ConnectorsKIBANA_GET_CONNECTORSAcción

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

Parámetros de entrada

  • space_idstring

    An identifier for the space. If not provided, the default space is used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Data ViewsKIBANA_GET_DATA_VIEWSAcción

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.

Parámetros de entrada

  • patternstring

    A pattern to filter data views by name.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Find Detection Engine RulesKIBANA_GET_DETECTION_ENGINE_RULES_FINDAcción

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

Parámetros de entrada

  • pageinteger

    Page number. Must be greater than or equal to 1. Defaults to 1.

  • fieldsstring[]

    Specifies which fields to include in the response.

  • filterstring

    Filters the returned results based on specified criteria. Example: 'kql_query_here' or 'saved_query_id:some_id'.

  • per_pageinteger

    Number of rules per page. Must be greater than or equal to 0. Defaults to 20.

  • sort_fieldstring

    Field to sort by.

  • sort_orderstringenum

    Sort order. Defaults to desc.

    ascdesc
  • gaps_range_endstring

    Gaps range end. ISO 8601 date string.

  • gaps_range_startstring

    Gaps range start. ISO 8601 date string.

Parámetros de salida

  • dataobject[]Obligatorio

    Array of detection rules.

  • pageintegerObligatorio

    Current page number.

  • errorstring

    Error if any occurred during the execution of the action

  • totalintegerObligatorio

    Total number of rules found.

  • perPageintegerObligatorio

    Number of rules per page.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Endpoint List ItemsKIBANA_GET_ENDPOINT_LIST_ITEMSAcción

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.

Parámetros de entrada

  • pageinteger

    Page number to return. Minimum value is 0.

  • filterstring

    Filters results using `<field name>:<field value>` syntax. Minimum length is 1.

  • per_pageinteger

    Number of items per page. Minimum value is 0.

  • sort_fieldstring

    Field used to sort results. Minimum length is 1.

  • sort_orderstringenum

    Sort order, either `desc` or `asc`.

    descasc

Parámetros de salida

  • pitstring

    Point-in-time ID for search.

  • dataobject[]Obligatorio

    List of endpoint list items.

  • pageintegerObligatorio

    Current page number.

  • errorstring

    Error if any occurred during the execution of the action

  • totalintegerObligatorio

    Total number of items.

  • per_pageintegerObligatorio

    Number of items per page.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Entity Store EnginesKIBANA_GET_ENTITY_STORE_ENGINESAcción

Retrieves the list of engines from the entity store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Entity Store EntitiesKIBANA_GET_ENTITY_STORE_ENTITIES_LISTAcción

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.

Parámetros de entrada

  • pageinteger

    Page number, minimum value is 1.

  • per_pageinteger

    Number of records per page, minimum value is 1, maximum value is 10000.

  • sort_fieldstring

    Field to sort by.

  • sort_orderstringenum

    Sort order, either 'asc' or 'desc'.

    ascdesc
  • filterQuerystring

    Elasticsearch query to filter results.

  • entity_typesstring[]Obligatorio

    Types of entities to list; valid values are 'user', 'host', or 'service'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Entity Store StatusKIBANA_GET_ENTITY_STORE_STATUSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject

    The status details of the entity store.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Agent PoliciesKIBANA_GET_FLEET_AGENT_POLICIESAcción

Fetches a list of agent policies in fleet. use when you need to retrieve agent policy configurations.

Parámetros de entrada

  • pageinteger

    Page number.

  • kuerystring

    KQL filter for agent policies.

  • perPageinteger

    Items per page.

  • sortFieldstring

    Field to sort by.

  • sortOrderstringenum

    Order to sort: asc or desc.

    ascdesc

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Agents Available VersionsKIBANA_GET_FLEET_AGENTS_AVAILABLE_VERSIONSAcción

Tool to retrieve the available versions for fleet agents. use when you need to get a list of all available elastic agent versions.

Parámetros de entrada

  • elastic-api-versionstring

    Specifies the API version to use.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Agents Setup StatusKIBANA_GET_FLEET_AGENTS_SETUP_STATUSAcción

Tool to check if the fleet agents are set up. use when you need to verify the fleet agent setup status.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check Fleet PermissionsKIBANA_GET_FLEET_CHECK_PERMISSIONSAcción

Tool to check the permissions for the fleet api. use when you need to verify if the current user has the necessary privileges for fleet operations.

Parámetros de entrada

  • fleetServerSetupboolean

    Indicates if Fleet Server setup permissions should be checked.

  • elastic-api-versionstring

    Specifies the API version to use.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Data StreamsKIBANA_GET_FLEET_DATA_STREAMSAcción

Retrieves the list of data streams in fleet.

Parámetros de entrada

  • typestringenum

    Filters data streams by type.

    logsmetricstracessyntheticsprofiling
  • sortOrderstringenum

    Specifies the sort order of the results. Default is asc.

    ascdesc
  • datasetQuerystring

    Filters data streams by dataset name.

  • uncategorisedOnlyboolean

    If set to true, returns only uncategorized data streams. Default is false.

  • elastic-api-versionstring

    Specifies the API version to use. Default is 2023-10-31.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Enrollment API KeyKIBANA_GET_FLEET_ENROLLMENT_API_KEYAcción

Tool to retrieve details of a specific enrollment api key by its id. use when you have the id of an enrollment api key and need its details.

Parámetros de entrada

  • key_idstringObligatorio

    The ID of the enrollment API key to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Enrollment API KeysKIBANA_GET_FLEET_ENROLLMENT_API_KEYSAcción

Tool to fetch a list of enrollment api keys. use when you need to retrieve existing enrollment tokens for kibana fleet.

Parámetros de entrada

  • pageinteger

    The page number to return.

  • perPageinteger

    The number of results to return per page.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM CategoriesKIBANA_GET_FLEET_EPM_CATEGORIESAcción

Tool to fetch the list of categories in the elastic package manager. use when you need to retrieve available package categories.

Parámetros de entrada

  • prereleaseboolean

    If true, include pre-release categories.

  • elastic_api_versionstring

    Specifies the API version to use.

  • include_policy_templatesboolean

    If true, include policy templates in the response.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM Data StreamsKIBANA_GET_FLEET_EPM_DATA_STREAMSAcción

Tool to retrieve the list of data streams in the elastic package manager. use when you need to get a list of available data streams, optionally filtering by type, dataset, or categorization.

Parámetros de entrada

  • typestring

    Filters data streams by type. Valid values are `logs`, `metrics`, `traces`, `synthetics`, or `profiling`.

  • sortOrderstring

    Specifies the sort order of the results. Valid values are `asc` or `desc`.

  • datasetQuerystring

    Filters data streams by dataset name.

  • uncategorisedOnlyboolean

    If set to `true`, returns only uncategorized data streams.

  • elastic-api-versionstring

    Specifies the API version to use.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM Package DetailsKIBANA_GET_FLEET_EPM_PACKAGE_DETAILSAcción

Tool to fetch details of a specific package and version in the elastic package manager (epm). use when you need to get information about a particular epm package, such as its title, description, or type.

Parámetros de entrada

  • package_namestringObligatorio

    The name of the package.

  • package_versionstringObligatorio

    The version of the package.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM Package FileKIBANA_GET_FLEET_EPM_PACKAGE_FILEAcción

Tool to retrieve a specific file from a package in the elastic package manager. use when you need to inspect the contents of a package file.

Parámetros de entrada

  • pkgNamestringObligatorio

    The name of the package.

  • filePathstringObligatorio

    The path to the specific file within the package.

  • pkgVersionstringObligatorio

    The version of the package.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM PackagesKIBANA_GET_FLEET_EPM_PACKAGESAcción

Tool to fetch the list of available packages in the elastic package manager. use when you need to find available integrations or their details.

Parámetros de entrada

  • categorystring

    Filter packages by category.

  • prereleaseboolean

    Include pre-release packages.

  • excludeInstallStatusboolean

    Exclude installation status information.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Installed EPM PackagesKIBANA_GET_FLEET_EPM_PACKAGES_INSTALLEDAcción

Tool to retrieve the list of installed packages in the elastic package manager. use this when you need to check which packages are currently installed in fleet.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet EPM Packages (Limited)KIBANA_GET_FLEET_EPM_PACKAGES_LIMITEDAcción

Tool to fetch a limited list of packages from the elastic package manager. use when you need to retrieve a list of available epm packages with minimal details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get EPM Package StatisticsKIBANA_GET_FLEET_EPM_PACKAGE_STATSAcción

Tool to retrieve statistics for a specific package in the elastic package manager. use when you need to get epm package statistics.

Parámetros de entrada

  • package_namestringObligatorio

    The name of the package to retrieve statistics for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Package PoliciesKIBANA_GET_FLEET_PACKAGE_POLICIESAcción

Tool to retrieve a list of all package policies (agent & epm), providing their ids and associated details. use when you need to get an overview of existing package policies.

Parámetros de entrada

  • pageinteger

    Page number for pagination.

  • kuerystring

    KQL query to filter results.

  • formatstringenum

    Response format.

    simplifiedlegacy
  • perPageinteger

    Number of items per page.

  • sortFieldstring

    Field to sort by.

  • sortOrderstringenum

    Sort order.

    ascdesc
  • withAgentCountboolean

    Include agent count in response.

  • showUpgradeableboolean

    Show upgradeable packages.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Server HostKIBANA_GET_FLEET_SERVER_HOSTAcción

Tool to fetch details of a specific fleet server host by its item id. use when you need to get information about a particular fleet server host.

Parámetros de entrada

  • host_idstringObligatorio

    The ID of the Fleet server host to retrieve.

  • elastic_api_versionstring

    Specifies the API version to use.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Fleet Server HostsKIBANA_GET_FLEET_SERVER_HOSTSAcción

Tool to retrieve the list of fleet server hosts. use when you need to get information about the available fleet server hosts.

Parámetros de entrada

  • pageinteger

    Page number of the results to return.

  • perPageinteger

    Number of results to return per page.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Index Management IndicesKIBANA_GET_INDEX_MANAGEMENT_INDICESAcción

Tool to fetch information about indices managed by kibana's index management feature. it queries the underlying elasticsearch / cat/indices api to retrieve index details. use when you need to list or get details about one or more indices in the cluster.

Parámetros de entrada

  • hstring

    A comma-separated string of column names to display. If not provided, a default set of columns is shown. Example: 'index,health,status,docs.count,store.size'.

  • sstring

    A comma-separated string of column names or column aliases to sort by. For example, 'index,health'.

  • priboolean

    If true, only shows information about primary shards.

  • bytesstringenum

    The unit in which to display byte values.

    bkkbmmbggbttbppb
  • indexstring

    A comma-separated string of index names or wildcard expressions to limit the returned information. For example, 'my-index-*,another-index'. If not provided, information for all indices is returned.

  • healthstringenum

    The health status to filter indices by (green, yellow, or red).

    greenyellowred
  • expand_wildcardsstringenum

    Type of index that wildcard patterns can match. Supports comma-separated values, e.g., 'open,hidden'. 'all' matches all indices by default.

    openclosedhiddennoneall

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Node MetricsKIBANA_GET_METRICSAcción

Tool to retrieve statistics for nodes in an elasticsearch cluster, often visualized in kibana. use when you need to monitor node health, performance, or resource usage. this action calls the elasticsearch nodes stats api.

Parámetros de entrada

  • levelstringenum

    Indicates whether statistics are aggregated at the cluster, index, or shard level.

    clusterindicesshards
  • typesstring

    A comma-separated list of document types for the indexing index metric.

  • fieldsstring

    Comma-separated list or wildcard expressions of fields to include in the statistics.

  • groupsboolean

    If true, includes search group statistics.

  • metricstring

    Comma-separated list of metrics to retrieve. Examples: jvm, os, process, indices, fs, http, transport, breaker, thread_pool, ingest.

  • node_idstring

    Comma-separated list of node IDs or names to limit the returned information. Special values like '_all', '_local', '_master' can be used.

  • timeoutstring

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  • fielddata_fieldsstring

    Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

  • completion_fieldsstring

    Comma-separated list or wildcard expressions of fields to include in completion suggester statistics.

  • include_unloaded_segmentsboolean

    If true, the response includes information from segments that are not loaded into memory.

  • include_segment_file_sizesboolean

    If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Reporting JobsKIBANA_GET_REPORTING_JOBSAcción

Tool to retrieve a list of reporting jobs in kibana. use when you need to see pending or completed reports. this uses an internal api endpoint, which might be subject to change without notice.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Saved ObjectsKIBANA_GET_SAVED_OBJECTSAcción

Tool to retrieve a list of saved objects in kibana based on specified criteria. use when you need to find dashboards, visualizations, index patterns, or other saved entities.

Parámetros de entrada

  • pageinteger

    The page number to return.

  • typestringObligatorio

    The type or types of saved objects to find. For example, 'dashboard', 'visualization', or ['index-pattern', 'search'].

  • fieldsstring[]

    The fields to return in the response for each saved object. Can be a single field or a list of fields.

  • filterstring

    A Kibana Query Language (KQL) filter string to apply. For example, 'type:dashboard and attributes.title:"My Dashboard"'.

  • searchstring

    A search string to filter objects by. Searches the title and description fields by default.

  • per_pageinteger

    The number of objects to return per page.

  • sort_fieldstring

    The field to sort the results by. By default, sorts by relevance if 'search' is provided, otherwise by type and then ID.

  • sort_orderstringenum

    The order to sort the results by, if 'sort_field' is provided. Defaults to 'desc' if 'sort_field' is 'update_at', otherwise 'asc'.

    ascdesc
  • has_referenceobject

    Filters objects based on the presence of a reference. Expects an object with 'type' and 'id' keys. For example, {'type': 'index-pattern', 'id': 'my-index-pattern'}.

  • search_fieldsstring[]

    The fields to search when the 'search' parameter is provided. Can be a single field or a list of fields.

  • root_search_fieldsstring[]

    A list of fields to search at the root level of the saved object, in addition to 'search_fields' which target attributes. Useful for fields like 'id' or 'type'.

  • default_search_operatorstringenum

    The default operator to use for the 'search' query. Defaults to 'OR'.

    ORAND

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Kibana StatusKIBANA_GET_STATUSAcción

Tool to get the current status of kibana. use when you need to check if kibana is healthy, monitor its state, or get information about the kibana instance including version, uuid, and metrics.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Alerting RuleKIBANA_POST_ALERTING_RULESAcción

Tool to create a new alerting rule in kibana. use when you need to define a new condition that, when met, triggers an alert and potentially executes predefined actions.

Parámetros de entrada

  • namestringObligatorio

    The name of the rule. While not required to be unique, a distinctive name can help identify a rule.

  • tagsstring[]

    The tags for the rule. Default is an empty array.

  • paramsobjectObligatorio

    The parameters for the rule.

  • actionsobject[]

    An array of action objects. Default is an empty array.

  • enabledboolean

    Indicates whether to run the rule on an interval basis after it is created. Default is true.

  • rule_idstring

    The identifier for the rule. If omitted, an ID is randomly generated.

  • consumerstringObligatorio

    The name of the application or feature that owns the rule. Examples include `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.

  • scheduleobjectObligatorio

    The check interval, specifying how frequently the rule conditions are checked.

  • throttlestring

    Defines how often an alert generates repeated actions. Applicable only if notify_when is set to onThrottleInterval. Examples: '''10s''', '''5m''', '''1h'''.

  • notify_whenstringObligatorio

    Indicates how often alerts generate actions. Valid values include `onActionGroupChange`, `onActiveAlert`, or `onThrottleInterval`.

  • rule_type_idstringObligatorio

    The rule type identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CaseKIBANA_POST_CASESAcción

Tool to create a new case in kibana. use when you need to open and track issues, incidents, or investigations. you can assign users, set severity levels, add tags, and configure external connectors for integration with itsm systems.

Parámetros de entrada

  • tagsstring[]

    Tags for the case

  • ownerstringObligatorioenum

    The application that owns the cases: Stack Management, Observability, or Elastic Security.

    casesobservabilitysecuritySolution
  • titlestringObligatorio

    A title for the case.

  • categorystring

    A word or phrase that categorizes the case.

  • settingsobjectObligatorio

    An object that contains the case settings.

  • severitystringenum

    The severity of the case.

    criticalhighmediumlow
  • assigneesobject[]

    Assignees of the case

  • connectorobjectObligatorio

    Defines properties for connectors. Use .none type to create a case without a connector.

  • descriptionstringObligatorio

    The description for the case.

  • customFieldsobject[]

    Custom fields for the case

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Kibana ConnectorKIBANA_POST_CONNECTORSAcción

Tool to create a new connector in kibana. use when you need to integrate kibana with an external service.

Parámetros de entrada

  • idstringObligatorio

    An identifier for the connector.

  • namestringObligatorio

    The display name for the connector.

  • configobject

    The connector configuration details.

  • secretsobject

    The connector secrets.

  • kbn-xsrfstring

    A header to protect against CSRF attacks. Default is "true".

  • connector_type_idstringObligatorio

    The type of connector.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DashboardKIBANA_POST_DASHBOARDSAcción

Tool to create a new dashboard in kibana. use when you need to create a dashboard to visualize data. dashboards can contain visualizations, saved searches, and other embeddable objects.

Parámetros de entrada

  • spacesstring[]

    Spaces where the dashboard is available

  • attributesobjectObligatorio

    Dashboard attributes

  • referencesobject[]

    References to other saved objects

  • dashboard_idstring

    Optional dashboard ID. If not provided, one will be generated

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Data ViewKIBANA_POST_DATA_VIEWSAcción

Tool to create a new data view (index pattern) in kibana. use when you need to define which elasticsearch indices to query and analyze in kibana. data views determine which fields are available in discover, visualize, and other kibana apps.

Parámetros de entrada

  • overrideboolean

    Override an existing data view if it exists

  • data_viewobjectObligatorio

    Data view specification

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create or Update Saved ObjectKIBANA_POST_SAVED_OBJECTSAcción

Tool to create or update a saved object in kibana. use when you need to programmatically manage kibana dashboards, visualizations, index patterns, etc.

Parámetros de entrada

  • space_idstring

    The ID of the space to create or update the object in. If not specified, the default space is used.

  • object_idstring

    The ID of the saved object. If an ID is not provided, a randomly generated ID is assigned.

  • overwriteboolean

    When true, overwrites the document with the same ID. When false, if a document with the specified ID already exists, the request returns a 409 conflict.

  • attributesobjectObligatorio

    The attributes of the saved object. The content of this object varies depending on the `type`.

  • referencesobject[]

    Objects that this object references. Each reference object must contain `name`, `type`, and `id` fields.

  • object_typestringObligatorio

    The type of the saved object. For example, `dashboard`, `visualization`, `index-pattern`, etc.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not