Die Checkmk REST-API

#!/usr/bin/env python3
import pprint
import requests

HOST_NAME = "localhost"
SITE_NAME = "checkmk"
API_VERSION = "v1"
PROTO = "http" #[http|https]
API_URL = f"{PROTO}://{HOST_NAME}/{SITE_NAME}/check_mk/api/{API_VERSION}"

USERNAME = "automation"
PASSWORD = "test123"

session = requests.session()
session.headers['Authorization'] = f"Bearer {USERNAME} {PASSWORD}"
session.headers['Accept'] = 'application/json'
session.max_redirects = 100  # increase if necessary

resp = session.post(
    f"{API_URL}/domain-types/host_config/collections/all",
    params={  # goes into query string
        "bake_agent": False,  # Tries to bake the agents for the just created hosts.
    },
    headers={
        "Content-Type": 'application/json',  # (required) A header specifying which type of content is in the request/response body.
    },
    json={
        "host_name": "example.com",
        "folder": "/",
        "attributes": {
            "ipaddress": "192.168.0.123",
        },
    },
    allow_redirects=True,
)
if resp.status_code in (200, 201):
    pprint.pprint(resp.json())
else:
    raise RuntimeError(pprint.pformat(resp.json()))

#!/bin/bash

# NOTE: We recommend all shell users to use the "httpie" examples instead.
#       `curl` should not be used for writing large scripts.
#       This code is provided for debugging purposes only.

HOST_NAME="localhost"
SITE_NAME="checkmk"
API_VERSION="v1"
PROTO="http" #[http|https]
API_URL="$PROTO://$HOST_NAME/$SITE_NAME/check_mk/api/$API_VERSION"

USERNAME="automation"
PASSWORD="test123"

curl \
  --request POST \
  --write-out "\nxxx-status_code=%{http_code}\n" \
  --header "Authorization: Bearer $USERNAME $PASSWORD" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
          "attributes": {
            "ipaddress": "192.168.0.123"
          },
          "folder": "/",
          "host_name": "example.com"
        }' \
  "$API_URL/domain-types/host_config/collections/all"

#!/usr/bin/env python3
import pprint
import requests

HOST_NAME = "myserver"
SITE_NAME = "mysite"
API_VERSION = "v1"
PROTO = "http" #[http|https]
API_URL = f"{PROTO}://{HOST_NAME}/{SITE_NAME}/check_mk/api/{API_VERSION}"

USERNAME = "automation"
PASSWORD = "theautomationsecret"

session = requests.session()
session.headers['Authorization'] = f"Bearer {USERNAME} {PASSWORD}"
session.headers['Accept'] = 'application/json'
session.max_redirects = 100  # increase if necessary

resp = session.post(
    f"{API_URL}/domain-types/host_config/collections/all",
    params={  # goes into query string
        "bake_agent": False,  # Tries to bake the agents for the just created hosts.
    },
    headers={
        "Content-Type": 'application/json',  # (required) A header specifying which type of content is in the request/response body.
    },
    json={
        "host_name": "myhost123",
        "folder": "/",
        "attributes": {
            "ipaddress": "192.168.0.42",
        },
    },
    allow_redirects=True,
)
if resp.status_code in (200, 201):
    pprint.pprint(resp.json())
else:
    raise RuntimeError(pprint.pformat(resp.json()))

#!/bin/bash

# NOTE: We recommend all shell users to use the "httpie" examples instead.
#       `curl` should not be used for writing large scripts.
#       This code is provided for debugging purposes only.

HOST_NAME="myserver"
SITE_NAME="mysite"
API_VERSION="v1"
PROTO="http" #[http|https]
API_URL="$PROTO://$HOST_NAME/$SITE_NAME/check_mk/api/$API_VERSION"

USERNAME="automation"
PASSWORD="theautomationsecret"

curl \
  --request POST \
  --write-out "\nxxx-status_code=%{http_code}\n" \
  --header "Authorization: Bearer $USERNAME $PASSWORD" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
          "attributes": {
            "ipaddress": "192.168.0.42"
          },
          "folder": "/",
          "host_name": "myhost123"
        }' \
  "$API_URL/domain-types/host_config/collections/all"

