Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.7

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.7

Legacy
​
Unity Gaming Services CLI
​
​
Lobby
  • Overview
  • Commands
    • Bulk Update
    • Config Get
    • Config Update
    • Create
    • Delete
    • Export
    • Get
    • Get-Hosted
    • Get-Joined
    • Heartbeat
    • Import
    • Join
    • Player Remove
    • Player Update
    • Query
    • Quickjoin
    • Reconnect
    • Request-token
    • Update
  1. Overview
  3. Lobby

Heartbeat

Renew a lobby's last accessed time to signal to the service that the lobby is still active.
Read time 1 minute
Last updated 3 months ago
Heartbeat a lobby. Heartbeats renew a lobby's last accessed time to indicate to the service that the lobby hasn't been abandoned.
Authentication Required: 
Yes
ugs lobby heartbeat <lobby-id> [options]

Arguments

<lobby-id>
The ID of the lobby to heartbeat.

Options

Option

Alias

Description

service-id--service-id(REQUIRED) The service ID.
player-id--player-idThe player ID to impersonate.
project-id-p, --project-idThe Unity cloud project ID.
environment-name-e, --environment-nameThe services environment name.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Arguments

    • Options