Set syslog settings

Set settings used to send logs to syslog server RFC5424

application/json

Request Body required

• enabled boolean required

  If enabled logs will be send to server

• tag string

  Possible values: Value must match regular expression ^[a-zA-Z0-9]{1,32}$

  Alphanumeric, maximum length is 32 symbols

• server object required

  This model describe syslog server configuration

  server string

  Syslog server address

  port integer

  Port number

  severity integer

  Possible values: <= 7

  Events with this severity and higher will be send to server

Responses

• 200
• 400
• 401
• 403

---

OK

• Wrong server
• Wrong severity number. Available value is in range [0..7]
• Wrong port number. Available value is in range [0..65535]
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Wrong server
• Wrong severity
• Wrong port
• Base
• No value
• Wrong param type

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong server"
}

{
  "error": "Wrong severity number. Available value is in range [0..7]"
}

{
  "error": "Wrong port number. Available value is in range [0..65535]"
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...