Reset region shard config

DELETE

/api/admin/settings/region-shards

Code sample: Shell / cURL

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

Deletes tenant-scoped region shard config so defaults apply to new resources.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Region shard configuration reset.

Media type application/json

object

success

boolean

message

string

defaults

object

totalShards

integer

allowedRegions

Array<string>

Allowed values: apac weur eeur enam wnam oc afr me

regions

object

key

additional properties

groups

object

key

additional properties

object

totalShards

required

integer

>= 1

members

required

Array<string>

description

string

name

string

key

additional properties

note

string

key

additional properties

Example

{
  "success": true,
  "message": "Region shard configuration deleted. System will use defaults.",
  "defaults": {
    "totalShards": 8,
    "regionDistribution": {
      "iad": 100
    },
    "regions": {
      "iad": {
        "start": 0,
        "end": 7
      }
    },
    "groups": {
      "user_client": {
        "name": "user_client",
        "totalShards": 16,
        "members": [
          "users",
          "clients"
        ]
      }
    }
  },
  "note": "Existing resources with embedded generation/region info will continue to work."
}

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