コンテンツにスキップ
Authrim

Start active-tenant disaster recovery.

POST
/api/admin/platform/control-plane/tenant-recovery
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/platform/control-plane/tenant-recovery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "tenantId": "example", "confirmation": "example" }'

Publishes a signed fail-closed route deny and starts the fixed drain period for one active tenant. D1 Time Travel restore remains an explicit operator action. Requires a human platform administrator and durable audit evidence.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
required
string
>= 1 characters <= 256 characters /^[a-zA-Z0-9][a-zA-Z0-9._:-]*$/

Request Body required

Section titled “Request Body required ”
Media type application/json
object
tenantId
required
string
confirmation
required

Must equal START_TENANT_RECOVERY:{tenantId}.

string
key
additional properties
Example generated
{
  "tenantId": "example",
  "confirmation": "example"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Recovery started and signed deny publication was observed.

Media type application/json
object
recovery
required
object
operationId
required
string
environmentId
required
string
tenantId
required
string
state
required
string
Allowed values: publishing_deny draining operator_restore_required verifying_restore reprojecting_lookup smoke_verifying ready_for_reactivation reactivating succeeded blocked canceled
pinnedRouteGeneration
required
integer
>= 1
denyRuntimeGeneration
required
integer | null format: int64
denyRegistryGeneration
required
integer | null format: int64
denyObservedAt
required
integer | null format: int64
drainNotBefore
required
integer | null format: int64
restoreReferenceRecorded
required
boolean
restoredAt
required
integer | null format: int64
migrationVerifiedAt
required
integer | null format: int64
lookupReprojectedAt
required
integer | null format: int64
lookupReprojection
required
object
stage
required
string
Allowed values: cleanup account_id email_exact external_core external_pii verify
targetIndex
required
integer
<= 4096
afterCreatedAt
required
integer format: int64
afterId
required
string
afterRowId
required
integer format: int64
projectedRows
required
integer format: int64
verifiedRows
required
integer format: int64
registryDigestPinned
required
boolean
leaseActive
required
boolean
key
additional properties
bindingSmokeVerifiedAt
required
integer | null format: int64
reactivatedRuntimeGeneration
required
integer | null format: int64
reactivatedAt
required
integer | null format: int64
lastErrorCode
required
string | null
canCancel
required
boolean
canConfirmRestore
required
boolean
canVerify
required
boolean
canReactivate
required
boolean
targets
required
Array<object>
>= 1 items <= 100 items unique items
object
shardId
required
string
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii
residencyPartition
required
string
assignmentGeneration
required
integer
>= 1
shardGeneration
required
integer
>= 1
bindingRef
required
string
/^[A-Z][A-Z0-9_]*$/
providerDatabaseId
required
string
migrationStreamId
required
string
Allowed values: core-d1 pii-d1
releaseId
required
string
manifestDigest
required
string
/^[a-f0-9]{64}$/
restoreConfirmedAt
required
integer | null format: int64
migrationVerifiedAt
required
integer | null format: int64
lookupReprojectedAt
required
integer | null format: int64
bindingSmokeVerifiedAt
required
integer | null format: int64
key
additional properties
createdAt
required
integer format: int64
updatedAt
required
integer format: int64
key
additional properties
auditId
required
string
key
additional properties
Example 
{
  "recovery": {
    "state": "publishing_deny",
    "lookupReprojection": {
      "stage": "cleanup"
    },
    "targets": [
      {
        "dataRole": "tenant_core/default",
        "migrationStreamId": "core-d1"
      }
    ]
  }
}

400

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

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"
}

409

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

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"
}