ControlUp

ControlUp Alerts API

Alerts let you receive notifications or automatically run an action when certain conditions occur on a device.

GitHub OpenAPI
Business capability
IT Operations Management BC-600.40

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /alerts List configured device alerts · List all Alerts #
Ask an LLM
“Which device alerts are configured in ControlUp for Desktops?”
“Can I filter my configured alerts with an OpenSearch query?”
Tell an agent
List all configured device alerts.
Find device alerts matching the OpenSearch query {query}.
POST /alerts Create a device alert · Create an Alert #
Ask an LLM
“How do I create an alert that fires when devices meet certain conditions?”
“Can a new alert trigger a webhook, run a script or email people?”
Tell an agent
Create alert {name} with severity {severity} on platform {platform} using index {index} and conditions {filters}.
Set up alert {name} that fires after {results_threshold} matches in {results_threshold_seconds} seconds, re-triggering every {retrigger_interval}.
GET /alerts/{id} Get a device alert · Retrieve Alert #
Ask an LLM
“What conditions and actions does a specific device alert have?”
“Can I look up one alert's configuration by its ID?”
Tell an agent
Get device alert {id}.
Show the conditions and notifications on alert {id}.
POST /alerts/{id} Edit a device alert · Edit alert #
Ask an LLM
“How do I change the severity or conditions of an existing device alert?”
“Can I disable an alert without deleting it?”
Tell an agent
Set enabled to {enabled} on device alert {id}.
Change the severity of device alert {id} to {severity}.
DELETE /alerts/{id} Delete a device alert · Delete alert #
Ask an LLM
“How do I remove a device alert I no longer need?”
“Is deleting a device alert permanent?”
Tell an agent destructive · confirm first
Delete device alert {id}.
Remove the alert with ID {id}.
GET /organizations/{orgId}/alert-configs List an organization's alert configurations · List all Alerts #
Ask an LLM
“What alert configurations are set up for my organization?”
“Can I search my organization's alert configs by text?”
Tell an agent
List the alert configurations for organization {orgId}.
Search alert configurations in organization {orgId} for {_search}.
GET /alerts/scouts List Scouts that triggered alerts · List Scout IDs with alerts #
Ask an LLM
“Which Scouts have triggered an alert in the last 24 hours?”
“Can I see which synthetic monitors alerted during a specific time window?”
Tell an agent
List the Scout IDs that triggered alerts in the last day.
List Scouts with alerts between {start} and {end}.
GET /alerts/{scoutId} List alerts generated for a Scout · List alerts for a Scout #
Ask an LLM
“What alerts has a particular Scout generated recently?”
“Can I page through one Scout's alerts over a custom date range?”
Tell an agent
List alerts fired by Scout {scoutId}.
Show alerts for Scout {scoutId} from {start} to {end}.
GET /scouts/{scoutId}/alerts List a Scout's alert policies · List alert policies for a Scout #
Ask an LLM
“Does a given Scout already have an alert policy configured?”
“How many alert policies can one Scout have?”
Tell an agent
List the alert policies configured on Scout {scoutId}.
Check whether Scout {scoutId} has an alert policy.
POST /scouts/{scoutId}/alerts Create a Scout alert policy · Create alert policy #
Ask an LLM
“How do I get notified when a Scout's test results fail?”
“Can I set which test results trigger an alert for a Scout?”
Tell an agent
Create an alert policy on Scout {scoutId} triggering on {conditions}.
Add an alert policy to Scout {scoutId} with conditions {conditions} and notifications {notifications}.
GET /scouts/{scoutId}/alerts/{alertId} Get a Scout alert policy's details · Get alert policy details #
Ask an LLM
“What settings and notifications does a Scout's alert policy use?”
“Is a particular Scout alert policy enabled?”
Tell an agent
Get alert policy {alertId} on Scout {scoutId}.
Show the notification settings of Scout {scoutId} policy {alertId}.
PATCH /scouts/{scoutId}/alerts/{alertId} Update a Scout alert policy · Update alert policy #
Ask an LLM
“How do I change the conditions on a Scout's existing alert policy?”
“Can I temporarily disable a Scout alert policy?”
Tell an agent
Set disabled to {disabled} on Scout {scoutId} alert policy {alertId}.
Update the notifications on Scout {scoutId} policy {alertId} to {notifications}.
DELETE /scouts/{scoutId}/alerts/{alertId} Delete a Scout alert policy · Delete alert policy #
Ask an LLM
“How do I stop a Scout from alerting by removing its policy?”
“Can I delete a Scout's alert policy so I can create a fresh one?”
Tell an agent destructive · confirm first
Delete alert policy {alertId} from Scout {scoutId}.
Remove the alert policy {alertId} on Scout {scoutId}.

Documentation

📖
Documentation
https://api.controlup.io/reference
📖
APIReference
https://api.controlup.io/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/controlup/refs/heads/main/openapi/controlup-alerts-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/controlup:controlup-alerts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

controlup-alerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Controlup Alerts API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Alerts across 3 of this provider''s published API definitions: controlup-desktops-openapi.yml, controlup-dex-alerts-openapi.yml, controlup-synthetic-monitoring-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.controlup.com/edge/api
- url: https://api.controlup.com/events/v1/alerts
- url: https://api.controlup.com/synthetic-monitoring/v2/
tags:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/controlup/refs/heads/main/openapi/controlup-alerts-api-openapi.yml