Checkmk

App · 14 actions

Act on Checkmk monitoring from workflows: list problems, acknowledge them with a ticket number, schedule downtime around a change, run a check now, and add, change or delete hosts from an asset system and activate the changes. Start a workflow when a host goes down, a service goes critical or warning, or a problem recovers.

Actions

ActionWhat it does
Acknowledge problemAcknowledge a host's or a service's problem with a comment, such as a ticket number, so Checkmk shows someone is on it and stops notifying about it.
Activate changesActivate the pending changes, such as hosts added or deleted, so Checkmk monitors them that way, and wait until it's done.
Create hostAdd a host to Checkmk in a folder, with its IP address, such as from an asset system.
Delete hostDelete a host from Checkmk, such as when a server is retired.
Discover servicesScan a host for its services, such as its disks and network interfaces, and monitor the new ones, as Checkmk's Service discovery page does.
Get host statusGet a host's state (UP, DOWN or UNREACHABLE), its address and groups, how many of its services are OK, warning or critical, and its service problems.
Get service statusGet a service's state (OK, WARN, CRIT or UNKNOWN), what its check said and whether someone has acknowledged it.
List host groupsList the host groups, with their hosts and how many are down.
List hostsList the hosts in a folder, with their IP address, labels and state.
List problemsList the problems going on now as rows: hosts down or unreachable and services critical, warning or unknown, with what each check said, worst first.
Remove downtimeEnd a host's or service's downtime now, by its ID from 'Schedule downtime', or every downtime on the host or service.
Reschedule checkRun a host's or a service's check now, such as after a fix, rather than at its next interval, and get the new result.
Schedule downtimeSchedule downtime for a host, or some of its services, for a change window, so their problems don't notify anyone.
Update hostChange a host's IP address, alias or labels, or move it to another folder.

Acknowledge problem

Acknowledge a host's or a service's problem with a comment, such as a ticket number, so Checkmk shows someone is on it and stops notifying about it.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
Serviceservicetext
The service's name as Checkmk shows it, such as Filesystem /var. Leave blank for the host itself.
CommentcommenttextRequired
Why, or who's on it, such as Ticket INC-1042 opened.
Until it's OKstickytrue/false
Keep the acknowledgement until the problem is OK (or UP) again. Turn off to end it at the next change of state, such as from WARN to CRIT.Default: true.
Notify contactsnotifytrue/false
Tell the host's or service's contacts it was acknowledged, as Checkmk's own form does.Default: true.
Expiresexpiresdate and time
When the acknowledgement ends by itself. Leave blank to keep it.

Outputs

acknowledgedtrue/false
True when someone has acknowledged the problem
commenttext
The comment the acknowledgement was given
host_groupslist
The host groups its host is in
host_nametext
The host's name in Checkmk, such as web01
in_downtimetrue/false
True while it (or its host) is in a scheduled downtime
last_checktext
When it was last checked, in UTC
linktext
A link to it in Checkmk
long_outputtext
The check's longer output, when it gives one
object_typetext
host or service
outputtext
What the check said, such as CRIT - 98% used
servicetext
The service's name, such as CPU load; empty for the host itself
sincetext
When it got into this state, in UTC
statetext
The state as Checkmk shows it: UP, DOWN, UNREACHABLE or PENDING for a host; OK, WARN, CRIT, UNKNOWN or PENDING for a service
Example output
{
  "acknowledged": true,
  "comment": "Ticket INC-1042 opened",
  "host_groups": [
    "databases"
  ],
  "host_name": "db01",
  "in_downtime": false,
  "last_check": "2026-03-14T22:03:47Z",
  "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=service&host=db01&service=Filesystem+%2Fvar",
  "long_output": "",
  "object_type": "service",
  "output": "Used: 96.12% - 48.1 GiB of 50.0 GiB (warn/crit at 80.00%/90.00% used)",
  "service": "Filesystem /var",
  "since": "2026-03-14T20:41:17Z",
  "state": "CRIT"
}

Activate changes

Activate the pending changes, such as hosts added or deleted, so Checkmk monitors them that way, and wait until it's done.

Inputs

Include other users' changesinclude_other_userstrue/false
Also activate changes other people made. Needs the Administrator role; without it, only the automation user's own changes can be activated.Default: false.

Outputs

