DBaaS Valkey

Valkey, the open-source key-value store with a Redis®-compatible interface.

create-dbaas-service-valkey

Create a DBaaS Valkey service

POST /dbaas-valkey/{name}

Create a DBaaS Valkey service

Path parameters

Name	In	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`plan`	string	yes	Subscription plan
`fork-from-service`	string	no	Service to fork from
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`maintenance`	Maintenance	no	Automatic maintenance settings
`migration`	Migration	no	Migrate data from existing server
`recovery-backup-name`	string	no	Name of a backup to recover from for services that support backup names
`termination-protection`	boolean	no	Service is protected against termination and powering off
`valkey-settings`	Valkey settings	no	Valkey.conf settings

Example

{
  "fork-from-service": "string",
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "migration": {
    "dbname": "string",
    "host": "string",
    "ignore-dbs": "string",
    "method": "dump",
    "password": "string",
    "port": 0,
    "ssl": true,
    "username": "string"
  },
  "plan": "string",
  "recovery-backup-name": "string",
  "termination-protection": true,
  "valkey-settings": {
    "acl_channels_default": "allchannels",
    "io_threads": 0,
    "lfu_decay_time": 0,
    "lfu_log_factor": 0,
    "maxmemory_policy": "noeviction",
    "notify_keyspace_events": "",
    "number_of_databases": 0,
    "persistence": "off",
    "pubsub_client_output_buffer_limit": 0,
    "ssl": true,
    "timeout": 0
  }
}

Maintenance

Automatic maintenance settings

Property	Type	Required	Description
`dow`	string	yes	Day of week for installing updates Allowed values: `saturday`, `tuesday`, `never`, `wednesday`, `sunday`, `friday`, `monday`, `thursday`.
`time`	string	yes	Time for installing updates, UTC

Migration

Migrate data from existing server

Property	Type	Required	Description
`host`	string	yes	Hostname or IP address of the server where to migrate data from
`port`	integer	yes	Port number of the server where to migrate data from
`dbname`	string	no	Database name for bootstrapping the initial connection
`ignore-dbs`	string	no	Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment)
`method`	string	no	The migration method to be used Allowed values: `dump`, `replication`.
`password`	string	no	Password for authentication with the server where to migrate data from
`ssl`	boolean	no	The server where to migrate data from is secured with SSL
`username`	string	no	User name for authentication with the server where to migrate data from

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-dbaas-service-valkey: golang | Python | Java

CLI: exo api create-dbaas-service-valkey

get-dbaas-service-valkey

GET /dbaas-valkey/{name}

Get a DBaaS Valkey service

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`backups`	array of List of backups for the service	List of backups for the service
`components`	array of Components	Service component information objects
`connection-info`	Connection Info	Valkey connection information properties
`created-at`	string	Service creation timestamp (ISO 8601)
`disk-size`	integer	TODO UNIT disk space for data storage
`integrations`	array of DBaaS Integration	Service integrations
`ip-filter`	array[string]	Allowed CIDR address blocks for incoming connections
`maintenance`	Automatic maintenance settings	Automatic maintenance settings
`name`	string	Service name
`node-count`	integer	Number of service nodes in the active plan
`node-cpu-count`	integer	Number of CPUs for each node
`node-memory`	integer	TODO UNIT of memory for each node
`node-states`	array of Automatic maintenance settings	State of individual service nodes
`notifications`	array of Service notifications	Service notifications
`plan`	string	Subscription plan
`prometheus-uri`	Prometheus URI	Prometheus integration URI
`state`	string	State of the service Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`.
`termination-protection`	boolean	Service is protected against termination and powering off
`type`	string	Service type code
`updated-at`	string	Service last update timestamp (ISO 8601)
`uri`	string	URI for connecting to the service (may be absent)
`uri-params`	object	service_uri parameterized into key-value pairs
`users`	array of Users	List of service users
`valkey-settings`	Valkey settings	Valkey-specific settings
`version`	string	Valkey version
`zone`	string	The zone where the service is running

Example output

{
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2024-01-01T12:00:00Z",
      "data-size": 0
    }
  ],
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 0,
      "route": "dynamic",
      "ssl": true,
      "usage": "primary"
    }
  ],
  "connection-info": {
    "password": "string",
    "slave": [
      "string"
    ],
    "uri": [
      "string"
    ]
  },
  "created-at": "2024-01-01T12:00:00Z",
  "disk-size": 0,
  "integrations": [
    {
      "description": "string",
      "dest": "string",
      "id": "string",
      "is-active": true,
      "is-enabled": true,
      "settings": {},
      "source": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "deadline": "2024-01-01T12:00:00Z",
        "description": "string",
        "start-after": "2024-01-01T12:00:00Z",
        "start-at": "2024-01-01T12:00:00Z"
      }
    ]
  },
  "name": "string",
  "node-count": 0,
  "node-cpu-count": 0,
  "node-memory": 0,
  "node-states": [
    {
      "name": "string",
      "progress-updates": [
        {
          "completed": true,
          "current": 0,
          "max": 0,
          "min": 0,
          "phase": "stream",
          "unit": "string"
        }
      ],
      "role": "standby",
      "state": "leaving"
    }
  ],
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "metadata": {},
      "type": "service_powered_off_removal"
    }
  ],
  "plan": "string",
  "prometheus-uri": {
    "host": "string",
    "port": 0
  },
  "state": "running",
  "termination-protection": true,
  "type": "string",
  "updated-at": "2024-01-01T12:00:00Z",
  "uri": "string",
  "uri-params": {},
  "users": [
    {
      "access-control": {
        "categories": [
          "string"
        ],
        "channels": [
          "string"
        ],
        "commands": [
          "string"
        ],
        "keys": [
          "string"
        ]
      },
      "password": "string",
      "type": "string",
      "username": "string"
    }
  ],
  "valkey-settings": {
    "acl_channels_default": "allchannels",
    "io_threads": 0,
    "lfu_decay_time": 0,
    "lfu_log_factor": 0,
    "maxmemory_policy": "noeviction",
    "notify_keyspace_events": "",
    "number_of_databases": 0,
    "persistence": "off",
    "pubsub_client_output_buffer_limit": 0,
    "ssl": true,
    "timeout": 0
  },
  "version": "string",
  "zone": "string"
}

SDK reference for get-dbaas-service-valkey: golang | Python | Java

CLI: exo api get-dbaas-service-valkey

update-dbaas-service-valkey

PUT /dbaas-valkey/{name}

Update a DBaaS Valkey service

Path parameters

Name	In	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`maintenance`	Maintenance	no	Automatic maintenance settings
`migration`	Migration	no	Migrate data from existing server
`plan`	string	no	Subscription plan
`termination-protection`	boolean	no	Service is protected against termination and powering off
`valkey-settings`	Valkey settings	no	Valkey.conf settings

Example

{
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "migration": {
    "dbname": "string",
    "host": "string",
    "ignore-dbs": "string",
    "method": "dump",
    "password": "string",
    "port": 0,
    "ssl": true,
    "username": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "valkey-settings": {
    "acl_channels_default": "allchannels",
    "io_threads": 0,
    "lfu_decay_time": 0,
    "lfu_log_factor": 0,
    "maxmemory_policy": "noeviction",
    "notify_keyspace_events": "",
    "number_of_databases": 0,
    "persistence": "off",
    "pubsub_client_output_buffer_limit": 0,
    "ssl": true,
    "timeout": 0
  }
}

Maintenance

Automatic maintenance settings

Property	Type	Required	Description
`dow`	string	yes	Day of week for installing updates Allowed values: `saturday`, `tuesday`, `never`, `wednesday`, `sunday`, `friday`, `monday`, `thursday`.
`time`	string	yes	Time for installing updates, UTC

Migration

Migrate data from existing server

Property	Type	Required	Description
`host`	string	yes	Hostname or IP address of the server where to migrate data from
`port`	integer	yes	Port number of the server where to migrate data from
`dbname`	string	no	Database name for bootstrapping the initial connection
`ignore-dbs`	string	no	Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment)
`method`	string	no	The migration method to be used Allowed values: `dump`, `replication`.
`password`	string	no	Password for authentication with the server where to migrate data from
`ssl`	boolean	no	The server where to migrate data from is secured with SSL
`username`	string	no	User name for authentication with the server where to migrate data from

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-dbaas-service-valkey: golang | Python | Java

CLI: exo api update-dbaas-service-valkey

delete-dbaas-service-valkey

Delete a Valkey service

DELETE /dbaas-valkey/{name}

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-dbaas-service-valkey: golang | Python | Java

CLI: exo api delete-dbaas-service-valkey

create-dbaas-valkey-user

Create a DBaaS Valkey user

POST /dbaas-valkey/{service-name}/user

null

Path parameters

Name	In	Description
`service-name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`username`	string	yes	Username

