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.

GET Monitors

Lists all existing monitors of the specified System Profile.

GET
https://<server>:8021/api/v3/profiles/<profileid>/monitors
produces application/json

PUT Monitor

Creates a new monitor with the specified name in the specified System Profile. If such a monitor already exists, it will be overwritten.

Properties left unspecified will be assigned the default value of the specified type upon creation of the monitor. In case of existing monitor, only specified properties will be updated.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>
consumes application/json

GET Monitor

Inquires information about the specified Monitor.

GET
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>
produces application/json

DELETE Monitor

Deletes the specified Monitor.

DELETE
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>

POST Monitor hosts

Adds new hosts to the monitor. If several expressions are defined, a host must match all of them to be added to the monitor. If no host matches, the request won't affect the Monitor.

POST
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>/hosts
consumes application/json

GET Monitor hosts

Produces list of host in the specified Monitor.

GET
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>/hosts
produces application/json

DELETE Monitor hosts

Deletes all hosts from the specified Monitor.

DELETE
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>/hosts

PUT Monitor status

Sets the status of the specified Monitor.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>/status
consumes application/json

GET Monitor status

Inquires the status of the specified Monitor.

GET
https://<server>:8021/api/v3/profiles/<profileid>/monitors/<monitor>/status
produces application/json

GET Tasks

Lists all the tasks from the specified System Profile.

GET
https://<server>:8021/api/v3/profiles/<profileid>/tasks
produces application/json

PUT Task

Creates a new task with the specified name in the specified System Profile. If such a task already exists, if will be overwritten.

Properties left unspecified will be assigned the default value of the specified type upon creation of the task. In case of existing monitor, only specified properties will be updated. To set manual run the task, leave the schedule parameter empty.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/tasks/<task>
consumes application/json

GET Task

Inquires information about the specified task.

GET
https://<server>:8021/api/v3/profiles/<profileid>/tasks/<task>
produces application/json

DELETE Task

Deletes the specified task.

DELETE
https://<server>:8021/api/v3/profiles/<profileid>/tasks/<task>

PUT Task status

Sets the status of the specified task.

PUT
https://<server>:8021/api/v3/profiles/<profileid>/tasks/<task>/status
consumes application/json

GET Task status

Inquires the status of the specified task.

GET
https://<server>:8021/api/v3/profiles/<profileid>/tasks/<task>/status
produces application/json