Server Information

The Server Information API provides comprehensive details about a monitored PostgreSQL server and the host system. The API aggregates data from collector metrics into a single response for each connection.

Overview

The Server Information feature provides the following capabilities:

• The API returns system hardware details including CPU, memory, and disk information.
• The API includes PostgreSQL configuration such as version, cluster name, and connection limits.
• The response lists all databases with sizes, encodings, and installed extensions.
• The API returns 16 curated PostgreSQL configuration settings for quick review.
• An optional AI analysis endpoint describes the likely purpose of each database.

Authentication

Both endpoints require a valid Bearer token in the Authorization header. The server enforces RBAC access checks on the specified connection. The server returns a 403 Forbidden response when the authenticated user lacks access to the connection.

For authentication details, see Authentication.

Server Information Endpoint

The server information endpoint returns system and PostgreSQL details for a single connection.

Endpoint

The following endpoint returns the server information:

GET /api/v1/server-info/{connection_id}

Path Parameters

The following table describes the path parameters:

Response

The server returns a JSON object containing system information, PostgreSQL configuration, databases, and key settings. The following table describes the top-level response fields:

System Object

The following table describes the fields in the system object:

PostgreSQL Object

The following table describes the fields in the postgresql object:

Database Object

The following table describes the fields in each databases array entry:

The response excludes the template0 and template1 system databases.

Extension Object

The following table describes the fields in each extensions array entry:

Setting Object

The following table describes the fields in each key_settings array entry:

The endpoint returns the following 16 curated settings:

• shared_buffers
• work_mem
• effective_cache_size
• maintenance_work_mem
• max_worker_processes
• wal_level
• archive_mode
• max_wal_size
• min_wal_size
• checkpoint_completion_target
• random_page_cost
• effective_io_concurrency
• max_parallel_workers
• max_parallel_workers_per_gather
• autovacuum
• log_min_duration_statement

Example

In the following example, a curl command requests the server information for connection 1:

curl -H "Authorization: Bearer <token>" \
  https://localhost:8080/api/v1/server-info/1

AI Analysis Endpoint

The AI analysis endpoint returns LLM-generated descriptions of each database on the server. The endpoint analyzes database names, sizes, and installed extensions to infer the purpose of each database.

Endpoint

The following endpoint returns the AI analysis:

GET /api/v1/server-info/{connection_id}/ai-analysis

Path Parameters

The following table describes the path parameters:

Response

The server returns a JSON object with per-database descriptions. The following table describes the response fields:

The server returns null when no LLM provider is configured. The server also returns null when the connection has no databases to analyze.

Caching

The server caches AI analysis results for five minutes per connection. Subsequent requests within the cache window return the cached analysis without calling the LLM. The cache refreshes automatically when a request arrives after the five-minute window expires.

Example

In the following example, a curl command requests the AI analysis for connection 1:

curl -H "Authorization: Bearer <token>" \
  https://localhost:8080/api/v1/server-info/1/ai-analysis

The server returns a response similar to the following:

{
  "databases": {
    "myapp": "A web application database with PostGIS.",
    "analytics": "A data warehouse for reporting."
  },
  "generated_at": "2026-02-10T12:00:00Z"
}

Error Responses

Both endpoints return standard error responses. The following table describes the possible error statuses:

Configuration

The server information endpoint requires the collector to be gathering metrics for the specified connection. The endpoint returns empty fields when the collector has not yet gathered data for a metric category.

The AI analysis endpoint requires an LLM provider to be configured in the server settings. For LLM provider setup instructions, see Server Configuration.

Related Documentation

• Connections describes how to manage database connections.
• Metrics documents the metrics collection endpoints.