Get Parser Factory

Retrieves information of a specified parser factory.

Required Permissions

Requires the GUEST role or higher.

HTTP Request

GET /api/sonar/parser-factories/:name

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/parser-factories/regex?locale=ko"

Request Parameters

Key	Required	Type	Description	Note
name	O	String	Parser factory name
locale	X	String	Locale	`en` or `ko`

Success Response

Below is the example of retrieving regular expression parser factory.

{
  "factory": {
    "name": "regex",
    "display_name": "Regular Expression",
    "display_group": "General",
    "description": "Parse logs using regular expression.",
    "deprecated": false,
    "options": [
      {
        "type": "string",
        "subtype": null,
        "name": "regex",
        "required": true,
        "display_name": "Regex",
        "description": "Regular expression with placeholder.",
        "default_value": null
      },
      {
        "type": "string",
        "subtype": null,
        "name": "field",
        "required": false,
        "display_name": "Target field",
        "description": "Parse target field. 'line' field by default.",
        "default_value": null
      },
      {
        "type": "string",
        "subtype": null,
        "name": "include_original_field",
        "required": false,
        "display_name": "Include original field",
        "description": "Include original field",
        "default_value": null
      }
    ]
  }
}

groups (Array): List of parser group names
factories (Array): List of parser factories
- name (String): Parser factory name
- display_name (String): Display name of the parser factory
- display_group (String): Display group of the parser factory
- description (String): Parser factory description
- options (Array): Option details
  - type (String): Data type. One of the following: string, integer, boolean.
  - subtype (String): Extension component type in the UI
  - name (String): Option Key name
  - required (Boolean): Whether required or not
  - display_name (String): Display name in locale language
  - description (String): Description in locale language
  - default_value (String): Default value to display on screen
- deprecated (Boolean): Whether to be deprecated or not. If a parser factory was set to "deprecated" in a previous version, it is only available with the existing settings and cannot be modified.