Get Logger Factory

Retrieves information of a specified logger factory.

Required Permissions

Requires the GUEST role or higher.

HTTP Request

GET /api/sonar/logger-factories/:node_pair_guid/:namespace/:name
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/logger-factories/27102ae5-3698-44d4-aad5-4f2def80f275/local/syslog
Request Parameters
Path Parameters
KeyTypeDescriptionNote
node_pair_guidStringNode pair GUID36 characters
namespaceStringNamespacelocal or sentry identifier
nameStringIdentifierE.g. syslog, dirwatch

Success Response

{
  "logger_factory": {
    "full_name": "local\\syslog",
    "name": "syslog",
    "display_group": "Syslog",
    "group": "Syslog",
    "display_name": "Syslog",
    "namespace": "local",
    "description": "Collect TCP or UDP syslog packets"
  }
}
  • logger_factory (Map): Logger factory
    • full_name (String): Name in namespace\\identifier format
    • name (String): Identifier
    • display_group (String): Display name in locale language
    • group (String): Group identifier
    • display_name (String): Display name in locale language
    • namespace (String): Namespace. local or sentry identifier
    • description (String): Description

Error Responses

node_pair_guid is not in valid GUID format

HTTP status code 400

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

HTTP status code 200

{
  "logger_factory": null
}