--- title: "GET /dbaas-valkey/{name}" method: GET path: "/dbaas-valkey/{name}" tags: ["dbaas"] --- # GET /dbaas-valkey/{name} `GET /dbaas-valkey/{name}` ## Request - Base URL: `https://api-ch-gva-2.exoscale.com/v2` - URL: `https://api-ch-gva-2.exoscale.com/v2/dbaas-valkey/{name}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a DBaaS Valkey service ## Path parameters - `name` string, required ## Response `200` 200 - DbaasServiceValkey - `updated-at` string, date-time: Service last update timestamp (ISO 8601) - `node-count` integer: Number of service nodes in the active plan - `connection-info` object: Valkey connection information properties - `uri` string[] - `password` string - `slave` string[] - `node-cpu-count` integer: Number of CPUs for each node - `prometheus-uri` object, required: Prometheus integration URI - `host` string - `port` integer - `integrations` DbaasIntegration[]: Service integrations - `description` string: Description of the integration - `settings` object: Integration settings - `type` string: Integration type - `is-enabled` boolean: Whether the integration is enabled or not - `source` string: Source service name - `is-active` boolean: Whether the integration is active or not - `status` string: Integration status - `id` string, uuid: Integration id - `dest` string: Destination service name - `zone` string: The zone where the service is running - `node-states` DbaasNodeState[]: State of individual service nodes - `name` string, required: Name of the service node - `progress-updates` DbaasNodeStateProgressUpdate[]: Extra information regarding the progress for current state - `completed` boolean, required: Indicates whether this phase has been completed or not - `current` integer: Current progress for this phase. May be missing or null. - `max` integer: Maximum progress value for this phase. May be missing or null. May change. - `min` integer: Minimum progress value for this phase. May be missing or null. - `phase` 'stream' | 'basebackup' | 'prepare' | 'finalize', required: Key identifying this phase - `unit` string: Unit for current/min/max values. New units may be added. If null should be treated as generic unit - `role` 'standby' | 'master' | 'read-replica': Role of this node. Only returned for a subset of service types - `state` 'leaving' | 'running' | 'syncing_data' | 'setting_up_vm' | 'unknown', required: Current state of the service node - `name` string, required - `type` string, required - `state` 'running' | 'rebuilding' | 'rebalancing' | 'poweroff' - `valkey-settings` JsonSchemaValkey - `ssl` boolean - `lfu_log_factor` integer - `frequent_snapshots` boolean: When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when `valkey_persistence` is set to `off`. - `maxmemory_policy` 'noeviction' | 'allkeys-lru' | 'volatile-lru' | 'allkeys-random' | 'volatile-random' | 'volatile-ttl' | 'volatile-lfu' | 'allkeys-lfu', nullable - `io_threads` integer: Set Valkey IO thread count. Changing this will cause a restart of the Valkey service. - `lfu_decay_time` integer - `pubsub_client_output_buffer_limit` integer: Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. - `active_expire_effort` integer: Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency. - `notify_keyspace_events` string - `persistence` 'off' | 'rdb': When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. - `timeout` integer - `acl_channels_default` 'allchannels' | 'resetchannels': Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default. - `number_of_databases` integer: Set number of Valkey databases. Changing this will cause a restart of the Valkey service. - `ip-filter` string[]: Allowed CIDR address blocks for incoming connections - `backups` DbaasServiceBackup[]: List of backups for the service - `backup-name` string, required: Internal name of this backup - `backup-time` string, date-time, required: Backup timestamp (ISO 8601) - `data-size` integer, required: Backup's original size before compression - `termination-protection` boolean: Service is protected against termination and powering off - `notifications` DbaasServiceNotification[]: Service notifications - `level` 'warning' | 'notice', required: Notification level - `message` string, required: Human notification message - `type` 'service_powered_off_removal' | 'service_end_of_life', required: Notification type - `metadata` object, required: Notification type - `components` object[]: Service component information objects - `component` string, required: Service component name - `host` string, required: DNS name for connecting to the service component - `port` integer, required: Port number for connecting to the service component - `route` 'dynamic' | 'private' | 'public' | 'privatelink', required - `ssl` boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption. - `usage` 'primary' | 'replica', required - `maintenance` DbaasServiceMaintenance: Automatic maintenance settings - `dow` 'saturday' | 'tuesday' | 'never' | 'wednesday' | 'sunday' | 'friday' | 'monday' | 'thursday', required: Day of week for installing updates - `time` string, required: Time for installing updates, UTC - `updates` DbaasServiceUpdate[], required: List of updates waiting to be installed - `description` string: Description of the update - `deadline` string, date-time: Deadline for installing the update - `start-after` string, date-time: The earliest time the update will be automatically applied - `start-at` string, date-time: The time when the update will be automatically applied - `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, date-time: Service creation timestamp (ISO 8601) - `plan` string, required: Subscription plan - `users` object[]: List of service users - `type` string - `username` string - `password` string - `access-control` object - `categories` string[] - `channels` string[] - `commands` string[] - `keys` string[] ## Changes - **2026-11-06** `63da6f74c845`: 2 info - added the optional property `valkey-settings/active_expire_effort` to the response with the `200` status - added the optional property `valkey-settings/frequent_snapshots` to the response with the `200` status - **2025-05-22** `37a05010e8b4`: 1 info - endpoint added [Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/dbaas-valkey/:name/get.md) --- [API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)