Skip to content
Authrim

Update Check API audit setting

PUT
/api/admin/settings/check-api-audit/{name}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/check-api-audit/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "value": true }'

Updates one Check API audit setting after validating its declared boolean, number, or enum-string type.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required
string

Request Body required

Section titled “Request Body required ”

Check API audit setting update.

Media type application/json
object
value
required
One of:
boolean
key
additional properties
Example 
{
  "value": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
boolean
setting
string
value
One of:
boolean
note
string
key
additional properties
Example 
{
  "success": true,
  "setting": "CHECK_API_AUDIT_ENABLED",
  "value": true,
  "note": "Setting updated. Cache will refresh within 5 minutes."
}

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