API Reference¶

Complete API reference for the Kibana Python client.

This section provides detailed documentation for all public classes, methods, and exceptions in the kibana-py library. The documentation is automatically generated from code docstrings and includes usage examples.

The client covers the Kibana 9.4 platform, Fleet and Security Solution APIs across 39 namespaces — headlined by the new Dashboards HTTP API (technical preview) — with full synchronous and asynchronous parity.

Client Classes

Analytics

Alerting

Observability

Fleet

Error Handling

Exceptions

Overview¶

The Kibana Python client provides both synchronous and asynchronous interfaces for interacting with Kibana’s REST API. The client is organized into namespace clients that group related functionality:

Main Clients¶

Kibana - Synchronous client for Kibana API
AsyncKibana - Asynchronous client for Kibana API
SpaceScopedKibana - Space-scoped synchronous client
AsyncSpaceScopedKibana - Space-scoped asynchronous client

Namespace Clients¶

Analytics¶

DashboardsClient (client.dashboards) - Manage dashboards as code (tech preview)
VisualizationsClient (client.visualizations) - Manage Lens visualizations (tech preview)
DataViewsClient (client.data_views) - Manage data views and runtime fields
SavedObjectsClient (client.saved_objects) - Manage saved objects
ShortUrlsClient (client.short_urls) - Create and resolve short URLs

Alerting¶

AlertingClient (client.alerting) - Manage alerting rules and backfills
ConnectorsClient (client.connectors) - Manage connectors
CasesClient (client.cases) - Open and track cases
MaintenanceWindowsClient (client.maintenance_windows) - Suppress rule notifications
ActionsClient (client.actions) - Deprecated alias of client.connectors

Observability¶

SlosClient (client.slos) - Manage service level objectives
SyntheticsClient (client.synthetics) - Manage synthetic monitors
UptimeClient (client.uptime) - Manage Uptime settings
StreamsClient (client.streams) - Manage streams (tech preview)
ApmClient (client.apm) - APM agent keys, configurations and annotations
ObservabilityAiAssistantClient (client.observability_ai_assistant) - AI Assistant chat completion

Management¶

SpacesClient (client.spaces) - Manage Kibana Spaces
SecurityClient (client.security) - Manage roles and sessions
MlClient (client.ml) - Machine learning saved objects
LogstashClient (client.logstash) - Centrally-managed Logstash pipelines
TaskManagerClient (client.task_manager) - Task manager health
UpgradeAssistantClient (client.upgrade_assistant) - Upgrade readiness
StatusClient (client.status) - Monitor server health

AI¶

AgentBuilderClient (client.agent_builder) - AI agents, tools, A2A and MCP
WorkflowsClient (client.workflows) - Automate YAML-defined workflows

Fleet¶

FleetClient (client.fleet) - Fleet setup, settings and health
FleetAgentsClient (client.fleet_agents) - Elastic Agents, actions and status
FleetPoliciesClient (client.fleet_policies) - Agent and package policies
FleetEpmClient (client.fleet_epm) - Elastic Package Manager (integrations)
FleetOutputsClient (client.fleet_outputs) - Outputs, Fleet Server hosts, proxies and connectivity
FleetEnrollmentClient (client.fleet_enrollment) - Enrollment keys, tokens and signing

Security Solution¶

DetectionEngineClient (client.detection_engine) - Detection rules and alerts
ExceptionListsClient (client.exception_lists) - Exception lists and endpoint exceptions
ListsClient (client.lists) - Value lists and list items
TimelineClient (client.timeline) - Timelines, notes and pinned events
EndpointClient (client.endpoint) - Endpoint management and response actions
EntityAnalyticsClient (client.entity_analytics) - Entity analytics, entity store and asset criticality
OsqueryClient (client.osquery) - Osquery packs, saved queries and live queries
SecurityAiAssistantClient (client.security_ai_assistant) - Security AI Assistant conversations and chat
AttackDiscoveryClient (client.attack_discovery) - AI attack discoveries and schedules

Exception Classes¶

KibanaException - Base exception class
ApiError - API-level errors
TransportError - Transport-level errors
SpaceError - Space-related errors

Quick Start¶

Synchronous Client¶

from kibana import Kibana

# Initialize client
client = Kibana(
    "http://localhost:5601",
    api_key="your_api_key"
)

# Use namespace clients
status = client.status.get_status()
dashboards = client.dashboards.get_all()
connectors = client.connectors.get_all()
spaces = client.spaces.get_all()

# Close client
client.close()

Asynchronous Client¶

from kibana import AsyncKibana
import asyncio

async def main():
    # Initialize async client
    async with AsyncKibana("http://localhost:5601") as client:
        # Use namespace clients with await
        status = await client.status.get_status()
        dashboards = await client.dashboards.get_all()
        connectors = await client.connectors.get_all()
        spaces = await client.spaces.get_all()

asyncio.run(main())

Space-Scoped Operations¶

from kibana import Kibana

client = Kibana("http://localhost:5601")

# Create space-scoped client
marketing_client = client.space("marketing")

# All operations are scoped to "marketing" space
dashboard = marketing_client.dashboards.create(
    title="Marketing KPIs"
)
connector = marketing_client.connectors.create(
    name="Marketing Webhook",
    connector_type_id=".webhook",
    config={"url": "https://example.com/webhook"}
)

Error Handling¶

from kibana import Kibana
from kibana.exceptions import (
    NotFoundError,
    BadRequestError,
    SpaceNotFoundError
)

client = Kibana("http://localhost:5601")

try:
    connector = client.connectors.get(id="my-connector")
except NotFoundError:
    print("Connector not found")
except BadRequestError as e:
    print(f"Invalid request: {e.message}")
except SpaceNotFoundError as e:
    print(f"Space not found: {e.space_id}")