Get refresh token sharding stats

GET

/api/admin/settings/refresh-token-sharding/stats

Code sample: Shell / cURL

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

Returns refresh token family distribution by generation with the current shard config.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

clientId

string

Optional client ID. Omit for global stats.

Responses

200

Refresh token sharding statistics.

Media type application/json

object

clientId

string

config

object

currentGeneration

integer

currentShardCount

integer

previousGenerations

Array<object>

object

generation

integer

shardCount

integer

shard_count

integer

activatedAt

integer format: int64

deprecatedAt

integer | null format: int64

createdBy

string

notes

string | null

key

additional properties

updatedAt

integer format: int64

updatedBy

string

key

additional properties

stats

object

key

additional properties

key

additional properties

Example

{
  "clientId": "__global__",
  "config": {
    "currentGeneration": 2,
    "currentShardCount": 16,
    "previousGenerations": [
      {
        "generation": 1,
        "shardCount": 8,
        "deprecatedAt": 1769999999000
      }
    ],
    "updatedAt": 1770000000000,
    "updatedBy": "admin-api"
  },
  "stats": {
    "total": 42,
    "byGeneration": {
      "1": 2,
      "2": 40
    }
  }
}

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