⭐️ get
This feature is experimental and may change in the future.
Description
Returns a specific key-value entry by key.
Code Examples
Request
GET
https://api.rivet.gg/kv/entriescurl -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.