Set platform cache mode

POST

/api/admin/settings/cache-mode

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/settings/cache-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "fixed" }'

Sets the platform cache mode to maintenance or fixed and returns the resulting TTL configuration.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Platform cache mode update.

Media type application/json

object

mode

required

string

Allowed values: maintenance fixed

key

additional properties

Example

{
  "mode": "fixed"
}

Responses

200

Successful JSON response.

Media type application/json

object

success

boolean

mode

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

message

string

key

additional properties

Example

{
  "success": true,
  "mode": "fixed",
  "ttl_config": {
    "clientMetadata": 300,
    "redirectUris": 300,
    "grantTypes": 300,
    "scopes": 300,
    "jwks": 300,
    "clientSecret": 300,
    "tenant": 300,
    "policy": 300
  },
  "message": "Platform cache mode set to 'fixed'"
}

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

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

503

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