Skip to main content

Creating a Redis database using the API

This article describes how to create a Redis database via the API.

Prerequisites​

To create a Redis database, you will need to have access to a project. Refer to the guide "create a project" for this. You will need the project ID for the subsequent operations.

List available Redis versions​

Set a request to the GET/v2/redis-versions/ endpoint to get a list of available Redis versions.

Each returned version object contains the following properties:

  • id contains the unique identifier of the version
  • number contains the version number (e.g., "7.0")
  • name contains a human-readable name for the version
  • disabled indicates whether the version is available for use

Important: When selecting a version for your database, you must choose a version where disabled is false.

Creating a Redis database​

To create a Redis database, send a request to the POST/v2/projects/{projectId}/redis-databases/ endpoint. The request body must contain a JSON object with the following properties:

  • description should contain a human-readable description of the database. This is a required value.
  • version should contain the version number of the database (e.g., "7.0"). This is a required value, and must match the number property of a version returned by the GET/v2/redis-versions/ endpoint (not the id property).

The response will contain the following properties:

  • id contains the ID of the created database.

Accessing the database​

After creating a database, you can send a request to the GET/v2/redis-databases/{redisDatabaseId}/ route.

Among others, the response will contain the following values:

  • hostname and port contain the hostname and port of the database. You can use these values to connect to the database from within your hosting environment.
  • configuration allows you to inspect the specific configuration values that were applied to your database.