Skip to content
Authrim

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

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
reason
string
force
boolean
key
additional properties
Example 
{
  "reason": "prefix migration",
  "force": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Region shard generation migrated.

Media type application/json
object
success
boolean
message
string
previousGeneration
integer
currentGeneration
integer
reason
string
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

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

404

Section titled “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

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