API
  1. Databases
  2. Valkey

Create or restore a Valkey Managed Database

post
https://api.linode.com//databases/valkey/instances

Limited availability Creates or restores a Valkey Managed Database.

  • New instances can take 10 to 15 minutes to deploy.

  • When you create a new Valkey Managed Database, our partner Aiven automatically enables disk encryption on each cluster.

  • Valkey databases automatically back up data every 12 hours and support configurable data persistence using Redis Database Backup (RDB). To change the default 12 hours to 24 hours, set the backup_hour parameter in the engine_config object. It may take another backup cycle for the new backup time to be applied.

  • All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Valkey Managed Database. Configure the maintenance window for these updates with the Update a Valkey Managed Database operation.

  • If your database cluster is configured with a single node, downtime occurs during maintenance updates. 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_create event.

  • You can create a Valkey Managed Database in a VPC using the private_network object in the request.

Restore a Valkey Managed Database

Include the fork object in the request to target a backed-up database.

📘

Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.

Permissions and scopes

To call this operation, you need the following:

  • Identity and access permissions. Your user needs these roles assigned. Learn more.

    • Roles: account_database_creator

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: databases:read_write
Path Params
string
enum
required

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

Allowed:
Body Params

Managed Valkey Database request object.

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
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:
string
required

The Managed Database engine in engine/version format.

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.

fork
object

Include this object to restore a Managed Database by forking from a backup.

  • If you include this object, all other fields are optional.

  • Don't include this object if you're creating a new Managed Database.

string
required
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.

string
required

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

boolean
Defaults to true

Currently required to be true. Whether to require SSL credentials to establish a connection to the Managed Database. Run the Get Valkey Managed Database credentials operation for access information.

string
required

Filterable The Linode Instance type used by the Managed Database for its nodes.

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 hours ago

Did this page help you?