Update a Valkey Managed Database

put

https://api.linode.com/{apiVersion}/databases/valkey/instances/{valkeyInstanceId}

Limited availability Updates an existing Valkey Managed Database. All values added in the request body overwrite the current cluster settings. Remaining values don't change.

The database's status can't be suspended. This applies also to engine_config advanced parameter settings for a suspended database. You need to resume it first.
Updates to your allow_list may take a short period of time to complete, making this operation inappropriate for rapid successive updates.
You can resize the database cluster to a larger one.
All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed Valkey Database. Use the updates object in this operation to modify the maintenance window for these updates.
If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the updates object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime.
Major upgrades are optional until the service reaches end of service, and can be done in place.
A successful request triggers a database_update event.
You can update an existing Valkey Managed Database to move it to a Virtual Private Cloud (VPC) using the private_network object in the request.

Permissions and scopes

To call this operation, you need the following:

Identity and access permissions. Your user needs these roles assigned. Learn more.
- Roles: database_admin
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: databases:read_write

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

valkeyInstanceId

integer

required

The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Body Params

Updated information for the Managed Valkey Database.

allow_list

array of strings

length ≥ 0

Controls access to the Managed Database.

Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.
A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.
An empty array ([]) blocks all public and private connections to the Managed Database.

allow_list

cluster_size

integer

enum

Defaults to 1

The number of Linode instance nodes deployed to the Managed Database, from 1 to 3. Consider these points when setting a cluster_size:

Choose 3 nodes to create a high availability cluster that consists of one primary node and two standby nodes.
A 2 node cluster is only available with a dedicated plan. It consists of one primary node and one standby node.

Allowed:

engine_config

object

Advanced parameters applied to a Valkey Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.

📘
Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a Valkey Managed Database. You can also run the Get Valkey Managed Database advanced parameters operation to see an up-to-date list.

label

string

length between 3 and 32

Filterable A name used to identify the Managed Database. This needs to be unique per Managed Database engine type. For example, you could use database_1, database_2, and database_3 for three unique MySQL Managed Databases. You can also use these same names for three unique PostgreSQL Managed Databases. However, you can't repeat any of these names for either engine type.

private_network

object | null

Restricts access on a Valkey Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster.

region

string

Filterable The unique identifier for the region where the Managed Database lives.

type

string

Request re-sizing of your cluster to a Linode type with more disk space. For example, you could request a Linode type that uses a higher plan.

Needs to be a Linode type with more disk space than your current Linode.
Resizing to a larger Linode type can accrue additional cost. Review the price output from the List types operation for more information.
You can't update the allow_list and set a new type in the same request.
Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.

updates

object

Configuration settings for automated patch update maintenance for the Managed Database.

version

string

Filterable The Managed Database engine version.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Valkey Managed Database updated successfully.

defaultSee Errors for the range of possible error response codes.