On this page

Developers

Mugnsoft components can be accessed through APIs. These API actions facilitate seamless integration with other products and enable custom integration.

Explore the following pages to learn how to access these APIs from your Mugnsoft components.

Utilize the Mugnsoft API to dynamically add monitors, perform URL and API checks, updates, and more.

Start here

New to the API? Follow this path:

  1. API usage recipes — task-oriented, copy-paste workflows (authentication helper, bulk onboarding, CI/CD health gates, maintenance windows). The fastest way to get something working.
  2. Create API tokens — generate the long-lived keys your automation should use.
  3. Webserver HTTP API — the complete endpoint and field reference to look up the details.

The per-component references (Monitor, Integrator, Sentinel Agent) cover the APIs each component exposes directly. In most automation you only talk to the Webserver — it proxies live data from the probes for you.

Authentication

There are two authentication methods to access the API:

Basic authentication: A Mugnsoft Admin user can access certain parts of the Mugnsoft API using basic authentication.

API Tokens: Each API Token is associated with a specific component and has a designated validity period. API Tokens can be used to create or update monitors, URLs, and APIs.

Translations

Create API tokens