Catchpoint Systems Node 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 Node. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
14 operations
across 13 paths,
and defines 40 schemas.
It is described by OpenAPI 3.0.1, at version 2.0.
Requests are made against a single base URL, /api.
14 operations13 paths40 schemas10 GET3 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 Node API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
Paths & Operations 14
Across 13 paths, the API surfaces 14 operations — 10 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Node 14
GET
/v2/nodes/{nodeIds}
Returns node details by Node ID.
1 param→ 200
GET
/v2/nodes
Returns the details of Enterprise Nodes within a Client or a Division.
7 params→ 200
GET
/v2/nodes/all
Returns the details of nodes of all network types based on parameters passed.
12 params→ 200
GET
/v2/nodes/state/{nodeIds}
Returns the Node state, paused or not, based on the Node IDs passed.
1 param→ 200
PATCH
/v2/nodes/state
Allows to pause or resume an existing node.
body→ 200
GET
/v2/nodes/status/{nodeIds}
Returns the Node status, active or inactive, based on the Node IDs passed.
1 param→ 200
PATCH
/v2/nodes/status
Allows to set the status of an existing node to Active or Inactive.
body→ 200
PATCH
/v2/nodes/{nodeId}
Update properties of an existing node.
2 paramsbody→ 200
GET
/v2/nodes/os
Returns a list of all the operating system names that match the parameter passed.
1 param→ 200
GET
/v2/nodes/isp
Returns a list of all the ISP names that match the parameter passed.
1 param→ 200
GET
/v2/nodes/package
Returns the available enterprise packages for the Client or Division.
→ 200
GET
/v2/nodes/geographycity
Returns all the available cities that can be used while creating a Node.
3 params→ 200
GET
/v2/nodes/chromeversions
Retrieves the Chrome versions information for the Enterprise node, this will include all versions installed on the node, even if not targeted.
1 param→ 200
POST
/v2/nodes/chromeversions
Update the chrome versions for the specified Enterprise node based on the payload sent.
body→ 200
Schemas 40
The contract defines 40 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.PublicNodeModel (14 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel (10 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse (7 properties). Each schema is shown below with its type and property counts.