putBatch
This feature is experimental and may change in the future.
Description
Puts (sets or overwrites) multiple key-value entries by key(s).
Code Examples
Request
PUT
https://api.rivet.gg/kv/entries/batch# Write the request body to body.json before running
curl -X PUT -d '@body.json' 'https://api.rivet.gg/kv/entries/batch'
Request Parameters
Request Body
entries
array<object>
(required)
entries[*].key
string
(required)
A string representing a key in the key-value database.
Maximum length of 512 characters.
Recommended Key Path Format
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 backslash (e.g. a/b\/c/d
has the path components ["a", "b/c", "d"]
).
This format is not enforced by Rivet, but the tools built around Rivet KV work better if this format is used.
entries[*].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.
namespace_id
string
Response Body
Empty response body.