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

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