Create Logger

Creates a new logger. Administrator privileges are required to call this API.

HTTP Request

POST /api/sonar/loggers
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -d model_guid="cd09ae6f-fbc3-11ed-9320-02d178f999a6" \
     -d name="WTMP" \
     -d node_pair_guid="27102ae5-3698-44d4-aad5-4f2def80f275" \
     -d table_name="WTMP" \
     -d interval=5000 \
     -d 'configs={"path": "/var/log/wtmp"}' \
     -X POST https://HOSTNAME/api/sonar/loggers
Request Parameters
KeyRequiredTypeDescriptionNote
guidXStringLogger identifier36-characters GUID. If not specified, randomly generated.
model_guidOStringLogger model identifier36-characters GUID
nameOStringLogger nameMinimum 1 to maximum 50 characters.
descriptionXStringLogger descriptionMaximum 2,000 characters
node_pair_guidOStringNode pair identifier36 characters
table_nameOStringTable name
sentry_guidXStringSentry identifier
intervalX32-bit integerLogger intervalMinimum 1000 (Unit: milliseconds)
cron_scheduleXStringLogger scheduleCRON schedule expression
asset_guidXStringAsset identifierAsset IP address
configsXKey/value stringConfiguration detailsSee Get Logger Factory Options.

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}
Identifier is not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "asset_guid should be guid type."
}
Invalid argument length

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'name' must be less than or equal to 50 characters."
}
CRON schedule expression is not valid

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "wrong cron expression format: * * * *"
}
Logger model is not found

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "logger model not found: bd09ae6f-fbc3-11ed-9320-02d178f999a6"
}
Node pair is not found

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "node pair not found: 37102ae5-3698-44d4-aad5-4f2def80f275"
}
Sentry is not found

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "sentry not found: test"
}
Asset is not found
{
  "error_code": "illegal-state",
  "error_msg": "asset not found: cd09ae6f-fbc3-11ed-9320-02d178f999a6"
}
No administrator privileges

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}