docs/operations/replication-check.md
GET /BUCKET?replication-check is a signed S3 extension for validating every
replication target referenced by a bucket replication configuration.
Despite using GET, this operation is not read-only. On each target it:
.rustfs.sys/replication-check/<uuid>/<uuid>;Callers should obtain operator confirmation before sending the request. Probe
keys use a reserved namespace and two independent random UUIDs. Before writing,
the server verifies that no version or delete marker exists at the exact key,
then uses an atomic If-None-Match: * write so it cannot overwrite a key created
concurrently by an application.
The route returns HTTP 200 with JSON after all configured targets have been
checked. Status is FAILED when any target or cleanup phase failed; successful
target results remain present when another target fails.
{
"Status": "FAILED",
"ActiveMutation": true,
"MutationDescription": "Writes a probe object, creates a delete marker, deletes the probe version, and cleans up all probe artifacts on each target.",
"ProbeNamespace": ".rustfs.sys/replication-check/",
"Targets": [
{
"Arn": "arn:minio:replication::target",
"Bucket": "replica",
"Status": "FAILED",
"Error": "probe cleanup failed: target delete object version check failed: AccessDenied",
"Phases": {
"Bucket": { "Status": "OK" },
"Versioning": { "Status": "OK" },
"ObjectLock": { "Status": "OK" },
"Put": { "Status": "OK" },
"VersionFidelity": { "Status": "OK" },
"DeleteMarker": { "Status": "OK" },
"VersionDelete": { "Status": "OK" },
"Cleanup": {
"Status": "FAILED",
"Error": "target delete object version check failed: AccessDenied"
}
}
}
]
}
Phase states are OK, FAILED, or SKIPPED. Errors are single-line, bounded
to 512 bytes, and omit remote messages, endpoints, credentials, signatures, and
authorization material. A cleanup failure is always explicit; it is never
reported as a successful check.
VersionFidelity pins the version-identity contract on both write paths:
the probe PUT carries a source version id (header plus ?versionId= query,
the exact shape live replication uses) and the target must answer with the
same id, and a second probe repeats it through CreateMultipartUpload ->
UploadPart -> CompleteMultipartUpload, where the target fixes the version at
initiate and only reports it on completion. A target can adopt PutObject ids
and still mint its own for multipart, which would leave multipart deletes and
heals addressing a version that never existed; the failure message names the
path that drifted. Targets that
mint their own version ids break every version-addressed operation that
follows (version deletes, heal re-drives), so the phase fails with the
machine-readable extension key "Code": "BucketRemoteTargetVersionMismatch",
the later mutation phases are skipped, and cleanup still removes the probe via
the version id the target actually assigned. Code only appears on failures
that callers are expected to branch on; Go decoders ignore the unknown key.