Entity Types¶

AutoKuma supports all monitor types available in Uptime Kuma, plus a few additional entity types for managing notifications, tags, and Docker hosts.

AutoKuma-Specific Properties¶

The following properties are handled internally by AutoKuma and are not sent to Uptime Kuma:

Property	Example	Description
`parent_name`	`apps`	AutoKuma ID of the parent group
`notification_name_list`	`["matrix", "discord"]`	AutoKuma IDs of notification providers to enable
`tag_names`	`[{"name": "mytag", "value": "A value"}]`	Tags to attach to the monitor
`docker_host_name`	`local_socket`	AutoKuma ID of the Docker host for a docker monitor
`create_paused`	`false`	If `true`, new monitors are added in a paused state (existing monitors are not affected)

Property	Example
`connection_type`	`socket` or `tcp`
`host` or `path`	`/var/run/docker.sock`

Property	Example	Notes
`active`	`true`
`is_default`	`true`	Only used by the WebUI; AutoKuma does not respect this setting
`config`	`{"type": "matrix", ...}`	Provider-specific settings. Use `kuma notification get` to inspect options for your provider.

Type	Description
dns	DNS resolution check
docker	Docker container health check
gamedig	Game server monitor
globalping	Global ping/HTTP check via Globalping
group	Monitor group
grpc-keyword	gRPC keyword check
http	HTTP/HTTPS monitor
json-query	HTTP monitor with JSON path assertion
kafka-producer	Kafka producer health check
keyword	HTTP monitor with keyword check
mongodb	MongoDB connection check
mqtt	MQTT broker check
mysql	MySQL/MariaDB connection check
ping	ICMP ping monitor
port	TCP port check
postgres	PostgreSQL connection check
push	Push (heartbeat) monitor
radius	RADIUS authentication check
real-browser	Headless browser check
redis	Redis connection check
steam	Steam game server check
sqlserver	SQL Server connection check
tailscale-ping	Tailscale node ping
smtp	SMTP server check
snmp	SNMP OID check
rabbitmq	RabbitMQ health check