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 Systems SLO API

The SLO API from Catchpoint Systems — 4 operation(s) for slo.

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

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

This API exposes 7 operations across 4 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

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

7 operations 4 paths 27 schemas 1 DELETE4 GET1 PATCH1 POST

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 Systems SLO API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 7

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

SLO 7
GET
/v2/slo/{sloIds}
Retrieve properties of one or more SLOs based on SLO IDs.
1 param → 200
PATCH
/v2/slo/{sloIds}
Update properties of an existing SLO based on the request body.
2 params body → 200
DELETE
/v2/slo/{sloIds}
Delete one or more SLOs based on SLO IDs.
1 param → 200
GET
/v2/slo
Retrieve SLOs that match all included parameters.
6 params → 200
POST
/v2/slo
Create a new SLO configured per the request body.
1 param body → 200
GET
/v2/slo/enumeration
Retrieve SLO property enumerations.
5 params → 200
GET
/v2/slo/violations
Retrieve violation data for all SLOs matching request parameters within the requested date range.
8 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Slo.SloAPIModel (21 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.Slo.SloViolationAPIModel (10 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.SloGetViolationsResponse] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.SloDeleteResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.SloPostResponse
object
5 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.SloDeleteResponse]
object
6 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Nullable`1[System.Int32]]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Slo.SloAPIModel
object
21 properties 9 required
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationDetailResponse
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse
object
4 properties
Catchpoint.Symphony.Enums.Alerts.NodeThresholdType
integer
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.SloPostResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.SloGetViolationsResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.Enums.Metrics.AnalyticsMetric
integer
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.SloGetResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.SloGetResponse]
object
6 properties
Catchpoint.Symphony.Enums.Alerts.AlertTimeThresholdInterval
integer
Catchpoint.Symphony.Enums.Alerts.OperatorType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.SloGetViolationsResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Slo.SloViolationAPIModel
object
10 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-systems-slo-api-openapi.yml Raw ↑

Other APIs Catchpoint Systems publishes across the network.

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