API
⭐️ kv.get
API
⭐️ kv.get
Returns a specific key-value entry by key.
GET https://kv.api.rivet.gg/v1/entries
curl -X GET 'https://kv.api.rivet.gg/v1/entries'
Authorizations
Authorization[header]required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
keyrequired
string
A string representing a key in the key-value database.
Key path components are split by a slash (e.g. a/b/c
has the path components ["a", "b", "c"]
). Slashes can be escaped by using a forward slash (e.g. a/b\/c/d
has the path components ["a", "b/c", "d"]
).
Maximum length of 512 characters.
watch_index
string
A query parameter denoting the requests watch index.
namespace_id
string
Response
valuerequired
A JSON object stored in the KV database.
A null
value indicates the entry is deleted.
Maximum length of 1,048,576 bytes when encoded.
deleted
boolean
Whether or not the entry has been deleted. Only set when watching this endpoint.
watchrequired
object
Provided by watchable endpoints used in blocking loops.
curl -X GET 'https://kv.api.rivet.gg/v1/entries'