Skip to content
Authrim

Get environment read replication status.

GET
/api/admin/platform/read-replication
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/platform/read-replication \
  --header 'Authorization: Bearer <token>'

Returns the desired mode and aggregate convergence state for eligible Lookup and Control-managed assignment databases. This platform-wide operation is restricted to system administrators.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current read replication policy and convergence status.

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
key
additional properties
Example 
{
  "readReplication": {
    "desiredMode": "disabled",
    "aggregateStatus": "off",
    "operationStatus": "queued"
  }
}

401

Section titled “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

Section titled “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"
}

503

Section titled “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"
}