コンテンツにスキップ

Run a tenant database probe

POST
/api/admin/logging-policies/runtime/tenant-db-probe
Code sample: Shell / cURL
curl --request POST \
--url https://auth.example.com/api/admin/logging-policies/runtime/tenant-db-probe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "tenant_123", "role": "tenant_core", "shard_group": "default", "shard_index": 0, "probe_kind": "write_read_delete" }'

Perform a write-read-delete runtime probe against a resolved tenant database shard and persist the probe result.

Media type application/json
object
tenant_id
string
role
string
Allowed values: tenant_core tenant_pii tenant_audit tenant_custom
shard_group
string
shard_index
integer
probe_kind
string
Allowed values: write_read_delete
key
additional properties
Example
{
"tenant_id": "tenant_123",
"role": "tenant_core",
"shard_group": "default",
"shard_index": 0,
"probe_kind": "write_read_delete"
}

Successful JSON response.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example
{
"result": {
"id": "tdp_123",
"tenant_id": "tenant_123",
"role": "tenant_core",
"shard_group": "default",
"shard_index": 0,
"probe_kind": "write_read_delete",
"status": "succeeded",
"latency_ms": 12,
"binding_ref": "DB",
"connection_ref": null,
"provider": "d1",
"schema_version": 1,
"error_class": null,
"error_message": null,
"metadata": {
"health_status": "healthy"
},
"checked_at": 1770000000
},
"audit_id": "audit_123"
}

Successful JSON response.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example
{
"result": {
"id": "tdp_123",
"tenant_id": "tenant_123",
"role": "tenant_core",
"shard_group": "default",
"shard_index": 0,
"probe_kind": "write_read_delete",
"status": "succeeded",
"latency_ms": 12,
"binding_ref": "DB",
"connection_ref": null,
"provider": "d1",
"schema_version": 1,
"error_class": null,
"error_message": null,
"metadata": {
"health_status": "healthy"
},
"checked_at": 1770000000
},
"audit_id": "audit_123"
}

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