Tasks and monitors (REST)

Execution of tasks and monitors can be triggered by REST services. Some REST services also provide information if execution of specific tasks and monitors is currently ongoing.

Tasks

Run a task

GET https://<server>:8021/rest/management/profiles/<profilename>/tasks/<taskname>/run Produces text/xml

The resulting XML document contains a result root node with a value attribute of true or false. A value of true indicates that execution of the specified task was successfully triggered. HTTP response code 404 (Not Found) returns if the task is not available.

Check running state

GET https://<server>:8021/rest/management/profiles/<profilename>/tasks/<taskname>/isrunning Produces text/xml

The resulting XML document contains a result root node with a value attribute of true or false, which indicates whether execution of the specified task or monitor is currently ongoing. HTTP response code 404 (Not Found) is returned if the task is not available.

Monitors

Similar to the interfaces running a Task and check its running state, also Monitorscan be ran and checked.

Run a monitor

GET https://<server>:8021/rest/management/profiles/<profilename>/monitors/<monitorname>/run Produces text/xml

Check running state

GET https://<server>:8021/rest/management/profiles/<profilename>/monitors/<monitorname>/isrunning Produces text/xml