Get region shard config

GET

/api/admin/settings/region-shards

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/region-shards \
  --header 'Authorization: Bearer <token>'

Returns current region shard generation, region ranges, previous generations, colocation groups, and validation status.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Region shard configuration.

Media type application/json

object

currentGeneration

integer

currentTotalShards

integer

currentRegions

object

key

additional properties

previousGenerations

Array<object>

object

key

additional properties

maxPreviousGenerations

integer

updatedAt

integer format: int64

updatedBy

string

version

integer

groups

object

key

additional properties

object

totalShards

required

integer

>= 1

members

required

Array<string>

description

string

name

string

validation

object

valid

boolean

errors

Array<string>

warnings

Array<string>

key

additional properties

key

additional properties

Example

{
  "currentGeneration": 2,
  "currentTotalShards": 16,
  "currentRegions": {
    "iad": {
      "start": 0,
      "end": 7
    },
    "fra": {
      "start": 8,
      "end": 15
    }
  },
  "previousGenerations": [
    {
      "generation": 1,
      "totalShards": 8
    }
  ],
  "maxPreviousGenerations": 3,
  "updatedAt": 1770000000000,
  "updatedBy": "admin-api",
  "version": 2,
  "groups": {
    "user_client": {
      "name": "user_client",
      "totalShards": 16,
      "members": [
        "users",
        "clients"
      ]
    }
  },
  "validation": {
    "valid": true,
    "errors": [],
    "warnings": []
  }
}

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