Type Alias HealthAPI

type HealthAPI = {
    check(
        bundles?: boolean,
        plugins?: boolean,
        excludePlugin?: string | string[],
    ): Promise<void>;
    custom(name: string): Promise<void>;
}

Index

Methods

check custom

Methods

check

check(
    bundles?: boolean,
    plugins?: boolean,
    excludePlugin?: string | string[],
): Promise<void>
Checks OPA health.
Parameters
- Optionalbundles: boolean
  Require all bundles to be activated.
- Optionalplugins: boolean
  Require all plugins to be OK.
- OptionalexcludePlugin: string | string[]
  Plugin(s) to exclude from check.
Returns Promise<void>
See
https://www.openpolicyagent.org/docs/latest/rest-api/#health-api
- Defined in index.ts:208

custom

custom(name: string): Promise<void>
Custom health check (e.g., /health/ready).
Parameters
- name: string
  Health check name (e.g., 'ready', 'live').
Returns Promise<void>
See
https://www.openpolicyagent.org/docs/latest/rest-api/#custom-health-checks
- Defined in index.ts:215

Type Alias HealthAPI

Index

Methods

Methods

check

Parameters

Returns Promise<void>

See

custom

Parameters

Returns Promise<void>

See

Settings

On This Page