Skip to content
Authrim

Inspect the current D1 storage topology.

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

Returns a secret-free Control snapshot of tenant and Lookup shards, account-capacity utilization, ready spares, recent provisioning operations, and the environment-scoped Cloudflare D1 inventory. If the Cloudflare inventory API is temporarily unavailable, the Control snapshot remains available and providerInventoryAvailable is false.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current D1 storage topology.

Media type application/json
object
topology
required
object
environmentId
required
string
<= 128 characters
generatedAt
required
integer format: int64
policy
required
object
maxConcurrentProvisioning
required
integer
maxReadySpares
required
integer
maxD1Resources
required
integer
dailyD1CreateBudget
required
integer
dailyD1CreateUsed
required
integer
dailyD1CreateRemaining
required
integer
targetAccountCount
required
integer
key
additional properties
summary
required
object
providerInventoryAvailable
required
boolean
providerD1Count
required
integer | null
controlManagedD1Count
required
integer
tenantShardCount
required
integer
lookupShardCount
required
integer
activeTenantShardCount
required
integer
readySpareCount
required
integer
provisioningD1Count
required
integer
failedD1Count
required
integer
accountCount
required
integer
inFlightOperationCount
required
integer
blockedOperationCount
required
integer
key
additional properties
tenants
required
Array<object>
<= 1000 items
object
tenantId
required
string
<= 128 characters
isolationPolicy
required
string
Allowed values: shared_pool tenant_exclusive
policyState
required
string
Allowed values: provisioning active migrating retired
accountCount
required
integer
assignedShardCount
required
integer
key
additional properties
tenantShards
required
Array<object>
<= 1000 items
object
shardId
required
string
desiredResourceId
required
string
databaseName
required
string
providerDatabaseId
required
string | null
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii
allocationScope
required
string
Allowed values: shared_pool tenant_exclusive
ownerTenantId
required
string | null
residencyPartition
required
string
status
required
string
Allowed values: requested provisioning ready active degraded failed retired deleting deleted
healthStatus
required
string | null
Allowed values: unknown healthy warning degraded unavailable
allocationStatus
required
string | null
Allowed values: eligible draining full blocked
targetAccountCount
required
integer | null
allocatedAccountCount
required
integer | null
observedAccountCount
required
integer | null
storageBytes
required
integer | null format: int64
activeAssignmentCount
required
integer
createdAt
required
integer format: int64
updatedAt
required
integer format: int64
key
additional properties
lookupShards
required
Array<object>
<= 1000 items
object
lookupShardId
required
string
desiredResourceId
required
string
databaseName
required
string
providerDatabaseId
required
string | null
residencyPartition
required
string
status
required
string
Allowed values: requested provisioning ready active draining retired failed
capacityWeight
required
number
> 0
activeBucketCount
required
integer
createdAt
required
integer format: int64
updatedAt
required
integer format: int64
key
additional properties
operations
required
Array<object>
<= 100 items
object
operationId
required
string
tenantId
required
string | null
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii lookup
databaseName
required
string
providerDatabaseId
required
string | null
provisioningState
required
string
Allowed values: requested creating ready active degraded failed deleting deleted
status
required
string
Allowed values: queued running waiting_retry succeeded blocked canceled
attemptCount
required
integer
lastErrorCode
required
string | null
decidedAt
required
integer format: int64
createStartedAt
required
integer | null format: int64
readyAt
required
integer | null format: int64
updatedAt
required
integer format: int64
key
additional properties
providerDatabases
required
Array<object>
<= 1000 items
object
databaseId
required
string
databaseName
required
string
createdAt
required
string | null format: date-time
fileSizeBytes
required
integer | null format: int64
managedByControl
required
boolean
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "topology": {
    "tenants": [
      {
        "isolationPolicy": "shared_pool",
        "policyState": "provisioning"
      }
    ],
    "tenantShards": [
      {
        "dataRole": "tenant_core/default",
        "allocationScope": "shared_pool",
        "status": "requested",
        "healthStatus": "unknown",
        "allocationStatus": "eligible"
      }
    ],
    "lookupShards": [
      {
        "status": "requested"
      }
    ],
    "operations": [
      {
        "dataRole": "tenant_core/default",
        "provisioningState": "requested",
        "status": "queued"
      }
    ]
  }
}

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

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