Get platform cache mode

GET

/api/admin/settings/cache-mode

Code sample: Shell / cURL

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

Returns platform cache-mode override, effective mode, and TTL values used by Authrim caches.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Successful JSON response.

Media type application/json

object

mode

string | null

Allowed values: maintenance fixed

effective

string

Allowed values: maintenance fixed

ttl_config

object

clientMetadata

integer

redirectUris

integer

grantTypes

integer

scopes

integer

jwks

integer

clientSecret

integer

tenant

integer

policy

integer

key

additional properties

integer

key

additional properties

Example

{
  "mode": "maintenance",
  "effective": "maintenance",
  "ttl_config": {
    "clientMetadata": 30,
    "redirectUris": 30,
    "grantTypes": 30,
    "scopes": 30,
    "jwks": 30,
    "clientSecret": 30,
    "tenant": 30,
    "policy": 30
  }
}

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

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