Catchpoint Node API

The Node API from Catchpoint — 13 operation(s) for node.

Documentation Provider Profile APIs.io OpenAPI GitHub

Catchpoint Node API is one of 31 APIs that Catchpoint 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 an API reference.

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 operations 13 paths 40 schemas 10 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

Authentication & Security 1

Catchpoint 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 params body → 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.Node.EnterpriseContractModel (7 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]]

object

6 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.CityModel

object

3 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse]

object

6 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel

object

23 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]

object

4 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]]

object

6 properties

object

6 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.GeographyCityResponse]

object

6 properties

Microsoft.AspNetCore.JsonPatch.Operations.Operation

object

4 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse

object

4 properties

Catchpoint.Symphony.REST.Common.Requests.v2_0.ChromeVersionsRequestModel

object

4 properties

Catchpoint.Symphony.REST.Api.ApiUsageStatistics

object

6 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnterprisePackageResponse]

object

6 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int16]]]

object

6 properties

Catchpoint.Symphony.REST.Common.Models.InfoMessage

object

2 properties

Catchpoint.Symphony.REST.Api.ConsumerStatistics

object

3 properties

Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Byte]

object

2 properties

object

6 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.OsResponse]

object

6 properties

Catchpoint.Symphony.ViewModels.MessageModel

object

2 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.EnterprisePackageResponse

object

4 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel

object

3 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.ChromeVersionsResponse

object

7 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int16]]

object

4 properties

Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse]

object

6 properties

Catchpoint.Symphony.REST.Api.DivisionUsageStatistics

object

2 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.GeographyCityResponse

object

4 properties

Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]

object

2 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]

object

4 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]

object

4 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`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.IIdResponse`1[System.Int16]

object

1 property

Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int64]

object

2 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.OsResponse

object

4 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel

object

10 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.EnterpriseContractModel

object

7 properties

Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int16]

object

2 properties

Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel

object

14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Catchpoint publishes across the network.

Catchpoint Account API

AE Profile APIs.io

Catchpoint Alerts API

AE Profile APIs.io

Catchpoint ASNs API

AE Profile APIs.io

Catchpoint Assertions API

AE Profile APIs.io

Catchpoint CommandControl API

AE Profile APIs.io

Catchpoint Contacts API

AE Profile APIs.io

Catchpoint Credentials API

AE Profile APIs.io

Catchpoint Divisions API

AE Profile APIs.io

Catchpoint EndpointDevice API

AE Profile APIs.io

Catchpoint EndpointDevicePerformance API

AE Profile APIs.io

Catchpoint Folder API

AE Profile APIs.io

Catchpoint Insights API

AE Profile APIs.io

#Node

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Catchpoint Node API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 40

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Catchpoint Node API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 40

Specification

Source

More from Catchpoint 12

API Details

Provider

Explore more