Skip to content

Main Navigation Guide

Ptarmigan Labs main site

Appearance

Sidebar Navigation

About

Butler

Butler Family

Use Cases

Versioning

Contributing

Telemetry

Security Considerations

Getting Started

Overview

Installation

Setup

Which config file?

Minimal config

REST API

Scheduler

Key-value store

File system access

MQTT

Task alerts

Client-managed

Email alerts

Slack alerts

Teams alerts

MQTT alerts

InfluxDB alerts

New Relic alerts

Webhook alerts

Cloud

Email alerts

Slack alerts

Teams alerts

Reload script logs

Heartbeats

Uptime monitor

Docker healthcheck

Data connections

Qlik Sense licenses

Server licenses

Access licenses

Qlik Sense settings

Server settings

Cloud settings

Server version

Incident mgmt tools

New Relic

Signl4

Windows service monitor

Email

Slack

Teams

MQTT

InfluxDB

New Relic

Webhook

Start task filter

System information

Telemetry

Visualise config file

Day 2 operations

Standalone app

Docker

Node.js app

Upgrade

Concepts

Overview

Monitoring & Alerting

Task Monitoring

Reloads Tasks

Client-Managed

Alert Emails

Slack & Teams Alerts

Successful Reloads

System Monitoring

Windows Services

Server Version

UDP Queue

Incident Management

Overview

Platforms

New Relic Integration

Signl4 Integration

License Management

Qlik Sense Licenses

Server License

Access Licenses

Communication & Integration

Messaging Platforms

Teams Messaging

MQTT Integration

Utilities

Custom Links

UDP Client

Task & File Operations

Task Management

Scheduler

Start Sense Tasks

Key-Value Store

File Operations

File System Access

Examples

Overview

File Operations

Messaging from Load Script

Sense App Introspection

Monitoring Butler

Reload Chaining

Scheduling

Troubleshooting

OpenAPI Docs

Windows Service

Start Sense Tasks

Overview

From REST API

From MQTT

From Load Script

Sense Demo Apps

Overview

Butler API Demo

Partial App Reloads

Post to Slack

Publish to MQTT

Reference

Overview

Config File

Command Line Options

REST API

Overview

Sense Helper Subs

InfluxDB Information

UDP Payload Format

Key-Value Store

Scheduler

Test Cases

Alert Template Fields

Overview

Client-Managed

Overview

Reload Tasks

Distribute Tasks

Preload Tasks

Windows Services

Qlik Sense Cloud

Overview

Failed App Reloads

Task Type Constants

Legal Stuff

Legal Information

On this page

Reference Documentation

Detailed, more technical descriptions of Butler's REST API and other parts of Butler.

Updated at:

Pager

Previous pagePublish to MQTT

Next pageConfig File

Released under the MIT License.

Copyright © 2018–2025 Ptarmigan Labs AB