activatedtrue/false
False when there was nothing to activate
activation_idtext
Checkmk's ID for the activation
changeslist
The changes activated
countnumber
How many changes were activated
messagetext
What happened, in a sentence
siteslist
The sites it was activated on
Example output
{
  "activated": true,
  "activation_id": "ef0780ea-46a1-478a-a4ee-6fdb353672e8",
  "changes": [
    {
      "change": "Created new host web03.",
      "id": "80ef400c-7fe2-4e75-9bc1-f952d3f470ae",
      "time": "2026-03-14T21:50:48Z",
      "user": "lodol"
    }
  ],
  "count": 1,
  "message": "Activated 1 changes.",
  "sites": [
    "mysite"
  ]
}

Create host

Add a host to Checkmk in a folder, with its IP address, such as from an asset system. Discover its services and activate changes to monitor it.

Inputs

Host namehost_nametextRequired
The host's name in Checkmk, such as web03.yourcity.gov: letters, numbers, dots, dashes and underscores.
Folderfoldertext
The folder's path as Checkmk's Hosts page shows it, such as /linux/web. Leave blank for Main.
IP addressip_addresstext
Where Checkmk reaches the host, an IP address or a DNS name, such as 10.20.0.11. Leave blank to use the host name.
Aliasaliastext
A longer name, such as Public website, node 3.
Monitored withmonitoringtext
How Checkmk monitors it.One of: agent (Checkmk agent), snmp (SNMP (network devices)), ping (No agent: ping only). Default: agent.
Labelslabelstext
Labels as name:value, separated by commas, such as env:prod, team:web.

Outputs

aliastext
Its alias, a longer name
foldertext
Its folder, such as /linux/web; / is Main
host_nametext
The host's name in Checkmk, such as web01
ip_addresstext
The IP address or DNS name Checkmk checks it at
labelsobject
Its labels, such as {"env": "prod"}
monitoringtext
How Checkmk monitors it: agent (Checkmk agent), snmp or ping (no agent)
needs_activationtrue/false
Always true: activate changes to monitor it this way
setup_linktext
A link to the host's settings in Checkmk
Example output
{
  "alias": "Public website, node 3",
  "folder": "/linux/web",
  "host_name": "web03",
  "ip_address": "10.20.0.13",
  "labels": {
    "env": "prod"
  },
  "monitoring": "agent",
  "needs_activation": true,
  "setup_link": "https://monitor.example.com/mysite/check_mk/wato.py?mode=edit_host&host=web03&folder=linux%2Fweb"
}

Delete host

Delete a host from Checkmk, such as when a server is retired. Activate changes to stop monitoring it.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.

Outputs

deletedtrue/false
True when Checkmk deleted it
host_nametext
The host's name in Checkmk, such as web01
needs_activationtrue/false
Always true: activate changes to stop monitoring it
Example output
{
  "deleted": true,
  "host_name": "web03",
  "needs_activation": true
}

Discover services

Scan a host for its services, such as its disks and network interfaces, and monitor the new ones, as Checkmk's Service discovery page does.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
What to domodetext
What to do with what the scan finds.One of: fix_all (Accept all: add new services, remove vanished ones), new (Only add new services), tabula_rasa (Start over: remove all services and find them again). Default: fix_all.

Outputs

countnumber
How many services are listed
host_nametext
The host's name in Checkmk, such as web01
ignorednumber
How many are disabled
modetext
What the discovery did: fix_all, new or tabula_rasa
monitorednumber
How many are monitored
needs_activationtrue/false
Always true: activate changes to apply it
serviceslist
The host's services after the discovery
undecidednumber
How many were found and aren't monitored
vanishednumber
How many are monitored but no longer found
Example output
{
  "count": 3,
  "host_name": "web03",
  "ignored": 0,
  "mode": "fix_all",
  "monitored": 3,
  "needs_activation": true,
  "services": [
    {
      "check_plugin": "cpu_loads",
      "phase": "monitored",
      "service": "CPU load"
    },
    {
      "check_plugin": "df",
      "phase": "monitored",
      "service": "Filesystem /"
    },
    {
      "check_plugin": "mem_linux",
      "phase": "monitored",
      "service": "Memory"
    }
  ],
  "undecided": 0,
  "vanished": 0
}

Get host status

Get a host's state (UP, DOWN or UNREACHABLE), its address and groups, how many of its services are OK, warning or critical, and its service problems.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.

Outputs

