Replica HA Field Error (replica_ha vs slave_ha) in Redis Software REST API – Redis Knowledge Base

Redis Software supports replica high availability for replica shards, but the JSON field name depends on the REST API version you are calling. If you receive an error such as unknown field replica_ha or another unrecognized field validation error during database creation, your API endpoint does not accept replica_ha. In earlier API versions, the correct field name is slave_ha.

This article explains why the error occurs, provides a Quick Fix, and clarifies field mapping between API versions so you can align your payload with the correct REST API version.

Quick Fix

Symptom	Resolution
unknown field `replica_ha` when creating a database	Replace `replica_ha` with `slave_ha` in your JSON payload and retry the request
Validation error referencing an unrecognized HA field	Confirm the API version you are calling (for example, `/v1`). Use `slave_ha` for earlier versions
SDK or documentation references `replica_ha`, but API rejects it	Match your payload to the HTTP API version of your endpoint, not the SDK example

Why This Happens

Redis Software REST API field names evolved over time.

Some documentation and SDK examples show replica_ha, but the /v1 REST schema for the bdb object expects slave_ha

If you call an endpoint such as:

POST /v1/bdbs

and provide:

{
  "replica_ha": true
}

the request will fail if that API version only recognizes:

{
  "slave_ha": true
}

The validation error is expected behavior when the field name does not match the API schema for the version being called.

Field Mapping Reference

slave_ha (boolean)
Enables or disables replica high availability for replica shards during database creation.
Use this field when working with earlier REST API versions (for example, /v1).

replica_ha
Do not use unless explicitly documented for your specific API version. Using this field on earlier API versions will cause a validation error.

Step-by-Step Resolution

Identify the API version
Confirm the REST endpoint you are calling (for example, /v1).
Inspect your JSON payload
Look for replica_ha in the request body.
Replace the field name if necessary
If calling an earlier API version, update:
```
"replica_ha": true
```
to:
```
"slave_ha": true
```
Retry the request
Verify CLI/SDK alignment
Keep your CLI or SDK updated, but always ensure your payload matches the HTTP API version actually exposed by your cluster.

Additional Notes

Replica high availability must be enabled at both the cluster and database levels for automatic replica migration to occur.
- See Replica HA configuration for details on how this works and how to enable it
In Kubernetes deployments, enabling ReplicaHA at the cluster level does not automatically enable it for each RedisEnterpriseDatabase resource.
- Use the Redis Enterprise API to configure this per database where needed.
For Active-Active databases, replica_ha is enabled by default.

When to Escalate

Escalate to Support if:

The API version appears correct, but the field is still rejected.
The cluster is running a version where documentation and API behavior appear inconsistent.
Replica high availability does not activate after successful configuration.

Related to