user@host:~$ python3 create_host.py
{'domainType': 'host_config',
 'extensions': {'attributes': {'ipaddress': '192.168.0.42',
                               'meta_data': {'created_at': '2026-02-16T06:36:07.848751+00:00',
                                             'created_by': 'automation',
                                             'updated_at': '2026-02-16T06:36:07.862099+00:00'}},
                'cluster_nodes': None,
                'effective_attributes': None,
                'folder': '/',
                'is_cluster': False,
                'is_offline': False},
 'id': 'myhost123',
 'links': [{'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123',
            'method': 'GET',
            'rel': 'self',
            'type': 'application/json'},
           {'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123',
            'method': 'PUT',
            'rel': 'urn:org.restfulobjects:rels/update',
            'type': 'application/json'},
           {'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123',
            'method': 'DELETE',
            'rel': 'urn:org.restfulobjects:rels/delete',
            'type': 'application/json'},
           {'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/folder_config/~',
            'method': 'GET',
            'rel': 'urn:com.checkmk:rels/folder_config',
            'title': 'The folder config of the host.',
            'type': 'application/json'},
           '... some more links...',
 'members': {},
 'title': 'myhost123'}

user@host:~$ ./create_host.sh
{
    "links": [
        {
            "domainType": "link",
            "rel": "self",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123",
            "method": "GET",
            "type": "application/json"
        },
        {
            "domainType": "link",
            "rel": "urn:org.restfulobjects:rels/update",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123",
            "method": "PUT",
            "type": "application/json"
        },
        {
            "domainType": "link",
            "rel": "urn:org.restfulobjects:rels/delete",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/host_config/myhost123",
            "method": "DELETE",
            "type": "application/json"
        },
        {
            "domainType": "link",
            "rel": "urn:com.checkmk:rels/folder_config",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/folder_config/~",
            "method": "GET",
            "type": "application/json",
            "title": "The folder config of the host."
        },
        "... some more links..."
    ],
    "domainType": "host_config",
    "id": "myhost123",
    "title": "myhost123",
    "members": {},
    "extensions": {
        "folder": "/",
        "attributes": {
            "ipaddress": "192.168.0.42",
            "meta_data": {
                "created_at": "2026-02-16T06:33:36.788204+00:00",
                "updated_at": "2026-02-16T06:33:36.795484+00:00",
                "created_by": "automation"
            }
        },
        "effective_attributes": null,
        "is_cluster": false,
        "is_offline": false,
        "cluster_nodes": null
    }
}
xxx-status_code=200

#!/usr/bin/env python3
import pprint
import requests

HOST_NAME = "myserver"
SITE_NAME = "mysite"
API_VERSION = "v1"
PROTO = "http" #[http|https]
API_URL = f"{PROTO}://{HOST_NAME}/{SITE_NAME}/check_mk/api/{API_VERSION}"

USERNAME = "automation"
PASSWORD = "theautomationsecret"

session = requests.session()
session.headers['Authorization'] = f"Bearer {USERNAME} {PASSWORD}"
session.headers['Accept'] = 'application/json'
session.max_redirects = 100  # increase if necessary

resp = session.post(
    f"{API_URL}/domain-types/service_discovery_run/actions/start/invoke",
    headers={
        "Content-Type": 'application/json',  # (required) A header specifying which type of content is in the request/response body.
    },
    json={
        "host_name": "myhost123",
        "mode": "refresh",
    },
    allow_redirects=True,
)
if resp.status_code in (200, 201):
    pprint.pprint(resp.json())
elif resp.status_code == 204:
    print('Done')
elif resp.status_code == 303:
    print('Redirected to', resp.headers['location'])
else:
    raise RuntimeError(pprint.pformat(resp.json()))

#!/bin/bash

# NOTE: We recommend all shell users to use the "httpie" examples instead.
#       `curl` should not be used for writing large scripts.
#       This code is provided for debugging purposes only.

HOST_NAME="myserver"
SITE_NAME="mysite"
API_VERSION="v1"
PROTO="http" #[http|https]
API_URL="$PROTO://$HOST_NAME/$SITE_NAME/check_mk/api/$API_VERSION"

USERNAME="automation"
PASSWORD="theautomationsecret"

curl \
  --request POST \
  --write-out "\nxxx-status_code=%{http_code}\n" \
  --header "Authorization: Bearer $USERNAME $PASSWORD" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
          "host_name": "myhost123",
          "mode": "refresh"
        }' \
  "$API_URL/domain-types/service_discovery_run/actions/start/invoke"

user@host:~$ python3 service_discovery.py
Done

user@host:~$ ./service_discovery.sh

xxx-status_code=303

#!/usr/bin/env python3
import pprint
import requests

HOST_NAME = "myserver"
SITE_NAME = "mysite"
API_VERSION = "v1"
PROTO = "http" #[http|https]
API_URL = f"{PROTO}://{HOST_NAME}/{SITE_NAME}/check_mk/api/{API_VERSION}"

