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

The EndpointDevice API from Catchpoint — 7 operation(s) for endpointdevice.

Catchpoint EndpointDevice API is one of 31 APIs that Catchpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EndpointDevice. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 7 operations across 7 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.

7 operations 7 paths 26 schemas 4 GET3 PATCH

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

Paths & Operations 7

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

EndpointDevice 7
GET
/v2/endpoints/device/{userIds}
Returns the details of endpoint devices based on the User ID.
1 param → 200
GET
/v2/endpoints/device
Returns the details of endpoint devices based on the parameters passed.
7 params → 200
GET
/v2/endpoints/device/status/{userIds}
Returns the endpoint device status based on the User ID.
1 param → 200
PATCH
/v2/endpoints/device/status
Allows to set the status of an existing endpoint device to Active or Inactive.
body → 200
GET
/v2/endpoints/device/label/{userIds}
Returns the endpoint device labels based on the User ID.
1 param → 200
PATCH
/v2/endpoints/device/label
Allows to update the existing endpoint device label.
body → 200
PATCH
/v2/endpoints/device/{userId}
Update properties of an existing endpoint device based on the request body.
2 params body → 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.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointDeviceModel]]] (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[System.Int64]]] (6 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.IEndpointDeviceModel]] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.IEndpointDeviceModel]
object
4 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[System.Int64]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.IEndpointDeviceModel
object
1 property
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointDeviceModel]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointLabelModel]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointLabelModel
object
3 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Byte]
object
2 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.IEndpointDeviceModel]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[System.Int64]]
object
4 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelAPIModel
object
4 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointStatusModel]]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointLabelModel]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointLabelUpdateModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointStatusModel]]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointDeviceModel
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointStatusModel
object
3 properties
Catchpoint.Symphony.REST.Common.Requests.v2_0.Endpoint.EndpointLabelAPIInputModel
object
3 properties 1 required
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EndpointDeviceResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Endpoint.EndpointDeviceModel]]]
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-endpointdevice-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

Catchpoint Account API
Catchpoint Alerts API
Catchpoint ASNs API
Catchpoint Assertions API
Catchpoint CommandControl API
Catchpoint Contacts API
Catchpoint Credentials API
Catchpoint Divisions API
Catchpoint EndpointDevicePerformance API
Catchpoint Folder API
Catchpoint Insights API
Catchpoint Instances API