Operational health summary for the console dashboard

GET

/v1/console/health-summary

curl --request GET \
  --url https://example.com/v1/console/health-summary \
  --header 'Authorization: Bearer <token>'

• this engine

Returns the deployment health snapshot the console dashboard renders: readiness, the connector catalog size, the configured, running and failed connector counts, the user count and the SSO state.

Authorizations

• bearerAuth

Responses

200

OK

Media type application/json

object

connectors_available

Connector KINDS this build can wire (the catalog). A capability of the binary, not a live fleet: non-zero on a clean install with nothing configured.

integer

connectors_configured

Connector INSTANCES in the durable source roster, enabled or not.

integer

connectors_error

ENABLED roster entries that are not carrying data: status failed OR not_wired, plus any status this build does not recognize. Same classification as the failed field of GET /v1/connectors/health and the connectors component of GET /status, so the three cannot disagree.

integer

connectors_measured

Present and false ONLY when the source roster could not be read. The four connector counters above are then meaningless and must not be shown as measurements: absent means they were measured.

boolean

connectors_running

Roster entries whose live status is running (same criterion as the running field of GET /v1/connectors/health).

integer

embedder_kind

string

Allowed values: semantic local-hash

guard_downgrade_count

integer

guard_profile

string

Allowed values: acl_aware public_only

guard_public_only_kbs

Array<object>

object

kb_name

string

profile

string

Allowed values: public_only

reason

string

tenant_id

string

tenant_slug

string

updated_by

string

guard_warning

string

healthy

required

boolean

knowledge_status_reason

string

ready

required

boolean

retrieval_semantic

boolean

sso_configured

boolean

store_engine

required

string

tls_days_left

integer format: int64

tls_not_after

string format: date-time

update

object

advisories

Array<string>

available

required

boolean

channel

required

string

checked_at

string format: date-time

current_version

required

string

enabled

required

boolean

error

string

latest_version

string

security

boolean

up_to_date

required

boolean

users

Accounts in this deployment. A COUNT unless users_capped is present, in which case it is a lower bound.

integer

users_capped

Present and true ONLY when the account census hit its paging budget, making users a lower bound rather than a count.

boolean

version

required

string

Example

{
  "embedder_kind": "semantic",
  "guard_profile": "acl_aware",
  "guard_public_only_kbs": [
    {
      "profile": "public_only"
    }
  ]
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}