The API operation that updates an existing database is: PUT /subscriptions/{subscription-id}/databases/{database-id}

This API operation uses the same provisioning lifecycle as the create and manage databases operation.

Database update request JSON body

The primary component of a database update request is the JSON request body that contains the details of the requested database changes.

You can see the complete set of JSON elements accepted by the database update API operation in the Swagger UI. To see the JSON elements, expand the specific API operation and, in the request section, click Model.

Here are several examples of JSON requests to update a database:

Add or Remove Replica Of

Setting one or more source Redis databases configures the updated database as a Replica Of destination database for the specified Redis databases.

Add a source database

The following JSON request specifies two source databases for the updated database:

{
  "replicaOf": [
    "redis://redis-12345.c9876.us-east-1-mz.ec2.cloud.rlrcp.com:12345"
    , "redis://redis-54321.internal.c9876.us-east-1-mz.ec2.cloud.rlrcp.com:54321"
  ]
}
  • The replicaOf array contains one or more URIs with the format: redis://user:password@host:port
  • If the URI provided belongs to the same Redis Labs Cloud Account, only provide the host and port (example: ["redis://endpoint1:6379', "redis://endpoint2:6380"])
Warning -
If a source database is already defined for a specific database, and the goal is to add an additional source database, the source databases URI for the existing source must be included in the database updates JSON request.

Remove a source database

To remove a source database from the replicaOf list, submit a JSON request that does not include the specific source database URI.

Example:

Given a database that has two defined source databases:

{
  "replicaOf": [
    "redis://redis-12345.c9876.us-east-1-mz.ec2.cloud.rlrcp.com:12345"
    , "redis://redis-54321.internal.c9876.us-east-1-mz.ec2.cloud.rlrcp.com:54321"
  ]
}
  • You can use this JSON request to remove one of the two source databases:
{
  "replicaOf": [
    "redis://redis-12345.c9876.us-east-1-mz.ec2.cloud.rlrcp.com:12345"
  ]
}
  • You can use this JSON request to remove all source databases:
{
  "replicaOf": []
}

Viewing database Replica Of information

The API operation GET /subscriptions/{subscription-id}/databases/{database-id} returns information on a specific database, including the Replica Of endpoints defined for the specific database.