Get Parsers

Gets a list of the parsers that match the search keyword.

HTTP Request

GET /api/sonar/parsers
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/parsers
Request Parameters
KeyRequiredTypeDescriptionNote
offsetX32-bit integerNumber of records to skipDefault: 0
limitX32-bit integerMaximum number of records to load
typeXStringParser typeparser or normalizer
keywordsXStringKeywordSearch available by code, name

Success Response

{
  "total_count": 27,
  "parsers": [
    {
      "code": "fortigate",
      "name": "Fortigate",
      "description": "Parse Fortigate logs.",
      "factory_name": "fortigate",
      "factory_display_name": "Fortigate",
      "builtin": true,
      "configs": {
        "ver": "2"
      },
      "created": "2022-09-01 00:31:14+0900",
      "updated": "2022-09-01 00:31:14+0900"
    }
  ]
}
  • total_count (32-bit integer): Total number of parsers that match the search keyword
  • parsers (Array): Parser list
    • code (String): Parser code, referenced when calling the parser from the parse command.
    • name (String): Display name of the parser
    • description (String): Parser description
    • factory_name (String): Parser factory name
    • factory_display_name (String): Display name of parser type
    • builtin (Boolean): Whether the parser is built-in in the package
    • schema_code (String): Log schema code. (Only for log normalizers)
    • schema_name (String): Display name of the log schema. (Only for log normalizers)
    • configs (Map): List of key/value pairs in the Parser factory information.
    • created (String): Date and time of creation (yyyy-MM-dd HH:mm:ssZ)
    • updated (String): Date and time of last modification (yyyy-MM-dd HH:mm:ssZ)

Error Responses

Invalid parser type
{
  "error_code": "invalid-argument",
  "error_msg": "type should be 'parser' or 'normalizer': unknown"
}
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."
}