REST Resources

/api/space/device-management/get-syslog-events

The following operation is supported on this resource:

  • POST - Get syslog events from device
POST /get-syslog-eventsVersion 2

This API is used to start syslog events on managed devices. It makes an asynchronous call to the syslog service.

Sample Usage

This API makes an asynchronous method call, so you can, optionally, specify queue and schedule parameters:

POST /get-syslog-events?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:

    <get-syslog-events>
      <devices>
        <device href="/api/space/device-management/devices/1234"/>
        <device href="/api/space/device-management/devices/5678"/>
      </devices>
      <text-patterns>
        <text-pattern>pattern1</text-pattern>
        <text-pattern>pattern2</text-pattern>
      </text-patterns>
    </get-syslog-events>

  • Sample Output XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <task>
        <id>720908</id>
      </task>

  • Sample Input JSON:

    {
       "get-syslog-events":{
         "devices":{
           "device":{
             "@href":"/api/space/device-management/devices/1234"
           }
         },
         "text-patterns":{
           "text-pattern":[
             "pattern1",
             "pattern2"
           ]
         },
       }
    }

  • Sample Output JSON:

    {
       "task":{
         "id":1245226
       }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead

      For the deprecated versions of this API, refer to :
    • version 1