lobbies.setClosed


Description

If is_closed is true, the matchmaker will no longer route players to the lobby. Players can still join using the /join endpoint (this can be disabled by the developer by rejecting all new connections after setting the lobby to closed). Does not shutdown the lobby.

This endpoint requires a lobby token for authentication, or a development namespace token for mock responses. When running on Rivet servers, you can access the given lobby token from the RIVET_TOKEN environment variable.


Code Examples

Request

PUT
https://api.rivet.gg/matchmaker/lobbies/closed
# Write the request body to body.json before running
curl -X PUT -d '@body.json' 'https://api.rivet.gg/matchmaker/lobbies/closed'

Request Parameters


Request Body

is_closed

boolean (required)


Response Body

Empty response body.


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.