acknowledgedtrue/false
True when someone has acknowledged its problem
addresstext
The IP address or DNS name Checkmk checks it at
aliastext
The host's alias, its longer name
foldertext
Its folder in Setup, such as /linux/web
host_groupslist
The host groups it is in
host_nametext
The host's name in Checkmk, such as web01
in_downtimetrue/false
True while it is in a scheduled downtime
last_checktext
When it was last checked, in UTC
linktext
A link to the host in Checkmk
outputtext
What the host check said
service_problemslist
Its services that are WARN, CRIT or UNKNOWN, the worst first
services_criticalnumber
How many are CRIT
services_oknumber
How many of its services are OK
services_pendingnumber
How many haven't been checked yet
services_unknownnumber
How many are UNKNOWN
services_warningnumber
How many are WARN
sincetext
When it got into this state, in UTC
statetext
UP, DOWN, UNREACHABLE or PENDING (not checked yet)
Example output
{
  "acknowledged": false,
  "address": "10.20.0.31",
  "alias": "Records database",
  "folder": "/linux/db",
  "host_groups": [
    "databases"
  ],
  "host_name": "db01",
  "in_downtime": false,
  "last_check": "2026-03-14T22:04:40Z",
  "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hoststatus&host=db01",
  "output": "OK - 10.20.0.31 rta 0.412ms lost 0%",
  "service_problems": [
    {
      "acknowledged": true,
      "output": "Used: 96.12% - 48.1 GiB of 50.0 GiB",
      "service": "Filesystem /var",
      "since": "2026-03-14T20:41:17Z",
      "state": "CRIT"
    }
  ],
  "services_critical": 1,
  "services_ok": 41,
  "services_pending": 0,
  "services_unknown": 0,
  "services_warning": 0,
  "since": "2026-03-01T08:12:40Z",
  "state": "UP"
}

Get service status

Get a service's state (OK, WARN, CRIT or UNKNOWN), what its check said and whether someone has acknowledged it.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
ServiceservicetextRequired
The service's name as Checkmk shows it, such as CPU load.

Outputs

acknowledgedtrue/false
True when someone has acknowledged the problem
host_groupslist
The host groups its host is in
host_nametext
The host's name in Checkmk, such as web01
in_downtimetrue/false
True while it (or its host) is in a scheduled downtime
last_checktext
When it was last checked, in UTC
linktext
A link to it in Checkmk
long_outputtext
The check's longer output, when it gives one
object_typetext
host or service
outputtext
What the check said, such as CRIT - 98% used
servicetext
The service's name, such as CPU load; empty for the host itself
sincetext
When it got into this state, in UTC
statetext
The state as Checkmk shows it: UP, DOWN, UNREACHABLE or PENDING for a host; OK, WARN, CRIT, UNKNOWN or PENDING for a service
Example output
{
  "acknowledged": true,
  "host_groups": [
    "databases"
  ],
  "host_name": "db01",
  "in_downtime": false,
  "last_check": "2026-03-14T22:03:47Z",
  "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=service&host=db01&service=Filesystem+%2Fvar",
  "long_output": "",
  "object_type": "service",
  "output": "Used: 96.12% - 48.1 GiB of 50.0 GiB (warn/crit at 80.00%/90.00% used)",
  "service": "Filesystem /var",
  "since": "2026-03-14T20:41:17Z",
  "state": "CRIT"
}

List host groups

List the host groups, with their hosts and how many are down.

Inputs

None.

Outputs

aliases_knowntrue/false
False when the user's role may not read Setup's host groups: aliases are then the names, and empty groups aren't listed
countnumber
How many host groups there are
host_groupslist
The host groups, by name
Example output
{
  "aliases_known": true,
  "count": 2,
  "host_groups": [
    {
      "alias": "Databases",
      "host_count": 1,
      "hosts": [
        "db01"
      ],
      "hosts_down": 0,
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hostgroup&hostgroup=databases",
      "name": "databases"
    },
    {
      "alias": "Web servers",
      "host_count": 2,
      "hosts": [
        "web01",
        "web02"
      ],
      "hosts_down": 1,
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hostgroup&hostgroup=web_servers",
      "name": "web_servers"
    }
  ]
}

List hosts

List the hosts in a folder, with their IP address, labels and state.

Inputs

