Skip to content
Authrim

Inspect one retired assignment shard cleanup.

GET
/api/admin/platform/control-plane/shard-cleanup/{shardId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/platform/control-plane/shard-cleanup/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
shardId
required
string
>= 1 characters <= 128 characters /^[a-zA-Z0-9][a-zA-Z0-9._:-]*$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Inactive shard cleanup status.

Media type application/json
object
candidate
required
object
environmentId
required
string
>= 1 characters <= 128 characters
shardId
required
string
>= 1 characters <= 128 characters
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii
residencyPartition
required
string
>= 1 characters <= 128 characters
bindingRef
required
string
/^TDB_[A-Z0-9_]{1,123}$/
databaseId
required
string
>= 1 characters <= 256 characters
databaseName
required
string
>= 1 characters <= 128 characters /^[a-zA-Z0-9][a-zA-Z0-9_-]*$/
shardStatus
required
string
Allowed values: failed retired deleting deleted
quarantineOperationId
required
string | null
quarantineState
required
string
Allowed values: none quarantining quarantined
quarantineOperationState
required
string | null
Allowed values: draining ready_for_cleanup blocked canceled
denyRegistryGeneration
required
integer | null
>= 1
drainNotBefore
required
integer | null format: int64
registryVerifiedAt
required
integer | null format: int64
referencesVerifiedAt
required
integer | null format: int64
cleanupOperationId
required
string | null
cleanupState
required
string | null
Allowed values: approved removing_bindings deleting_database verifying_absence succeeded blocked
exportMode
required
string | null
Allowed values: skipped manual_verified
deleteDatabase
required
boolean | null
destructiveOperationsEnabled
required
boolean
availableActions
required
Array<string>
<= 4 items unique items
Allowed values: quarantine retry_quarantine approve_cleanup retry_cleanup
bindings
required
Array<object>
<= 64 items
object
workerScriptName
required
string
>= 1 characters <= 128 characters /^[a-zA-Z0-9][a-zA-Z0-9._-]*$/
bindingRef
required
string
/^TDB_[A-Z0-9_]{1,123}$/
state
required
string
Allowed values: pending removing removed blocked
lastErrorCode
required
string | null
updatedAt
required
integer format: int64
>= 1
key
additional properties
lastErrorCode
required
string | null
createdAt
required
integer format: int64
>= 1
updatedAt
required
integer format: int64
>= 1
key
additional properties
key
additional properties
Example 
{
  "candidate": {
    "dataRole": "tenant_core/default",
    "shardStatus": "failed",
    "quarantineState": "none",
    "quarantineOperationState": "draining",
    "cleanupState": "approved",
    "exportMode": "skipped",
    "availableActions": [
      "quarantine"
    ],
    "bindings": [
      {
        "state": "pending"
      }
    ]
  }
}

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

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

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