GET /service/forwarders/settings

Use this GET method to retrieve information about whether service data is forwarded to the preferred service provider when a serviceable event that is on the list of excluded events occurs.

Note: This API requires Lenovo XClarity Administrator v1.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/service/forwarders/settings

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
500 Internal server error

Response body

Attributes Type Description
excludeEvents Boolean Indicates whether service data is automatically forwarded when an excluded serviceable event occurs. This can be one of the following values.
  • true. Forwards excluded serviceable events

  • false. Does not forward excluded serviceable events.

Response example

{
   "excludeEvents":"true"
}