Force region shard generation migration

POST

/api/admin/settings/region-shards/migrate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/settings/region-shards/migrate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "prefix migration", "force": true }'

Creates a new region shard generation without changing the current shard distribution.

Authorizations

• adminBearer
• adminSessionCookie

Request Body

Media type application/json

object

reason

string

force

boolean

key

additional properties

Example

{
  "reason": "prefix migration",
  "force": true
}

Responses

200

Region shard generation migrated.

Media type application/json

object

success

boolean

message

string

previousGeneration

integer

currentGeneration

integer

reason

string

residency

Server-owned residency boundary that constrains region shard placement.

object

version

required

integer

Allowed values: 1

residencyPolicyId

required

string

residencyPartition

required

string

policyGeneration

required

integer

>= 1

allowedRegions

required

Array<string>

>= 1 items unique items

Allowed values: apac weur eeur enam wnam oc afr me

jurisdiction

required

string

nullable

Allowed values: eu fedramp

key

additional properties

note

string

key

additional properties

Example

{
  "success": true,
  "message": "Generation incremented successfully.",
  "previousGeneration": 1,
  "currentGeneration": 2,
  "reason": "prefix migration",
  "note": "All new resources will use the new generation. Existing resources will continue to use their embedded generation until they expire."
}

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

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

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

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

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