Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Redis (Deprecated)

Update Redis instance

Update a Redis instance by ID. This API is deprecated in favor of the Key Value API.

patch/redis/{redisId}

Path parameters

redisIdstring required

Request body

namestring

The name of the Redis 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 Redis instance

createdAtstring date-time required

The creation time of the Redis instance

updatedAtstring date-time required

The last updated time of the Redis 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 Redis instance

environmentIdstring

The ID of the environment the Redis instance is associated with

versionstring required

The version of Redis