For the complete documentation index, see llms.txt. This page is also available as Markdown.

Administration

List all loggers

get

Returns all registered loggers with their explicit and effective levels, plus the current mode (file|runtime).

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
modestringRequired
activePresetstringOptional
get/api/v1/environments/{environment}/proxy/api/v1/admin/loggers
GET /api/v1/environments/{environment}/proxy/api/v1/admin/loggers HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "loggers": [
    {
      "name": "text",
      "level": "text",
      "effectiveLevel": "text"
    }
  ],
  "mode": "text",
  "activePreset": "text"
}

Set a logger's level

put

Sets the log level for a specific logger. This enters runtime mode, disabling auto-reload from the config file until a preset is applied.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
loggerNamestringRequired
levelstring · enumRequiredPossible values:
Responses
200Success
application/json
loggerNamestringRequired
previousLevelstringOptional
newLevelstringRequired
put/api/v1/environments/{environment}/proxy/api/v1/admin/loggers
PUT /api/v1/environments/{environment}/proxy/api/v1/admin/loggers HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "loggerName": "text",
  "level": "TRACE"
}
{
  "loggerName": "text",
  "previousLevel": "text",
  "newLevel": "text"
}

Get a specific logger

get

Returns information about a specific logger by name

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The logger name (e.g., 'io.lenses.http' or 'ROOT')

Responses
200Success
application/json
namestringRequired
levelstringOptional
effectiveLevelstringRequired
get/api/v1/environments/{environment}/proxy/api/v1/admin/loggers/{name}
GET /api/v1/environments/{environment}/proxy/api/v1/admin/loggers/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "name": "text",
  "level": "text",
  "effectiveLevel": "text"
}

List available log presets

get

Returns the list of available log configuration presets

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
activePresetstringOptional
get/api/v1/environments/{environment}/proxy/api/v1/admin/loggers/presets
GET /api/v1/environments/{environment}/proxy/api/v1/admin/loggers/presets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "presets": [
    {
      "name": "text",
      "description": "text",
      "rootLevel": "text"
    }
  ],
  "activePreset": "text"
}

Apply a log preset

put

Applies a log configuration preset, reloading the corresponding XML config file. Returns to file mode, re-enabling auto-reload.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The preset name (default, debug, or debug-kafka)

Responses
200Success
application/json
presetstringRequired
previousPresetstringOptional
loggersResetintegerRequired
put/api/v1/environments/{environment}/proxy/api/v1/admin/loggers/presets/{name}
PUT /api/v1/environments/{environment}/proxy/api/v1/admin/loggers/presets/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "preset": "text",
  "previousPreset": "text",
  "loggersReset": 1
}

Get logging status

get

Returns the current logging mode, active preset, and auto-reload state

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
modestringRequired
activePresetstringOptional
configFilestringRequired
autoReloadEnabledbooleanRequired
lastModifiedinteger · int64Optional
get/api/v1/environments/{environment}/proxy/api/v1/admin/loggers/status
GET /api/v1/environments/{environment}/proxy/api/v1/admin/loggers/status HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "mode": "text",
  "activePreset": "text",
  "configFile": "text",
  "autoReloadEnabled": true,
  "lastModified": 1
}

Last updated

Was this helpful?