USERNAME = "automation"
PASSWORD = "theautomationsecret"

session = requests.session()
session.headers['Authorization'] = f"Bearer {USERNAME} {PASSWORD}"
session.headers['Accept'] = 'application/json'

resp = session.get(
    f"{API_URL}/domain-types/activation_run/collections/pending_changes",
)

pprint.pprint(dict(resp.headers))
print("xxx-status_code={}".format(resp.status_code))

if resp.status_code == 200:
    pprint.pprint(resp.json())
else:
    raise RuntimeError(pprint.pformat(resp.json()))

#!/bin/bash

# NOTE: We recommend all shell users to use the "httpie" examples instead.
#       `curl` should not be used for writing large scripts.
#       This code is provided for debugging purposes only.

HOST_NAME="myserver"
SITE_NAME="mysite"
API_VERSION="v1"
PROTO="http" #[http|https]
API_URL="$PROTO://$HOST_NAME/$SITE_NAME/check_mk/api/$API_VERSION"

USERNAME="automation"
PASSWORD="theautomationsecret"

curl \
  -i \
  --write-out "\nxxx-status_code=%{http_code}\n" \
  --header "Authorization: Bearer $USERNAME $PASSWORD" \
  --header "Accept: application/json" \
  "$API_URL/domain-types/activation_run/collections/pending_changes"

user@host:~$ python3 show_pending_changes.py
{...
 'Content-Type': 'application/json',
 'Date': 'Mon, 16 Feb 2026 13:35:57 GMT',
 'ETag': '"3b3389f4d4f6a73603831ac1d0caf973f48cd88001c80a4ff1cd4caf90787879"',
 ...
}
xxx-status_code=200
{'domainType': 'activation_run',
 ...,
 'value': [{'action_name': 'create-host',
            'id': 'b4790ffb-ac89-4559-8a8c-d0c5f69a8c57',
            'text': 'Created new host myhost123.',
            'time': '2026-02-16T13:23:40.287288+00:00',
            'user_id': 'automation'},
           {'action_name': 'refresh-autochecks',
            'id': '551b32be-d3ce-4d94-add7-f38b7fa7fb42',
            'text': 'Refreshed check configuration of host '
                    ''myhost123'',
            'time': '2026-02-16T13:23:48.391117+00:00',
            'user_id': 'automation'}]}

user@host:~$ ./show_pending_changes.sh
HTTP/1.1 200 OK
Date: Mon, 16 Feb 2026 13:25:36 GMT
...
ETag: "3b3389f4d4f6a73603831ac1d0caf973f48cd88001c80a4ff1cd4caf90787879"
...
Content-Type: application/json

{
    ...
    "domainType": "activation_run",
    "value": [
        {
            "id": "b4790ffb-ac89-4559-8a8c-d0c5f69a8c57",
            "user_id": "automation",
            "action_name": "create-host",
            "text": "Created new host myhost123.",
            "time": "2026-02-16T13:23:40.287288+00:00"
        },
        {
            "id": "551b32be-d3ce-4d94-add7-f38b7fa7fb42",
            "user_id": "automation",
            "action_name": "refresh-autochecks",
            "text": "Refreshed check configuration of host 'myhost123'",
            "time": "2026-02-16T13:23:48.391117+00:00"
        }
    ]
}
xxx-status_code=200

#!/usr/bin/env python3
import pprint
import requests

HOST_NAME = "myserver"
SITE_NAME = "mysite"
API_VERSION = "v1"
PROTO = "http" #[http|https]
API_URL = f"{PROTO}://{HOST_NAME}/{SITE_NAME}/check_mk/api/{API_VERSION}"

USERNAME = "automation"
PASSWORD = "theautomationsecret"

session = requests.session()
session.headers['Authorization'] = f"Bearer {USERNAME} {PASSWORD}"
session.headers['Accept'] = 'application/json'
session.max_redirects = 100  # increase if necessary

resp = session.post(
    f"{API_URL}/domain-types/activation_run/actions/activate-changes/invoke",
    headers={
        "If-Match": '"3b3389f4d4f6a73603831ac1d0caf973f48cd88001c80a4ff1cd4caf90787879"',  # (required) The value of the, to be modified, object's ETag header.
        "Content-Type": 'application/json',  # (required) A header specifying which type of content is in the request/response body.
    },
    json={
        "redirect": False,
        "sites": ["mysite"],
        "force_foreign_changes": False,
    },
    allow_redirects=True,
)
if resp.status_code in (200, 201):
    pprint.pprint(resp.json())
