---
title: "Update Key Value instance"
method: PATCH
path: "/key-value/{redisId}"
tags: ["Key Value"]
---

# Update Key Value instance

`PATCH /key-value/{redisId}`

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

## Path parameters

- `redisId` string, required

## Request body

- KeyValuePATCHInput — Input type for updating a Key Value instance
  - `name` string — 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.
  - `ipAllowList` CidrBlockAndDescription[]
    - `cidrBlock` string, required
    - `description` string, required — User-provided description of the CIDR block

## Response `200`

Updated

- KeyValueDetail — A Key Value instance
  - `id` string, required — The ID of the Key Value instance
  - `createdAt` string, date-time, required — The creation time of the Key Value instance
  - `updatedAt` string, 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
  - `name` string, required — The name of the Key Value instance
  - `owner` Owner, required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `ipAllowList` CidrBlockAndDescription[]
      - `cidrBlock` string, required
      - `description` string, required — User-provided description of the CIDR block
    - `twoFactorAuthEnabled` boolean — Whether two-factor authentication is enabled for the owner. Only present if `type` is `user`.
    - `type` 'user' | 'team', required
  - `options` KeyValueOptions, required — Options for a Key Value instance
    - `maxmemoryPolicy` string
    - `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.
  - `ipAllowList` CidrBlockAndDescription[], required — The IP allow list for the Key Value instance
    - `cidrBlock` string, required
    - `description` string, required — User-provided description of the CIDR block
  - `environmentId` string — The ID of the environment the Key Value instance is associated with
  - `version` string, required — The version of Key Value
  - `maintenance` Maintenance — unresolved $ref

## Other responses

- `400` — The request could not be understood by the server.
- `401` — Authorization information is missing or invalid.
- `404` — Unable to find the requested resource.
- `409` — The current state of the resource conflicts with this request.
- `429` — Rate limit has been surpassed.
- `500` — An unexpected server error has occurred.
- `503` — Server currently unavailable.

---

[API](https://skmtc.dev/render/apis/render-public-api.md) · [All operations](https://skmtc.dev/render/apis/render-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/render/render-public-api/revisions/80e0ff74d033/schema)