Set environment read replication mode.

PUT

/api/admin/platform/read-replication

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/platform/read-replication \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "enabled": true }'

Starts an asynchronous environment-wide rollout for all eligible Lookup and Control-managed assignment databases. Control and Plugin Runner databases are never included.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 256 characters /^[a-zA-Z0-9][a-zA-Z0-9._:-]*$/

Request Body ^required

Media type application/json

object

enabled

required

boolean

key

additional properties

Example ^generated

{
  "enabled": true
}

Responses

202

Rollout accepted or an idempotent rollout returned.

Media type application/json

object

readReplication

required

object

environmentId

required

string

desiredMode

required

string

Allowed values: disabled enabled

aggregateStatus

required

string

Allowed values: off on updating attention_required

operationId

required

string | null

operationStatus

required

string | null

Allowed values: queued applying verifying attention_required succeeded blocked

eligiblePolicyCount

required

integer

convergedPolicyCount

required

integer

failedPolicyCount

required

integer

targetCount

required

integer

convergedTargetCount

required

integer

pendingTargetCount

required

integer

failedTargetCount

required

integer

updatedAt

required

integer format: int64

key

additional properties

auditId

required

string

key

additional properties

Example

{
  "readReplication": {
    "desiredMode": "disabled",
    "aggregateStatus": "off",
    "operationStatus": "queued"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}