kvstore_api_doc.go

package client

const kvStoreAPIDoc = `"keybase kvstore api" provides a JSON API to fast, encrypted key-value storage. The "entryKey" and "namespace" fields are visible to the Keybase servers, "entryValue" is encrypted with the per-team-key.

If team is not specified, then the command defaults to your implicit self-team (only you can see and decrypt) because that's probably what you want.

EXAMPLES:

Put an entry in your implicit self-team (i.e. only decryptable by you):
	{"method": "put", "params": {"options": {"team": "yourname,yourname", "namespace": "pw-manager", "entryKey": "geocities", "entryValue": "all my secrets"}}}

Get an entry in your implicit self-team:
	{"method": "get", "params": {"options": {"team": "yourname,yourname", "namespace": "pw-manager", "entryKey": "geocities"}}}

Get an entry for a named team (always returns the latest revision, non-existent entries have a revision of 0):
	{"method": "get", "params": {"options": {"team": "phoenix", "namespace": "pw-manager", "entryKey": "geocities"}}}

Put an encrypted entry for anyone in team phoenix:
	{"method": "put", "params": {"options": {"team": "phoenix", "namespace": "pw-manager", "entryKey": "geocities", "entryValue": "all my secrets"}}}

Put an entry (specifying a non-zero revision enables custom concurrency behavior, e.g. 1 will throw an error if the entry already exists):
	{"method": "put", "params": {"options": {"team": "phoenix", "namespace": "pw-manager", "entryKey": "geocities", "revision": 1, "entryValue": "all my secrets"}}}

List all namespaces with a non-deleted entryKey (pagination not yet implemented for >10k items):
	{"method": "list", "params": {"options": {"team": "phoenix"}}}

List all non-deleted entryKeys in a namespace (pagination not yet implemented for >10k items):
	{"method": "list", "params": {"options": {"team": "phoenix", "namespace": "pw-manager"}}}

Delete an entry:
	{"method": "del", "params": {"options": {"team": "phoenix", "namespace": "pw-manager", "entryKey": "geocities"}}}

Delete an entry (also supports specifying the revision):
	{"method": "del", "params": {"options": {"team": "phoenix", "namespace": "pw-manager", "revision": 4, "entryKey": "geocities"}}}
`