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 Label API

The Label API from Catchpoint Systems — 3 operation(s) for label.

Catchpoint Systems Label 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 Label. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

5 operations 3 paths 18 schemas 1 DELETE2 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 Label API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 5

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

Label 5
GET
/v2/labels/{labelKeyIds}
Returns the label details for the label key IDs passed.
1 param → 200
GET
/v2/labels
Return the label details based on parameters.
4 params → 200
POST
/v2/labels
Create a new label based on the Post data.
1 param body → 200
PATCH
/v2/labels/{labelKeyId}
Update an existing label based on the request body.
2 params body → 200
DELETE
/v2/labels/{labelKeyId}
Delete labels by Label Key ID.
1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelGetResponse] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelDeleteResponse] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelPostResponse] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelValueApiModel
object
4 properties 1 required
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelDeleteResponse]
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.Label.LabelPostResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelDeleteResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelModel
object
5 properties 2 required
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelGetResponse
object
4 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.AssociatedObjectAPIModel
object
2 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelGetResponse]
object
6 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelPostResponse
object
5 properties
Catchpoint.Symphony.Enums.ObjectType
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-systems-label-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