Avalanche SDK Client
    Preparing search index...

    Module methods/health

    Type Aliases

    HealthErrorType
    HealthParameters

    Parameters for the health.health method.

    HealthReturnType

    Return type for the health.health method.

    LivenessErrorType
    LivenessReturnType

    Return type for the health.liveness method.

    ReadinessErrorType
    ReadinessParameters

    Parameters for the health.readiness method.

    ReadinessReturnType

    Return type for the health.readiness method.

    Functions

    health

    Returns the last set of health check results for the node. This includes checks for all chains, network, database, and other components.

    liveness

    Returns a simple health check indicating if the node is alive and can handle requests. This is a lightweight check that always returns healthy if the endpoint is available.

    readiness

    Returns the last evaluation of the startup health check results. This indicates if the node has finished initializing and is ready to handle requests.