Example

{
  "username": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-dbaas-valkey-user: golang | Python | Java

CLI: exo api create-dbaas-valkey-user

delete-dbaas-valkey-user

Delete a DBaaS Valkey user

DELETE /dbaas-valkey/{service-name}/user/{username}

null

Path parameters

Name	In	Description
`service-name`	`path`
`username`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-dbaas-valkey-user: golang | Python | Java

CLI: exo api delete-dbaas-valkey-user

reveal-dbaas-valkey-user-password

Reveal the secrets of a DBaaS Valkey user

GET /dbaas-valkey/{service-name}/user/{username}/password/reveal

null

Path parameters

Name	In	Description
`service-name`	`path`
`username`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	Valkey password
`username`	string	Valkey username

Example output

{
  "password": "string",
  "username": "string"
}

SDK reference for reveal-dbaas-valkey-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-valkey-user-password

reset-dbaas-valkey-user-password

Reset the credentials of a DBaaS Valkey user

PUT /dbaas-valkey/{service-name}/user/{username}/password/reset

If no password is provided one will be generated automatically.

Path parameters

Name	In	Description
`service-name`	`path`
`username`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`password`	string	no	New password

Example

{
  "password": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for reset-dbaas-valkey-user-password: golang | Python | Java

CLI: exo api reset-dbaas-valkey-user-password

Other Operations

get-dbaas-settings-valkey

Get DBaaS Valkey settings

GET /dbaas-settings-valkey

Returns the default settings for Valkey.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`settings`	Settings

Example output

{
  "settings": {
    "valkey": {
      "additionalProperties": true,
      "properties": {},
      "title": "string",
      "type": "string"
    }
  }
}

Settings

Property	Type	Required	Description
`valkey`	Valkey	no	Valkey configuration values

Valkey

Valkey configuration values

Property	Type	Required
`additionalProperties`	boolean	no
`properties`	object	no
`title`	string	no
`type`	string	no

SDK reference for get-dbaas-settings-valkey: golang | Python | Java

CLI: exo api get-dbaas-settings-valkey

start-dbaas-valkey-maintenance

Initiate Valkey maintenance update

PUT /dbaas-valkey/{name}/maintenance/start

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for start-dbaas-valkey-maintenance: golang | Python | Java

CLI: exo api start-dbaas-valkey-maintenance

stop-dbaas-valkey-migration

Stop a DBaaS Valkey migration

POST /dbaas-valkey/{name}/migration/stop

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for stop-dbaas-valkey-migration: golang | Python | Java

CLI: exo api stop-dbaas-valkey-migration

Last updated on February 13, 2026