HealthCheckResponse

public struct HealthCheckResponse : Decodable, Sendable

Represents the response from the Horizon health check endpoint. This endpoint provides information about the health status of the Horizon server, including database connectivity and Stellar Core status. See Stellar developer docs

Show on GitHub

  • Indicates whether Horizon can successfully connect to its database

    Declaration

    Swift

    public let databaseConnected: Bool
    Show on GitHub

  • Indicates whether Horizon can successfully connect to Stellar Core

    Declaration

    Swift

    public let coreUp: Bool
    Show on GitHub

  • Indicates whether Stellar Core is synchronized with the network

    Declaration

    Swift

    public let coreSynced: Bool
    Show on GitHub

  • Initializer from decoder

    Throws

    DecodingError if the data is corrupted or invalid

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder to read data from
    Show on GitHub

  • Indicates whether the Horizon server is healthy. The server is considered healthy if the database is connected, core is up, and core is synchronized with the network.

    Declaration

    Swift

    public var isHealthy: Bool { get }
    Show on GitHub