Sidebar navigationMain contentFooter
HomeManaged DatabasesRedis™API/CLI
Managing username and password
Jump toUpdate content

Managing the default user's username and password

When you create a Redis™ Database Instance, you have to specify a user. It will be created with set permissions.

You can specify a name for this user when you create a Database Instance. This allows you to ensure the username is compatible with different software integrations where specific usernames are not supported.

Security & Identity (IAM):

You may need certain IAM permissions to carry out some actions described on this page. This means:

  • you are the Owner of the Scaleway Organization in which the actions will be carried out, or
  • you are an IAM user of the Organization, with a policy granting you the necessary permission sets
Requirements:

Specifying a name for a user

Follow the create a Database Instance procedure.

Tip:

You can also define a username when you create a Redis™ Database Instance via the Scaleway console.

You are required to specify a username and password for the default user in your POST request payload.

Important:

For a username to be valid, it must:

  • contain only letters, numbers, hyphens, dollars and underscores
  • be between 1 and 63 characters long
  • not start with _rkv
  • start with a letter
  • not be scalewayadmin or metrics

Retrieving the default username

You can retrieve the default username via the API and the CLI.

Run the following curl command in a terminal to GET information about your Redis™ Database Instance of choice and retrieve the default username. Replace zone and cluster_id in the path with the zone and cluster ID of your Database Instance of choice.

curl -X GET \
-H "X-Auth-Token: $SCW_SECRET_KEY" \
'https://api.scaleway.com/redis/v1/zones/{zone}/clusters/{cluster_id}'

A response like the following is returned:

{
"id": "string",
"name": "string",
"project_id": "string",
"status": "string",
"version": "string",
"endpoints": [],
"tags": [],
"node_type": "string",
"created_at": "string",
"updated_at": "string",
"tls_enabled": "boolean",
"cluster_settings": [],
"acl_rules": [],
"cluster_size": "integer",
"zone": "string",
"user_name": "redis-admin",
"upgradable_versions": []
}
Important:

The example above is a simplified version of the response. strings and boolean are replaced with actual values in a real response.

You can find the default username under "user_name":. In this example the default username is redis-admin.

Changing the default username

You can change the username and password of the default user anytime via the API and the CLI.

Run the following curl command in a terminal to update your Redis™ Database Instance. Replace zone and cluster_id in the path with the zone and cluster ID of your Database Instance of choice. In the body of the request, replace <your-new-username> and <your-new-password> with your username and password of choice.

curl -X PATCH \
-H "X-Auth-Token: $SCW_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
  "user_name":"<your-new-username>",
  "password":"<your-new-password>"
  }' \
"https://api.scaleway.com/redis/v1/zones/{zone}/clusters/{cluster_id}"

A response including the information of your Database Instance appears to indicate the update was successful.