Skip to main content
GET
Get knowledge health
Returns a KnowledgeHealth: the same health projection the Console’s Knowledge › Health page shows, over the namespaces the credential can read (or the one namespace selects), read as no person. Each section names its scope: readable sections cover only those namespaces, and deployment sections are deployment-wide. Source configuration, cursors and case keys are never returned, a source’s last error is redacted, and the re-embed run’s error text is withheld. A namespace outside the readable set answers 403; an unknown, repeated or empty query parameter answers 400. See Knowledge health.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

namespace
string

One knowledge namespace to report on (for example company or external_app:<appId>). It must be in the caller's readable set. Omitted: every readable namespace.

Minimum string length: 1

Response

Knowledge health

data
object
required

What is broken in the knowledge the caller can read, and how far behind it is: the Console health projection, read as no person. Sections with scope readable cover only the caller's readable namespaces (or the one selected); sections with scope deployment are deployment-wide. Source configuration, cursors and case keys are never returned; a source's last error is redacted, a failing item whose case the caller may not read is restricted with no error, and the re-embed run's error text is withheld (hasError). Each list is bounded and says truncated when the bounded read stopped early.

meta
object
required