コンテンツにスキップ
Authrim

Create a tenant database activation batch job.

POST
/api/admin/jobs/tenant-databases/activate-batch
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/jobs/tenant-databases/activate-batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "activation_batch_id": "batch_2026_02", "targets": [ { "tenant_id": "acme", "generation": 2, "roles": [ "tenant_core", "tenant_pii" ] } ], "require_health_check": true, "require_binding_reconciliation": true, "execution_mode": "plan_only" }'

Creates a tenant-database/activate-batch deployment request for system storage operators. This is a plan/operator handoff job and is rejected when tenant D1 pool mode is managed by setup tooling.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
activation_batch_id
string
>= 1 characters <= 128 characters
targets
required
Array<object>
>= 1 items <= 500 items
object
tenant_id
required
string
>= 1 characters <= 128 characters
generation
required
integer
>= 1
roles
Array<string>
>= 1 items
Allowed values: tenant_core tenant_pii
key
additional properties
scheduled_window
object
not_before
string format: date-time
not_after
string format: date-time
timezone
string
>= 1 characters <= 64 characters
key
additional properties
require_health_check
boolean
default: true
require_binding_reconciliation
boolean
default: true
execution_mode
string
default: plan_only
Allowed values: plan_only operator_cli
reason
string
>= 1 characters <= 500 characters
key
additional properties
Example 
{
  "activation_batch_id": "batch_2026_02",
  "targets": [
    {
      "tenant_id": "acme",
      "generation": 2,
      "roles": [
        "tenant_core",
        "tenant_pii"
      ]
    }
  ],
  "require_health_check": true,
  "require_binding_reconciliation": true,
  "execution_mode": "plan_only"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Tenant database activation batch request accepted response.

Media type application/json
object
job_id
required
string
job_type
required
string
Allowed values: tenant-database/activate-batch
status
required
string
Allowed values: pending
target_count
required
integer
>= 1
created_by
required
string
created_at
required
string format: date-time
key
additional properties
Example 
{
  "job_type": "tenant-database/activate-batch",
  "status": "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"
}

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

500

Section titled “500 ”

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