How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ControlUp Alerts - Devices API

The Alerts - Devices API from ControlUp — 2 operation(s) for alerts - devices.

ControlUp Alerts - Devices API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts - Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.controlup.com/events/v1/alerts.

4 operations 2 paths 40 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.controlup.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ControlUp Alerts - Devices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey).

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Alerts - Devices 4
GET
/organizations/{orgId}/alert-configs/desktop/{id}
Retrieve a Devices Alert
AlertsDesktopController_getAlertById 2 params → 200400401403404500
PATCH
/organizations/{orgId}/alert-configs/desktop/{id}
Update a Devices alert
AlertsDesktopController_updateAlertConfiguration 2 params body → 200400401403404500
DELETE
/organizations/{orgId}/alert-configs/desktop/{id}
Delete a Devices alert
AlertsDesktopController_deleteAlertConfiguration 2 params → 200400401403404500
POST
/organizations/{orgId}/alert-configs/desktop
Create a Devices alert
AlertsDesktopController_createDesktopAlert 1 param body → 200400401403404500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are DesktopAlertConfigDTO (16 properties), Pick_DesktopAlertConfigDTO.Exclude_keyofDesktopAlertConfigDTO.sourceName-or-id__ (15 properties), Partial_CreateDesktopAlertDTO_ (15 properties), ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound_ (4 properties). Each schema is shown below with its type and property counts.

UUID
string
Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)
ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden_
object
4 properties 3 required
ErrorMessage.Forbidden
string
ErrorCode.Forbidden
number
Omit_DesktopAlertConfigDTO.sourceName-or-id_
Construct a type with the properties of T except for those in type K.
ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes_
object
4 properties 3 required
DesktopAlertMetricCondition
string
HttpStatusCode.NOT_FOUND
number
Partial_CreateDesktopAlertDTO_
object
Make all properties in T optional
15 properties
ServiceNowCustomFields
object
Custom fields dictionary type for ServiceNow integration.
ErrorResponseBody_ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized__
object
2 properties 2 required
ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound_
object
4 properties 3 required
Pick_DesktopAlertConfigDTO.Exclude_keyofDesktopAlertConfigDTO.sourceName-or-id__
object
From T, pick a set of properties whose keys are in the union K
15 properties 9 required
ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized_
object
4 properties 3 required
Severity
string
ErrorCode.Unauthorized
number
ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError_
object
4 properties 3 required
DesktopAlertMetric
object
3 properties 3 required
DesktopAlertConfigDTO
object
16 properties 10 required
BadRequestErrorMessages
string
ErrorCode.InternalServerError
number
DesktopPlatform
number
ErrorMessage.Unauthorized
string
ErrorResponseBody_ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden__
object
2 properties 2 required
ErrorMessage.InternalServerError
string
DeletedActionResponse
object
1 property 1 required
HttpStatusCode.FORBIDDEN
number
HttpStatusCode.INTERNAL_SERVER_ERROR
number
URI
string
Valid URI.
HttpStatusCode.UNAUTHORIZED
number
ErrorResponseBody_ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound__
object
2 properties 2 required
ErrorResponseBody_ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError__
object
2 properties 2 required
ErrorMessage.NotFound
string
BadRequestErrorCodes
number
ErrorResponseBody_ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes__
object
2 properties 2 required
ErrorResponseMetadata
object
4 properties 4 required
Email
string
Valid email address.
ServiceNowTicketType
number
ErrorCode.NotFound
number
HttpStatusCode.BAD_REQUEST
number

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-alerts-devices-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
ControlUp Alerts API
ControlUp Applications API
ControlUp Audit Log API
ControlUp Cloud providers API
ControlUp Dal API
ControlUp Data API
ControlUp Devices API
ControlUp Dynamic Query API API
ControlUp Events API
ControlUp Features API
ControlUp Health API
Where this information came from

This is an independent, third-party profile of ControlUp Alerts - Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.