Skip to content
Authrim

Request a server-owned D1 capacity plan.

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

Recomputes and records the selected capacity profile as canonical Control DB operations. Control executes them automatically when provisioning is enabled; otherwise setup can claim the same operations as the fenced operator executor. The request is human-platform-admin only, idempotent, and audited before mutation.

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
profile
required
string
Allowed values: minimum recommended extra_headroom
scope
required
string
Allowed values: shared_pool tenant_exclusive
tenantId
required

Required for tenant_exclusive and null for shared_pool.

string | null
<= 128 characters
key
additional properties

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Canonical capacity operations accepted.

Media type application/json
object
result
required
object
preview
required
object
profile
required
string
Allowed values: minimum recommended extra_headroom
scope
required
string
Allowed values: shared_pool tenant_exclusive
tenantId
required
string | null
<= 128 characters
dryRun
required
boolean
available
required
boolean
reasonCode
required
string | null
Allowed values: capacity_profile_unavailable environment_d1_limit
capacityUnitsAdded
required
integer
d1DatabasesAdded
required
integer
projectedEnvironmentD1Count
required
integer
targets
required
Array<object>
object
unitKey
required
string
unitIndex
required
integer
>= 1
workerScripts
required
Array<string>
>= 1 items unique items
operationId
required
string
environmentId
required
string
dataRole
required
string
Allowed values: tenant_core/default tenant_core/users tenant_pii lookup
residencyPolicyId
required
string
residencyPartition
required
string
lookupCapacityDomainId
required

Explicit Lookup capacity-sharing boundary. Non-null only when dataRole is lookup.

string | null
<= 128 characters
logicalShardId
required
string
databaseName
required
string
bindingRef
required
string
readReplicationMode
required
string
Allowed values: enabled disabled
migrationStreamId
required
string
Allowed values: core-d1 pii-d1 lookup-d1
key
additional properties
key
additional properties
operations
required
Array<object>
unique items
object
operationId
required
string
status
required
string
Allowed values: queued running waiting_retry succeeded blocked canceled
attemptCount
required
integer
nextAttemptAt
required
integer | null format: int64
lastErrorCode
required
string | null
createdAt
required
integer format: int64
updatedAt
required
integer format: int64
key
additional properties
key
additional properties
auditId
required
string
key
additional properties
Example 
{
  "result": {
    "preview": {
      "profile": "minimum",
      "scope": "shared_pool",
      "dryRun": true,
      "reasonCode": "capacity_profile_unavailable",
      "targets": [
        {
          "dataRole": "tenant_core/default",
          "readReplicationMode": "enabled",
          "migrationStreamId": "core-d1"
        }
      ]
    },
    "operations": [
      {
        "status": "queued"
      }
    ]
  }
}

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