Catchpoint Instances API
The Instances API from Catchpoint — 6 operation(s) for instances.
Catchpoint Instances API is one of 31 APIs that Catchpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Instances. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 7 operations across 6 paths, and defines 29 schemas. It is described by OpenAPI 3.0.1, at version 2.0.
Requests are made against a single base URL, /api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Catchpoint Instances API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 4 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel (23 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel (10 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int32]]] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel]]] (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Catchpoint 12
Other APIs Catchpoint publishes across the network.