elif resp.status_code == 204:
    print('Done')
elif resp.status_code == 303:
    print('Redirected to', resp.headers['location'])
else:
    raise RuntimeError(pprint.pformat(resp.json()))

#!/bin/bash

# NOTE: We recommend all shell users to use the "httpie" examples instead.
#       `curl` should not be used for writing large scripts.
#       This code is provided for debugging purposes only.

HOST_NAME="myserver"
SITE_NAME="mysite"
API_VERSION="v1"
PROTO="http" #[http|https]
API_URL="$PROTO://$HOST_NAME/$SITE_NAME/check_mk/api/$API_VERSION"

USERNAME="automation"
PASSWORD="theautomationsecret"

curl -L \
  --write-out "\nxxx-status_code=%{http_code}\n" \
  --header "Authorization: Bearer $USERNAME $PASSWORD" \
  --header "Accept: application/json" \
  --header "If-Match: "3b3389f4d4f6a73603831ac1d0caf973f48cd88001c80a4ff1cd4caf90787879"" \
  --header "Content-Type: application/json" \
  --data '{
          "force_foreign_changes": false,
          "redirect": false,
          "sites": [
            "mysite"
          ]
        }' \
  "$API_URL/domain-types/activation_run/actions/activate-changes/invoke"

user@host:~$ python3 activate_changes.py
{'domainType': 'activation_run',
 'extensions': {'changes': [{'action_name': 'create-host',
                             'id': 'b4790ffb-ac89-4559-8a8c-d0c5f69a8c57',
                             'text': 'Created new host myhost123.',
                             'time': '2026-02-16T13:23:40.287288+00:00',
                             'user_id': 'automation'},
                            {'action_name': 'refresh-autochecks',
                             'id': '551b32be-d3ce-4d94-add7-f38b7fa7fb42',
                             'text': 'Refreshed check configuration of host '
                                     ''myhost123'',
                             'time': '2026-02-16T13:23:48.391117+00:00',
                             'user_id': 'automation'}],
                'force_foreign_changes': False,
                'is_running': True,
                'sites': ['mysite'],
                'time_started': '2026-02-16T14:00:37.029962+00:00'},
 'id': 'c123e01b-95ab-4898-b12e-859193ea30f5',
 'links': [{'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/activation_run/c123e01b-95ab-4898-b12e-859193ea30f5',
            'method': 'GET',
            'rel': 'self',
            'type': 'application/json'},
           {'domainType': 'link',
            'href': 'http://myserver/mysite/check_mk/api/v1/objects/activation_run/c123e01b-95ab-4898-b12e-859193ea30f5/actions/wait-for-completion/invoke',
            'method': 'GET',
            'rel': 'urn:com.checkmk:rels/wait-for-completion',
            'type': 'application/json'}],
 'members': {},
 'title': 'Activation status: In progress.'}

user@host:~$ ./activate_changes.sh
{
    "links": [
        {
            "domainType": "link",
            "rel": "self",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/activation_run/c123e01b-95ab-4898-b12e-859193ea30f5",
            "method": "GET",
            "type": "application/json"
        },
        {
            "domainType": "link",
            "rel": "urn:com.checkmk:rels/wait-for-completion",
            "href": "http://myserver/mysite/check_mk/api/v1/objects/activation_run/c123e01b-95ab-4898-b12e-859193ea30f5/actions/wait-for-completion/invoke",
            "method": "GET",
            "type": "application/json"
        }
    ],
    "domainType": "activation_run",
    "id": "c123e01b-95ab-4898-b12e-859193ea30f5",
    "title": "Activation status: In progress.",
    "members": {},
    "extensions": {
        "sites": [
            "mysite"
        ],
        "is_running": true,
        "force_foreign_changes": false,
        "time_started": "2026-02-16T14:20:15.981544+00:00",
        "changes": [
            {
                "id": "45d7f854-03e6-4c28-b79f-47c04e5b2c39",
                "user_id": "automation",
                "action_name": "create-host",
                "text": "Created new host myhost123.",
                "time": "2026-02-16T14:19:46.778844+00:00"
            },
            {
                "id": "d6093002-09f0-4e3a-b028-5abdb3f5ad78",
                "user_id": "automation",
                "action_name": "refresh-autochecks",
                "text": "Refreshed check configuration of host 'myhost123'",
                "time": "2026-02-16T14:19:52.894927+00:00"
            }
        ]
    }
}
xxx-status_code=200