stellar-sdk/com.soneso.stellar.sdk.horizon.responses/HealthResponse

HealthResponse

@Serializable

data class HealthResponse(val databaseConnected: Boolean, val coreUp: Boolean, val coreSynced: Boolean) : Response

Represents health response received from the Horizon server.

The health endpoint provides information about the current operational status of the Horizon server. It returns three key indicators that determine whether the server is functioning properly:

Database connectivity
Stellar Core availability
Stellar Core synchronization status

The actual Horizon API returns:

{
  "database_connected": true,
  "core_up": true,
  "core_synced": true
}

A server is considered healthy when all three indicators are true.

Constructors

HealthResponse

constructor(databaseConnected: Boolean, coreUp: Boolean, coreSynced: Boolean)

Properties

coreSynced

@SerialName(value = "core_synced")

val coreSynced: Boolean

Indicates whether the Stellar Core instance is synced with the network

coreUp

@SerialName(value = "core_up")

val coreUp: Boolean

Indicates whether the Stellar Core instance is up and running

databaseConnected

@SerialName(value = "database_connected")

val databaseConnected: Boolean

Indicates whether the Horizon database is connected

isHealthy

val isHealthy: Boolean

Returns true if the server is healthy (all systems operational).

HealthResponse

See also

Constructors

Properties