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

The Instances API from Catchpoint Systems — 6 operation(s) for instances.

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

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.

7 operations 6 paths 29 schemas 4 GET2 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 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.

Instances 7
GET
/v2/instances/{nodeIds}
Return details of the Node and all associated Instances.
1 param → 200
GET
/v2/instances
Returns the Instance details based on the parameters passed.
8 params → 200
POST
/v2/instances
Create a new instance within a new node or add a new instance to an existing node.
1 param body → 200
PATCH
/v2/instances/{instanceId}
Update properties of an existing instance based on the request body.
2 params body → 200
GET
/v2/instances/status/{instanceIds}
Returns the Instance status, active or inactive, based on the Instance IDs passed.
1 param → 200
PATCH
/v2/instances/status
Allows to set the status of an existing instance to Active or Inactive.
body → 200
GET
/v2/instances/hardware/{nodeId}
Returns the instance hardware usage based on the Node ID.
3 params → 200

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.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.ViewModels.Node.InstanceUsageResponseModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[System.Collections.Generic.List`1[System.Int32]]
object
4 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[System.Collections.Generic.List`1[System.Int32]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int32]
object
1 property
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int16]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel
object
23 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Byte]
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse]
object
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.InstanceResponseModel]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel
object
3 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse]
object
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]]]
object
6 properties
Catchpoint.Symphony.ViewModels.DataPointModel
object
2 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel
object
10 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int32]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel]]
object
4 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]]]
object
6 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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