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

The NodeUtilization API from Catchpoint Systems — 6 operation(s) for nodeutilization.

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

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

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

6 operations 6 paths 26 schemas 6 GET

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

Paths & Operations 6

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

NodeUtilization 6
GET
/v2/nodes/testrun/{nodeId}
Returns the list of all tests that ran on a node based on Node ID.
3 params → 200
GET
/v2/nodes/runrate/{nodeId}
Returns the node run rate and slippage information based on Node ID.
3 params → 200
GET
/v2/nodes/capacityutilization/{nodeId}
Returns the node capacity utilization percentage based on Node ID.
3 params → 200
GET
/v2/nodes/errors/{nodeId}
Returns the error count details based on Node ID.
3 params → 200
GET
/v2/nodes/testruncount/{nodeId}
Returns the number of tests based on Node ID.
3 params → 200
GET
/v2/nodes/testtime/{nodeId}
Returns the average test time taken based on Node ID.
3 params → 200

Schemas 26

The contract defines 26 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.v2_0.Node.NodeTestRun (7 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodePerformanceResponse] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestRunResponse
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestFailureResponse]
object
6 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestFailureResponse
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestRunDataPointResponse
object
6 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int16]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel
object
23 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.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestRunDataPointResponse]
object
6 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.Enums.MonitorSetType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.DataPointApiModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeRunRateResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 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.NodePerformanceResponse
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeRunRateResponse
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodePerformanceResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeTestRun
object
7 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeTestRunResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.MonitorDataPointApiModel
object
2 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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