games.namespaces.logs.getNamespaceLobby


Description

Returns a lobby from the given game namespace.


Code Examples

Request

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

Request Parameters

game_id

Path parameter, required

namespace_id

Path parameter, required

lobby_id

Path parameter, required


Response Body

lobby

object (required)

A logs summary for a lobby.

lobby.create_ts

string (required)

RFC3339 timestamp.

lobby.lobby_group_name_id

string (required)

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.lobby_id

string (required)

lobby.namespace_id

string (required)

lobby.ready_ts

string

RFC3339 timestamp.

lobby.region_id

string (required)

lobby.start_ts

string

RFC3339 timestamp.

lobby.status

object (required)

A union representing the state of a lobby.

lobby.status.running

object (required)

lobby.status.stopped

object

The status of a stopped lobby.

lobby.status.stopped.exit_code

integer (required)

The exit code returned by the lobby's main process when stopped.

lobby.status.stopped.failed

boolean (required)

Whether or not the lobby failed or stopped successfully.

lobby.status.stopped.stop_ts

string (required)

metrics

object

Metrics relating to a job service.

metrics.allocated_memory

number

Total allocated memory (MB).

metrics.cpu

array<number> (required)

CPU metrics.

metrics.job

string (required)

The job name.

metrics.memory

array<number> (required)

Memory metrics.


Rivet

Open-source multiplayer infrastructure. Easy, flexible, and affordable.

This website is not sponsored by or affiliated with Unity Technologies or its affiliates. Unity Trademark(s) are trademark(s) or registered trademark(s) of Unity Technologies or its affiliates in the U.S. and elsewhere. | This website is not sponsored by, affiliated with, or endorsed by Epic Games, Inc. or its affiliates. 'Unreal Engine' is a trademark or registered trademark of Epic Games, Inc. in the U.S. and elsewhere. | The HTML5 Logo by the World Wide Web Consortium (W3C), used under a Creative Commons Attribution 3.0 License. Source | The Godot Engine Logo by the Andrea Calabró, used under a Creative Commons Attribution 4.0 International License. Source | Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.

© 2024 Rivet Gaming, Inc. All rights reserved.