Get Check API audit settings

GET

/api/admin/settings/check-api-audit

Code sample: Shell / cURL

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

Returns Check API audit settings, default values, metadata, validation constraints, and whether each value comes from KV or defaults.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Successful JSON response.

Media type application/json

object

settings

object

key

additional properties

object

value

string | null

source

string

Allowed values: kv default

default

metadata

Setting metadata and validation constraints.

object

key

additional properties

key

additional properties

key

additional properties

Example

{
  "settings": {
    "CHECK_API_AUDIT_ENABLED": {
      "value": "true",
      "source": "kv",
      "default": false,
      "metadata": {
        "type": "boolean",
        "description": "Enable or disable Check API audit logging",
        "default": false
      }
    },
    "CHECK_API_AUDIT_MODE": {
      "value": null,
      "source": "default",
      "default": "waitUntil",
      "metadata": {
        "type": "string",
        "description": "Audit log recording mode: waitUntil (non-blocking), sync (guaranteed), queue (high-scale)",
        "default": "waitUntil",
        "enum": [
          "waitUntil",
          "sync",
          "queue"
        ]
      }
    }
  }
}

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