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.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors

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.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}

GET Monitor

Inquires information about the specified Monitor.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}

DELETE Monitor

Deletes the specified Monitor.

DELETE
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/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.

The request consumes application/json.

POST
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}/hosts

GET Monitor hosts

Produces list of host in the specified Monitor.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}/hosts

DELETE Monitor hosts

Deletes all hosts from the specified Monitor.

DELETE
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}/hosts
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}/hosts

PUT Monitor status

Sets the status of the specified Monitor.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}/status

GET Monitor status

Inquires the status of the specified Monitor.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/monitors/{monitor}/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/monitors/{monitor}/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/monitors/{monitor}/status

GET Tasks

Lists all the tasks from the specified System Profile.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks

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.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks/{task}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks/{task}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks/{task}

GET Task

Inquires information about the specified task.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks/{task}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks/{task}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks/{task}

DELETE Task

Deletes the specified task.

DELETE
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks/{task}
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks/{task}
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks/{task}

PUT Task status

Sets the status of the specified task.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks/{task}/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks/{task}/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks/{task}/status

GET Task status

Inquires the status of the specified task.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profile}/tasks/{task}/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profile}/tasks/{task}/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profile}/tasks/{task}/status