For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • API Reference
        • UNARYPing
        • UNARYEcho
        • STREAMPingStream
  • ListActivities
  • ExportActivities
  • ListActivityFilterOptions
  • CreateApiKey
  • ListApiKeys
  • RevokeApiKey
  • Authenticate
  • Logout
  • UpdatePassword
  • UpdateUsername
  • GetUserAuditInfo
  • CreateUser
  • ListUsers
  • ResetUserPassword
  • DeactivateUser
  • VerifyCredentials
  • Query
  • GetError
  • ListMinerErrors
  • Watch
  • CreateCollection
  • GetCollection
  • UpdateCollection
  • DeleteCollection
  • ListCollections
  • AddDevicesToCollection
  • RemoveDevicesFromCollection
  • ListCollectionMembers
  • GetDeviceCollections
  • SetRackSlotPosition
  • ClearRackSlotPosition
  • GetRackSlots
  • GetCollectionStats
  • ListRackZones
  • ListRackTypes
  • SaveRack
  • CreateDeviceSet
  • GetDeviceSet
  • UpdateDeviceSet
  • DeleteDeviceSet
  • ListDeviceSets
  • AddDevicesToDeviceSet
  • RemoveDevicesFromDeviceSet
  • ListDeviceSetMembers
  • GetDeviceDeviceSets
  • SetRackSlotPosition
  • ClearRackSlotPosition
  • GetRackSlots
  • GetDeviceSetStats
  • ListRackZones
  • ListRackTypes
  • SaveRack
  • GetCombinedMetrics
  • StreamCombinedMetricUpdates
  • ListMinerStateSnapshots
  • ExportMinerListCsv
  • GetMinerStateCounts
  • GetMinerPoolAssignments
  • GetMinerCoolingMode
  • DeleteMiners
  • GetMinerModelGroups
  • RenameMiners
  • UpdateWorkerNames
  • GetFleetPerformance
  • StreamFleetOverview
  • StreamPerformanceMetrics
  • ImportFromForeman
  • CompleteImport
  • Reboot
  • StopMining
  • StartMining
  • SetCoolingMode
  • SetPowerTarget
  • UpdateMiningPools
  • DownloadLogs
  • BlinkLED
  • StreamCommandBatchUpdates
  • GetCommandBatchLogBundle
  • FirmwareUpdate
  • Unpair
  • UpdateMinerPassword
  • CheckCommandCapabilities
  • GetNetworkInfo
  • UpdateNetworkNickname
  • CreateAdminLogin
  • GetFleetInitStatus
  • GetFleetOnboardingStatus
  • Discover
  • Pair
  • Ping
  • Echo
  • PingStream
  • ListPools
  • CreatePool
  • UpdatePool
  • DeletePool
  • ValidatePool
  • ListSchedules
  • CreateSchedule
  • UpdateSchedule
  • DeleteSchedule
  • PauseSchedule
  • ResumeSchedule
  • ReorderSchedules
API Referenceping.v1PingService

Ping

||View as Markdown|
Example request
1{
2  "text": "example"
3}
Example response
1{
2  "text": "example"
3}
Ping is a unary RPC that returns the same text that was sent.
Built with

PingRequest

Request
This endpoint expects an object.
textstring

PingResponse

Response
This endpoint returns an object.
textstring