SimTX API/Packets/ServerHealthRequest: Difference between revisions

Latest revision as of 17:01, 24 October 2026

ServerHealthRequest asks for a ServerHealthReport. It is a heavy request; status pages should poll it no more often than every few seconds.

message ServerHealthRequest { int64 request_id = 1; }

#	Field	Type	Description
1	`request_id`	`int64`	Nonzero; echoed in the ServerHealthReport.

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/Packets/ServerHealthRequest]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = ServerHealthRequest
+| frame = ClientFrame
+| field = 34
+| member = health
+| direction = c2s
+| session = [[SimTX API/Control session|Control]]
+| roles = <code>ROLE_CONTROL</code>.
+| permission = None
+| reply = [[SimTX API/Packets/ServerHealthReport|ServerHealthReport]]
+| group = control
+| file = control.proto
+}}
+'''ServerHealthRequest''' asks for a [[SimTX API/Packets/ServerHealthReport|ServerHealthReport]]. It is a heavy request; status pages should poll it no more often than every few seconds.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message ServerHealthRequest { int64 request_id = 1; }
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/ServerHealthReport|ServerHealthReport]].
+|}
+== See also ==
+* [[SimTX API/Packets/ServerHealthReport|ServerHealthReport]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]