⭐️ get


Description

Returns a specific key-value entry by key.


Code Examples

Request

GET
https://api.rivet.gg/kv/entries
curl -X GET 'https://api.rivet.gg/kv/entries'

Request Parameters

key

Query parameter, required

watch_index

Query parameter, optional

A query parameter denoting the requests watch index.

namespace_id

Query parameter, optional


Response Body

deleted

boolean

Whether or not the entry has been deleted. Only set when watching this endpoint.

value

object (required)

A JSON object stored in the KV database. A null value indicates the entry is deleted. Maximum length of 262,144 bytes when encoded.

watch

object (required)

Provided by watchable endpoints used in blocking loops.

watch.index

string (required)

Index indicating the version of the data responded. Pass this to WatchQuery to block and wait for the next response.

Was this page helpful?

Edit Page

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.