Skip to content

Information Service API client for kdb Insights Enterprise.

Use InformationService to query enrolled client details and check service health.

Example
from kxi.publish.information_service import InformationService

svc = InformationService(host="https://<host>")

# Check the service is reachable
svc.health()

# Retrieve details for a specific enrolled client
client_info = svc.details("my-client-id")

Classes:

InformationService

Bases: ApiClient

REST client for the kdb Insights Enterprise Information Service.

Provides information about enrolled clients registered with the platform. Connects to the /informationservice service path on the kdb Insights host.

Example
from kxi.publish.information_service import InformationService

svc = InformationService(host="https://<host>")
info = svc.details("my-client-id")

See Connection Parameters for shared constructor arguments.

Functions:

  • details – Retrieve details for a specific enrolled client.
  • health – Check the Information Service health.

details

details(id)

Retrieve details for a specific enrolled client.

Parameters:

  • id (str) – Client identifier to look up.

Returns:

  • – Client detail payload from the Information Service.

health

health()

Check the Information Service health.

Returns:

  • – Health status payload from the service.
Back to top