Skip to main content

Get​

Returns a specific key-value entry by key.

Query Parameters
  • key string required

    A string reprenting 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"]).

    See rivet.api.kv.common#KeyComponents for the structure of a rivet.api.kv.common#Key split by /.

  • watch_index string

    A query parameter denoting the requests watch index.

  • namespace_id string

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

Responses

Get 200 response

Schema
  • value

    The key's JSON value.

  • deleted boolean

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

  • watch object required

    Provided by watchable endpoints used in blocking loops.

    • index string required

      Index indicating the version of the data responded.

      Pas this to rivet.common#WatchQuery to block and wait for the next response.