Reference
Exoscale API
DBaaS
DBaaS Valkey

DBaaS Valkey

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

Read more

create-dbaas-service-valkey

Create a DBaaS Valkey service

POST /dbaas-valkey/{name}

Create a DBaaS Valkey service

Path parameters

  • name in path (required)

Request body

  • application/json
    • maintenance (object): Automatic maintenance settings - schema details
    • plan (required) (string): Subscription plan
    • termination-protection (boolean): Service is protected against termination and powering off
    • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
    • migration (object): Migrate data from existing server - schema details
    • valkey-settings (object) - schema details
    • fork-from-service (string)
    • recovery-backup-name (string): Name of a backup to recover from for services that support backup names

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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 path (required)

Responses

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

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 path (required)

Request body

  • application/json
    • maintenance (object): Automatic maintenance settings - schema details
    • plan (string): Subscription plan
    • termination-protection (boolean): Service is protected against termination and powering off
    • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
    • migration (object): Migrate data from existing server - schema details
    • valkey-settings (object) - schema details

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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 path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • service-name in path (required)

Request body

  • application/json
    • username (required) (string)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • service-name in path (required)
  • username in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • service-name in path (required)
  • username in path (required)

Responses

  • 200: 200
    • application/json
      • username (string): Valkey username
      • password (string): Valkey password

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

  • service-name in path (required)
  • username in path (required)

Request body

  • application/json
    • password (string)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

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 path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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 path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

CLI: exo api stop-dbaas-valkey-migration

Last updated on