Sign in
Key Value

Update Key Value instance

Update a Key Value instance by ID. Note that changing your plan, max memory policy, or persistence mode will restart your Key Value instance.

patch/key-value/{redisId}

Path parameters

redisIdstring required

Request body

namestring

The name of the Key Value instance

plan'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom'
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

Updated

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

Changes