Folderfoldertext
The folder's path as Checkmk's Hosts page shows it, such as /linux/web. Leave blank for Main, the top folder.
Include subfoldersinclude_subfolderstrue/false
Also list the hosts in the folders inside it.Default: true.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many hosts are listed
foldertext
The folder listed, such as /linux; / is Main
hostslist
The hosts, by name
include_subfolderstrue/false
True when hosts in its subfolders are listed too
totalnumber
How many hosts there are in all
truncatedtrue/false
True when there were more than the step listed
Example output
{
  "count": 2,
  "folder": "/linux",
  "hosts": [
    {
      "alias": "Records database",
      "folder": "/linux/db",
      "host_name": "db01",
      "ip_address": "10.20.0.31",
      "labels": {},
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hoststatus&host=db01",
      "monitored": true,
      "monitoring": "agent",
      "output": "OK - 10.20.0.31 rta 0.412ms lost 0%",
      "state": "UP"
    },
    {
      "alias": "Public website, node 2",
      "folder": "/linux/web",
      "host_name": "web02",
      "ip_address": "10.20.0.12",
      "labels": {
        "env": "prod"
      },
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hoststatus&host=web02",
      "monitored": true,
      "monitoring": "agent",
      "output": "CRITICAL - 10.20.0.12: Host unreachable",
      "state": "DOWN"
    }
  ],
  "include_subfolders": true,
  "total": 2,
  "truncated": false
}

List problems

List the problems going on now as rows: hosts down or unreachable and services critical, warning or unknown, with what each check said, worst first.

Inputs

Showshowtext
Host problems, service problems or both.One of: all (Hosts and services), hosts (Hosts down or unreachable), services. Default: all.
Service stateservice_statetext
Which service problems to list.Only when Show is Hosts and services or Services. One of: any (Critical, warning or unknown), critical, warning, unknown. Default: any.
Hosthosttext
Only problems on this host.
Host grouphost_grouptext
Only problems on hosts in this host group.
Handledhandledtext
Only problems nobody has acknowledged or put in downtime yet, or only acknowledged ones.One of: all (Every problem), unhandled (Unhandled (not acknowledged, not in downtime)), acknowledged. Default: all.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many problems are listed
hosts_downnumber
How many hosts are DOWN or UNREACHABLE
problemslist
The problems, hosts first, then the worst and the newest
services_criticalnumber
How many services are CRIT
services_unknownnumber
How many services are UNKNOWN
services_warningnumber
How many services are WARN
totalnumber
How many problems there are in all
truncatedtrue/false
True when there were more than the step listed
Example output
{
  "count": 2,
  "hosts_down": 1,
  "problems": [
    {
      "acknowledged": false,
      "host_alias": "Public website, node 2",
      "host_groups": [
        "web_servers"
      ],
      "host_name": "web02",
      "in_downtime": false,
      "last_check": "2026-03-14T22:04:03Z",
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=hoststatus&host=web02",
      "object_type": "host",
      "output": "CRITICAL - 10.20.0.12: Host unreachable @ 10.20.0.1",
      "service": "",
      "since": "2026-03-14T21:58:03Z",
      "state": "DOWN"
    },
    {
      "acknowledged": true,
      "host_alias": "Records database",
      "host_groups": [
        "databases"
      ],
      "host_name": "db01",
      "in_downtime": false,
      "last_check": "2026-03-14T22:03:47Z",
      "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=service&host=db01&service=Filesystem+%2Fvar",
      "object_type": "service",
      "output": "Used: 96.12% - 48.1 GiB of 50.0 GiB (warn/crit at 80.00%/90.00% used)",
      "service": "Filesystem /var",
      "since": "2026-03-14T20:41:17Z",
      "state": "CRIT"
    }
  ],
  "services_critical": 1,
  "services_unknown": 0,
  "services_warning": 0,
  "total": 2,
  "truncated": false
}

Remove downtime

End a host's or service's downtime now, by its ID from 'Schedule downtime', or every downtime on the host or service.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
Downtime IDdowntime_idtext
The ID 'Schedule downtime' gave, such as 57. Separate several with commas. Leave blank to remove every downtime on the host (or on the service).
Serviceservicetext
Only this service's downtimes. Leave blank for the host's and its services'.

Outputs

countnumber
How many were removed
host_nametext
The host's name in Checkmk, such as web01
removedlist
The downtimes removed
servicetext
The service whose downtimes were removed; empty for every one
Example output
{
  "count": 1,
  "host_name": "web02",
  "removed": [
    {
      "author": "lodol",
      "comment": "Patching (CHG-2291)",
      "end": "2026-03-14T23:00:00Z",
      "host_name": "web02",
      "id": "57",
      "service": "",
      "start": "2026-03-14T22:00:00Z"
    }
  ],
  "service": ""
}

Reschedule check

Run a host's or a service's check now, such as after a fix, rather than at its next interval, and get the new result.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
Serviceservicetext
The service's name as Checkmk shows it, such as Filesystem /var. Leave blank for the host itself.

