Key Value
Create Key Value instance
Create a new Key Value instance.
post/key-value
Request body
namestring required
The name of the Key Value instance
ownerIdstring required
The ID of the owner of the Key Value instance
plan'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom' required
region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia'
Defaults to "oregon"
environmentIdstring
maxmemoryPolicy'noeviction' | 'allkeys_lfu' | 'allkeys_lru' | 'allkeys_random' | 'volatile_lfu' | 'volatile_lru' | 'volatile_random' | 'volatile_ttl'
The eviction policy for the Key Value instance
persistenceMode'journal_snapshot' | 'snapshot' | 'off'
The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence.
Response
Created
idstring required
The ID of the Key Value instance
createdAtstring date-time required
The creation time of the Key Value instance
updatedAtstring date-time required
The last updated time of the Key Value instance
status'creating' | 'available' | 'unavailable' | 'config_restart' | 'suspended' | 'maintenance_scheduled' | 'maintenance_in_progress' | 'recovery_failed' | 'recovery_in_progress' | 'unknown' | 'updating_instance' required
region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia' required
Defaults to "oregon"
plan'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom' required
namestring required
The name of the Key Value instance
environmentIdstring
The ID of the environment the Key Value instance is associated with
versionstring required
The version of Key Value
maintenanceMaintenance — unresolved $ref