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

The NodeGroup API from Catchpoint Systems — 5 operation(s) for nodegroup.

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

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

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

8 operations 5 paths 31 schemas 1 DELETE5 GET1 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 NodeGroup API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

NodeGroup 8
GET
/v2/nodes/groups/{nodeGroupIds}
Returns the node group details based on the ID.
1 param → 200
GET
/v2/nodes/groups
Returns the node group details based on the parameters passed.
4 params → 200
POST
/v2/nodes/groups
Create a new node group based on the PostData.
1 param body → 200
PATCH
/v2/nodes/groups
Update properties of an existing node group based on the request body.
2 params body → 200
DELETE
/v2/nodes/groups
Deletes existing node group by parameters passed.
1 param → 200
GET
/v2/nodes/groups/networktype
Returns the list of network types supported for node group.
→ 200
GET
/v2/nodes/groups/objecttype
Retrieves the list of object Types supported for node group location.
→ 200
GET
/v2/nodes/groups/nodelocations
This endpoint allows to fetch all the available continents, countries and cities that can be used as Node Locations when creating a Node Group
1 param → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel (9 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ObjectTypeResponse] (6 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel]] (6 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.NodeGroupResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NetworkTypeResponse]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeLocationResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[System.Collections.Generic.List`1[System.Int32]]]
object
6 properties
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType
integer
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NetworkTypeResponse]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel]]
object
6 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[System.Collections.Generic.List`1[System.Int32]]
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.Common.Response.v2_0.Node.NodeLocationCountryModel
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel
object
9 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeLocationResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ObjectTypeResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeGroupItemApiModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NetworkTypeResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeLocationContinentModel
object
4 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeLocationCityModel
object
3 properties
Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ObjectTypeResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel]]
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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