Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Catchpoint Alerts API

The Alerts API from Catchpoint — 2 operation(s) for alerts.

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

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

This API exposes 3 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

3 operations 2 paths 23 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint Alerts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 3

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

Alerts 3
GET
/v2/tests/alerts/{alertIds}
Returns alert details based on the alert IDs.
1 param → 200
GET
/v2/tests/alerts
Returns alert details based on the parameters.
13 params → 200
PATCH
/v2/tests/alerts
Assign, Acknowledge or Drop alerts.
body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel (25 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[System.String]]] (6 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel]]] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[System.String]]
object
4 properties
Catchpoint.Symphony.Enums.Alerts.OperatorType
integer
Catchpoint.Symphony.Enums.Alerts.NotificationLevel
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertUpdateModel
object
5 properties 1 required
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel]
object
4 properties
Catchpoint.Symphony.Enums.Alerts.AlertTriggerType
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel]]]
object
6 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertResponse`1[System.Collections.Generic.List`1[System.String]]]
object
6 properties
Catchpoint.Symphony.Enums.Alerts.ReportAlertSubtype
integer
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.Enums.Alerts.ReportAlertType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelAPIModel
object
4 properties
Catchpoint.Symphony.Enums.Test.DisplayTestType
integer
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertApiModel
object
25 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Nullable`1[System.Int64]]
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-alerts-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

Catchpoint Account API
Catchpoint ASNs API
Catchpoint Assertions API
Catchpoint CommandControl API
Catchpoint Contacts API
Catchpoint Credentials API
Catchpoint Divisions API
Catchpoint EndpointDevice API
Catchpoint EndpointDevicePerformance API
Catchpoint Folder API
Catchpoint Insights API
Catchpoint Instances API