Godot Unity Unreal HTML5 Custom

games.namespaces.logs.getNamespaceLobby

Description

Returns a lobby from the given game namespace.

Code Examples

curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/logs/lobbies/{lobby_id}'

Request Parameters

game_id

required path parameter

namespace_id

required path parameter

lobby_id

required path parameter

Response Body

lobby
object
A logs summary for a lobby.
- lobby.lobby_id
  string
- lobby.namespace_id
  string
- lobby.lobby_group_name_id
  string
  A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.
- lobby.region_id
  string
- lobby.create_ts
  string
  RFC3339 timestamp
- lobby.start_ts
  string
  RFC3339 timestamp
- lobby.ready_ts
  string
  RFC3339 timestamp
- lobby.status
  object
  A union representing the state of a lobby.
  lobby.status.running
  empty object
  lobby.status.stopped
  object
  The status of a stopped lobby.
  lobby.status.stopped.stop_ts
  string
  RFC3339 timestamp
  lobby.status.stopped.failed
  boolean
  Whether or not the lobby failed or stopped successfully.
  lobby.status.stopped.exit_code
  number
  The exit code returned by the lobby's main process when stopped.
metrics
object
Metrics relating to a job service.
- metrics.job
  string
  The job name.
- metrics.cpu
  array of numbers
  CPU metrics.
- metrics.memory
  array of numbers
  Memory metrics.
- metrics.allocated_memory
  number
  Total allocated memory (MB).
stdout_presigned_urls
any value
stderr_presigned_urls
any value
perf_lists
any value