Skip to content
Authrim

Approve quarantined source tenant data purge.

POST
/api/admin/tenants/{id}/placement-migrations/{operationId}/approve-purge
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/placement-migrations/example/approve-purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Records explicit purge approval after the Control Worker retention gate has expired. Only rows owned by the migrated tenant are eligible for the later purge operation.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
operationId
required
string

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
required
string
>= 1 characters <= 255 characters

Required replay-protection key retained for 15 minutes.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Redacted online tenant placement migration status.

Media type application/json
object
operation_id
required
string
tenant_id
required
string
target_isolation_policy
required
string
Allowed value: tenant_exclusive
status
required
string
Allowed values: queued running waiting_retry blocked succeeded canceled
current_step
required
string
attempt_count
required
integer
next_attempt_at
required
integer | null format: int64
last_error_code
required
string | null
lookup_progress
required
object
prepared_rows
required
integer
activated_rows
required
integer
verified_rows
required
integer
key
additional properties
steps
required
Array<object>
object
step
required
string
Allowed values: wait_control begin_route_cutover prepare_lookup prepare_alias commit_control publish_registry activate_alias activate_lookup verify_routes finalize_source complete
status
required
string
Allowed values: pending running waiting_retry blocked canceled completed
key
additional properties
created_at
required
integer format: int64
started_at
required
integer | null format: int64
completed_at
required
integer | null format: int64
updated_at
required
integer format: int64
control_status
required
string
Allowed values: available unavailable
control
required
One of:
object
operationId
required
string
tenantId
required
string
state
required
string
sourceIsolationPolicy
required
string
Allowed value: shared_pool
targetIsolationPolicy
required
string
Allowed value: tenant_exclusive
sourcePolicyGeneration
required
integer
>= 1
targetPolicyGeneration
required
integer
>= 2
writeFenceState
required
string
Allowed values: inactive requested active released
routeCutoverStarted
required
boolean
canCancel
required
boolean
canApprovePurge
required
boolean
sourceRetentionExpiresAt
integer | null format: int64
lastErrorCode
string | null
shards
required
Array<object>
object
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii
residencyPolicyId
required
string
residencyPartition
required
string
sourceShardId
required
string
sourceAssignmentGeneration
required
integer
>= 1
targetShardId
required
string | null
target
required
object | null
state
required
string
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "target_isolation_policy": "tenant_exclusive",
  "status": "queued",
  "steps": [
    {
      "step": "wait_control",
      "status": "pending"
    }
  ],
  "control_status": "available",
  "control": {
    "sourceIsolationPolicy": "shared_pool",
    "targetIsolationPolicy": "tenant_exclusive",
    "writeFenceState": "inactive",
    "shards": [
      {
        "dataRole": "tenant_core/default"
      }
    ]
  }
}

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

404

Section titled “404 ”

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