Outputs

acknowledgedtrue/false
True when someone has acknowledged the problem
checkedtrue/false
True when Checkmk has run the check since; false when it hadn't finished yet, so the result is the one before
host_groupslist
The host groups its host is in
host_nametext
The host's name in Checkmk, such as web01
in_downtimetrue/false
True while it (or its host) is in a scheduled downtime
last_checktext
When it was last checked, in UTC
linktext
A link to it in Checkmk
long_outputtext
The check's longer output, when it gives one
object_typetext
host or service
outputtext
What the check said, such as CRIT - 98% used
servicetext
The service's name, such as CPU load; empty for the host itself
sincetext
When it got into this state, in UTC
statetext
The state as Checkmk shows it: UP, DOWN, UNREACHABLE or PENDING for a host; OK, WARN, CRIT, UNKNOWN or PENDING for a service
Example output
{
  "acknowledged": false,
  "checked": true,
  "host_groups": [
    "databases"
  ],
  "host_name": "db01",
  "in_downtime": false,
  "last_check": "2026-03-14T22:05:12Z",
  "link": "https://monitor.example.com/mysite/check_mk/view.py?view_name=service&host=db01&service=Filesystem+%2Fvar",
  "long_output": "",
  "object_type": "service",
  "output": "Used: 61.40% - 30.7 GiB of 50.0 GiB",
  "service": "Filesystem /var",
  "since": "2026-03-14T22:05:12Z",
  "state": "OK"
}

Schedule downtime

Schedule downtime for a host, or some of its services, for a change window, so their problems don't notify anyone.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
Servicesservicestext
Only these services, by name, such as HTTP, separated by commas. Leave blank for the host.
CommentcommenttextRequired
What it's for, such as Patching (CHG-2291).
Startstartdate and time
When it starts. Leave blank to start now.
Minutesduration_minutesnumber
How long it lasts, in minutes. Defaults to 60.From 1 to 527040.

Outputs

commenttext
Its comment
countnumber
How many downtimes were made
downtime_idslist
Their IDs, for 'Remove downtime'
downtimeslist
The downtimes Checkmk made, one per service
endtext
When it ends, in UTC
host_nametext
The host's name in Checkmk, such as web01
serviceslist
The services it was scheduled for; empty for the host
starttext
When it starts, in UTC
Example output
{
  "comment": "Patching (CHG-2291)",
  "count": 1,
  "downtime_ids": [
    "57"
  ],
  "downtimes": [
    {
      "author": "lodol",
      "comment": "Patching (CHG-2291)",
      "end": "2026-03-14T23:00:00Z",
      "host_name": "web02",
      "id": "57",
      "service": "",
      "start": "2026-03-14T22:00:00Z"
    }
  ],
  "end": "2026-03-14T23:00:00Z",
  "host_name": "web02",
  "services": [],
  "start": "2026-03-14T22:00:00Z"
}

Update host

Change a host's IP address, alias or labels, or move it to another folder. Blank fields are left as they are; activate changes to apply.

Inputs

HosthosttextRequired
The host's name in Checkmk, such as web01.
IP addressip_addresstext
Where Checkmk reaches the host, an IP address or a DNS name, such as 10.20.0.11. Leave blank to use the host name.
Aliasaliastext
A longer name, such as Public website, node 3.
Move to folderfoldertext
The folder's path as Checkmk's Hosts page shows it, such as /linux/web. Leave blank to keep it where it is.
Labelslabelstext
Labels as name:value, separated by commas, such as env:prod. They replace the host's labels.

Outputs

aliastext
Its alias, a longer name
foldertext
Its folder, such as /linux/web; / is Main
host_nametext
The host's name in Checkmk, such as web01
ip_addresstext
The IP address or DNS name Checkmk checks it at
labelsobject
Its labels, such as {"env": "prod"}
monitoringtext
How Checkmk monitors it: agent (Checkmk agent), snmp or ping (no agent)
needs_activationtrue/false
Always true: activate changes to monitor it this way
setup_linktext
A link to the host's settings in Checkmk
Example output
{
  "alias": "Public website, node 3",
  "folder": "/linux/web",
  "host_name": "web03",
  "ip_address": "10.20.0.13",
  "labels": {
    "env": "prod"
  },
  "monitoring": "agent",
  "needs_activation": true,
  "setup_link": "https://monitor.example.com/mysite/check_mk/wato.py?mode=edit_host&host=web03&folder=linux%2Fweb"
}

On this page