Get Logger Models

Gets the list of logger models.

HTTP Request

GET /api/sonar/logger-models
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/logger-models?offset=0&limit=10
Request Parameters
KeyRequiredTypeDescriptionNote
offsetX32-bit integerNumber of records to skipDefault: 0
limitX32-bit integerMaximum number of records
keywordsXStringSearch available by logger model name name

Success Response

{
  "total_count": 2,
  "logger_models": [
    {
      "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,
      "created": "2023-10-01 09:18:27+0900",
      "updated": "2023-10-01 09:18:27+0900"
    },
    {
      "guid": "cd09b2b7-fbc3-11ed-9320-02d178f999a6",
      "name": "윈도우 XML 이벤트 로그",
      "description": null,
      "logger_factory_name": "windows-evtx",
      "logger_factory_display_name": null,
      "parser_code": null,
      "parser_name": null,
      "app_code": null,
      "app_built_in": null,
      "rule_count": 1,
      "created": "2023-10-01 09:18:27+0900",
      "updated": "2023-10-01 09:18:27+0900"
    }
  ]
}
  • total_count (32-bit integer): Total number of logger models that match the search keyword
  • logger_models (Array): Logger model list
    • guid (String): Logger model GUID
    • name (String): Logger model name
    • description (String): Logger model description
    • logger_factory_name (String): Logger factory identifier
    • logger_factory_display_name (String): Display name of the logger factory
    • 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
    • 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)
offset or limit value is not an integer

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}
offset or limit value is negative

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}