Kibana Python Client Documentation¶
Note
Disclaimer: This is an independent, community-driven project and is not officially affiliated with, endorsed by, or supported by Elastic N.V. or any of its subsidiaries. “Kibana” and “Elasticsearch” are trademarks of Elastic N.V. This software is provided “as is”, without warranty of any kind. See the LICENSE for full terms.
A Python client library for interacting with Kibana’s REST API.
The kibana-py library provides both synchronous and asynchronous interfaces for communicating with Kibana instances, built on top of the elastic-transport library for reliable HTTP communication.
kibana-py targets Kibana 9.4 and covers the full platform API surface — 24 namespaces and roughly 270 endpoints — including the new (technical preview) Dashboards HTTP API for managing dashboards as code. It requires Python 3.11 or newer.
Getting Started
User Guide
- User Guide
- Authentication
- Dashboards
- Alerting
- Data Views
- Cases
- Connectors
- Spaces
- Saved Objects
- Status Monitoring
- Platform APIs
- Error Handling
- OpenTelemetry Observability
- Installation
- Quick Start
- Configuration Options
- Log Forwarding
- Span Attributes
- Log Attributes
- Exporters
- Integration with Elastic APM
- Integration with Jaeger
- Integration with Grafana Tempo
- Disabling Instrumentation
- Performance Considerations
- Example: Full Observability Stack
- Troubleshooting
- Best Practices
- Security Considerations
- Further Reading
- Advanced Usage
API Reference
- API Reference
- Kibana Client
- AsyncKibana Client
- DashboardsClient
- VisualizationsClient
- DataViewsClient
- SavedObjectsClient
- ShortUrlsClient
- AlertingClient
- ConnectorsClient
- CasesClient
- MaintenanceWindowsClient
- ActionsClient (deprecated)
- SlosClient
- SyntheticsClient
- UptimeClient
- StreamsClient
- ApmClient
- ObservabilityAiAssistantClient
- SpacesClient
- SecurityClient
- MlClient
- LogstashClient
- TaskManagerClient
- UpgradeAssistantClient
- StatusClient
- AgentBuilderClient
- WorkflowsClient
- FleetClient
- FleetAgentsClient
- FleetPoliciesClient
- FleetEpmClient
- FleetOutputsClient
- FleetEnrollmentClient
- DetectionEngineClient
- ExceptionListsClient
- ListsClient
- TimelineClient
- EndpointClient
- EntityAnalyticsClient
- OsqueryClient
- SecurityAiAssistantClient
- AttackDiscoveryClient
- Exceptions
- Overview
- Quick Start
- See Also
Examples
- Examples
- Basic Usage Examples
- Connector Examples
- Space Examples
- Saved Objects Examples
- Async Examples
- Observability Examples
- Per-Namespace Management Scripts
- Getting Started
- Example Categories
- Example Progression
- Running Examples
- Automatic Configuration
- Common Patterns
- Example Features
- Best Practices
- Troubleshooting
- Next Steps
- Related Documentation
Development
Additional Resources