Struct ConsoleClient 

pub struct ConsoleClient { /* private fields */ }

SerenDB Console API client

Implementations

impl ConsoleClient

pub fn new(api_base_url: Option<&str>, api_key: String) -> Self

Create a new Console API client

Arguments

• api_base_url - Optional base URL (defaults to https://api.serendb.com)
• api_key - SerenDB API key (format: seren_<key_id>_)

pub async fn list_projects(&self) -> Result<Vec<Project>>

List all projects accessible to the authenticated user

Returns

Vector of projects the user has access to

Examples

let client = ConsoleClient::new(None, "seren_key".to_string());
let projects = client.list_projects().await?;
for project in projects {
    println!("{}: {}", project.id, project.name);
}

pub async fn list_branches(&self, project_id: &str) -> Result<Vec<Branch>>

List all branches for a project

pub async fn get_default_branch(&self, project_id: &str) -> Result<Branch>

Get the default branch for a project

Returns the branch marked as default, or the first branch if none are marked.

pub async fn list_databases( &self, project_id: &str, branch_id: &str, ) -> Result<Vec<Database>>

List all databases within a SerenDB branch

pub async fn create_database( &self, project_id: &str, branch_id: &str, name: &str, ) -> Result<Database>

Create a new SerenDB database inside a branch

pub async fn get_connection_string( &self, project_id: &str, branch_id: &str, database: &str, pooled: bool, ) -> Result<String>

Get a connection string for a branch/database combination

pub async fn get_project(&self, project_id: &str) -> Result<Project>

Get project information by ID

Arguments

• project_id - UUID string of the project

Returns

Project information including logical replication status

pub async fn enable_logical_replication( &self, project_id: &str, ) -> Result<Project>

Enable logical replication for a project

Warning: This action cannot be undone. Once enabled, logical replication cannot be disabled. Enabling will briefly suspend all active endpoints.

Arguments

• project_id - UUID string of the project

Returns

Updated project information

pub async fn is_logical_replication_enabled( &self, project_id: &str, ) -> Result<bool>

Check if logical replication is enabled for a project

Arguments

• project_id - UUID string of the project

Returns

true if logical replication is enabled, false otherwise

pub async fn find_project_by_hostname( &self, target_hostname: &str, ) -> Result<Option<String>>

Find a project by matching the target hostname against project connection strings

This is useful when the user provides a direct connection string (e.g., from init output) but doesn’t have saved target state with the project_id.

Arguments

• target_hostname - The hostname to search for (e.g., “ep-xyz.serendb.com”)

Returns

The project_id if a matching project is found, None otherwise