v1keys

Returns a list of all key value pairs.

Query parameters
prefix
string
Only return values which name starts with the provided prefix.
scope
string
Scope the item is under. Example: 'user'.
decrypt
boolean
Decrypt secrets and display plain text
user
string
Entity owner
limit
integer
Number of keys to get
offset
integer
Number of keys to offset
sort
string
Comma-separated list of fields to sort by
id
string
Entity id filter
name
string
Entity name filter
Responses

List of key value pairs

array[object]

Get a specific key value pair based on key_name.

Path parameters
name
string
Key Name
required
Query parameters
scope
string
Scope the item is under. Example: 'user'.
decrypt
boolean
Decrypt secrets and display plain text.
user
string
Entity owner
Responses

Key value pair requested.

object

Create a new key value pair or update an existing one.

Path parameters
name
string
Key Name.
required
Request body

Key Value pair content.

object
name
string
Key Name.
required
value
string
Key's value.
required
secret
boolean
Encrypt value before saving the value.
scope
string
Scope the item is under. Example: 'user'.
ttl
integer
TTL (in seconds) for this value.
user
string
User for user scoped items (admin only).
Responses

Key set/updated.

object
Path parameters
name
string
Key Name.
required
Query parameters
scope
string
Scope the item is under. Example: 'user'.
user
string
Entity owner
Responses

Key deleted.

null