Struct KibanaClient 

pub struct KibanaClient { /* private fields */ }

Kibana client for making API requests.

The client can operate in two modes:

• Root mode (space: None): For global operations like managing spaces
• Space mode (space: Some(id)): For space-scoped operations

Use .space(id) to create a space-scoped client from a root client.

Example

use kibana_sync::{Auth, KibanaClient};
use url::Url;

let url = Url::parse("http://localhost:5601")?;
let client = KibanaClient::builder(url)
    .auth(Auth::None)
    .spaces([("marketing".to_string(), "Marketing".to_string())])
    .build()?;

// Root client for global operations (e.g., managing spaces)
let response = client.get("/api/spaces/space").await?;

// Space-scoped client for space-specific operations
let marketing = client.space("marketing")?;
let objects = marketing.get("/api/saved_objects/_find").await?;

// Get the current space ID
assert_eq!(marketing.space_id(), "marketing");

Implementations

impl KibanaClient

pub fn builder(url: Url) -> KibanaClientBuilder

Start configuring a root Kibana client from explicit values.

pub fn new(url: Url, auth: Auth) -> Result<Self>

Create a root client with default options and only the default space.

pub fn space(&self, id: &str) -> Result<KibanaClient>

Create a space-scoped client for the given space ID.

Returns a new client that will automatically scope all API requests to the specified space (prefixing paths with /s/{space}/).

Arguments

• id - Space ID to scope to

Returns

A new KibanaClient scoped to the specified space

Errors

Returns an error if the space ID is not in the loaded manifest

Example

let marketing = client.space("marketing")?;
assert_eq!(marketing.space_id(), "marketing");

pub async fn server_version_info(&self) -> Result<KibanaVersionInfo>

Resolve and cache Kibana server version info from /api/status.

pub async fn server_version(&self) -> Result<KibanaVersion>

Resolve the normalized Kibana server version.

pub fn supports_capability( version: &KibanaVersion, capability: ApiCapability, ) -> bool

Check if a capability is supported on a specific Kibana version.

pub fn unsupported_capability_reason( version: &KibanaVersion, capability: ApiCapability, ) -> String

Build a user-facing unsupported message for a capability/version pair.

pub fn space_id(&self) -> &str

Get the current space ID.

Returns “default” for root mode or the default space.

pub fn is_root(&self) -> bool

Check if this client is in root mode (no space scoping).

pub fn space_ids(&self) -> Vec<&str>

Get all available space IDs from the manifest.

pub fn space_name(&self, id: &str) -> Option<&str>

Get the name of a space by ID.

Returns

The space name if found, None otherwise

pub fn has_space(&self, id: &str) -> bool

Check if a space exists in the manifest.

pub fn url(&self) -> &Url

Get the base URL.

pub async fn test_connection(&self) -> Result<Response>

Verify the connection and authentication to Kibana.

Makes a GET request to /api/status to verify connectivity.

pub async fn request( &self, method: Method, headers: &HashMap<String, String>, path: &str, body: Option<&[u8]>, ) -> Result<Response>

Send a request to a given path.

If this client is scoped to a space, the path will be prefixed with /s/{space}/. For root mode, the path is used as-is.

Arguments

• method - HTTP method
• headers - Additional headers
• path - API path
• body - Optional request body

pub async fn get(&self, path: &str) -> Result<Response>

Helper for GET requests.

pub async fn get_internal(&self, path: &str) -> Result<Response>

Helper for GET requests for internal Kibana APIs. Adds X-Elastic-Internal-Origin header required by some APIs (e.g., workflows).

pub async fn head(&self, path: &str) -> Result<Response>

Helper for HEAD requests.

pub async fn head_internal(&self, path: &str) -> Result<Response>

Helper for HEAD requests for internal Kibana APIs. Adds X-Elastic-Internal-Origin header required by some APIs.

pub async fn post_json(&self, path: &str, body: &[u8]) -> Result<Response>

Helper for POST requests with JSON body.

pub async fn post_json_value( &self, path: &str, value: &Value, ) -> Result<Response>

Helper for POST requests with JSON value.

pub async fn post_json_value_internal( &self, path: &str, value: &Value, ) -> Result<Response>

Helper for POST requests with JSON value for internal Kibana APIs. Adds X-Elastic-Internal-Origin header required by some APIs (e.g., workflows).

pub async fn put_json_value( &self, path: &str, value: &Value, ) -> Result<Response>

Helper for PUT requests with JSON value.

pub async fn put_json_value_internal( &self, path: &str, value: &Value, ) -> Result<Response>

Helper for PUT requests with JSON value for internal Kibana APIs. Adds X-Elastic-Internal-Origin header required by some APIs (e.g., workflows).

pub async fn post_form(&self, path: &str, body: &[u8]) -> Result<Response>

Helper for POST requests with multipart form data.

Trait Implementations

impl Clone for KibanaClient

fn clone(&self) -> KibanaClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KibanaClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for KibanaClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.