Get Logger Model

Retrieves information of a specified logger model.

HTTP Request

GET /api/sonar/logger-models/:guid
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/logger-models/cd09ae6f-fbc3-11ed-9320-02d178f999a6
Request Parameter
KeyRequiredTypeDescriptionNote
guidOStringLogger model identifier36-characters GUID

Success Response

{
  "logger_model": {
    "guid": "cd09ae6f-fbc3-11ed-9320-02d178f999a6",
    "name": "WTMP",
    "description": null,
    "logger_factory_name": "wtmp",
    "logger_factory_display_name": "WTMP",
    "parser_code": null,
    "parser_name": null,
    "app_code": null,
    "app_built_in": null,
    "rule_count": 1,
    "rules": [
      {
        "guid": "cd0cdd74-fbc3-11ed-9320-02d178f999a6",
        "name": "WTMP - 인증",
        "log_schema_code": "auth",
        "log_schema_name": "인증",
        "parser_code": null,
        "parser_name": null,
        "stream_query": "eval action = case(type == \"UserProcess\", \"LOGIN\", type == \"DeadProcess\", \"LOGOUT\"), src_ip = ip(host), user = if(len(user) == 0, null, user)",
        "stream_interval": 60,
        "app_code": null,
        "app_built_in": null
      }
    ],
    "created": "2023-10-01 09:18:27+0900",
    "updated": "2023-10-01 09:18:27+0900"
  }
}
  • logger_model (Map): Logger model
    • guid (String): Logger model identifier
    • name (String): Logger model name
    • description (String): Logger model description
    • logger_factory_name (String): Logger factory identifier
    • logger_factory_display_name (String): Logger factory display name
    • parser_code (String): Parser identifier
    • parser_name (String): Parser name
    • app_code (String): App code as identifier
    • app_built_in (Boolean): Whether the logger model is built in the app
    • rule_count (32-bit integer): Total number of normalization rules
    • rules (Array): Normalization rule list
      • guid (String): Normalization rule identifier
      • name (String): Normalization rule name
      • log_schema_code (String): Log schema identifier
      • log_schema_name (String): Log schema name
      • parser_code (String): Parser identifier
      • parser_name (String): Parser name
      • stream_query (String): Stream query
      • stream_interval (32-bit integer): Stream query refresh interval
      • app_code (String): App code as identifier
      • app_built_in (Boolean): Whether the logger model is built in the app
    • created (String): Creation date and time (yyyy-MM-dd HH:mm:ssZ)
    • updated (String): Last modification date and time (yyyy-MM-dd HH:mm:ssZ)

Error Responses

Identifier is not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
Logger model is not found

HTTP status code 200

{
  "logger_model": null
}