Skip to content
Authrim

Set client cache mode.

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

Sets or clears a client-specific cache mode override. Send mode: null to remove the client override and fall back to the platform default.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
clientId
required
string

Client identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
mode
required
string | null
Allowed values: maintenance fixed
key
additional properties
Example 
{
  "mode": "fixed"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Client cache mode update response.

Media type application/json
object
client_id
required
string
mode
required
string | null
Allowed values: maintenance fixed
effective
required
string
Allowed values: maintenance fixed
uses_platform_default
required
boolean
success
required
boolean
message
required
string
Example 
{
  "client_id": "client_123",
  "mode": null,
  "effective": "maintenance",
  "uses_platform_default": true
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}