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

Kentik DeviceService API

The DeviceService API from Kentik — 7 operation(s) for deviceservice.

Kentik DeviceService API is one of 24 APIs that Kentik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DeviceService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 7 paths, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version v202511.

Requests are made against the base URL https://grpc.api.kentik.com.

10 operations 7 paths 31 schemas 1 DELETE3 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v202511
Base URL
https://grpc.api.kentik.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Kentik DeviceService API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-CH-Auth-Email (email). An API key is passed in the header as X-CH-Auth-API-Token (token). By default, every request must be authenticated.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

DeviceService 10
GET
/device/v202504beta2/device
List all devices.
ListDevices 2 params → 200default
POST
/device/v202504beta2/device
Configure a new device.
CreateDevice body → 200default
POST
/device/v202504beta2/device/batch_create
Configure multiple devices (max 100).
CreateDevices body → 200default
POST
/device/v202504beta2/device/batch_delete
Delete configuration of multiple devices.
DeleteDevices body → 200default
PUT
/device/v202504beta2/device/batch_update
Updates configuration of multiple devices (max 100).
UpdateDevices body → 200default
GET
/device/v202504beta2/device/name/{deviceName}
Retrieve configuration of a device by name.
GetDeviceByName 2 params → 200default
PUT
/device/v202504beta2/device/{device.id}
Updates configuration of a device.
UpdateDevice 1 param body → 200default
GET
/device/v202504beta2/device/{device.id}
Retrieve configuration of a device.
GetDevice 2 params → 200default
DELETE
/device/v202504beta2/device/{device.id}
Delete configuration of a device.
DeleteDevice 1 param → 200default
PUT
/device/v202504beta2/device/{id}/labels
Updates labels of a device.
UpdateDeviceLabels 1 param body → 200default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are v202504beta2DeviceDetailed (67 properties), v202504beta2DeviceConcise (25 properties), v202504beta2Plan (16 properties), devicev202504beta2Label (11 properties). Each schema is shown below with its type and property counts.

v202504beta2LabelConcise
object
1 property
v202504beta2Site
object
5 properties
v202504beta2Interface
object
9 properties
v202504beta2Plan
object
16 properties
v202504beta2GnmiV1Conf
object
1 property
v202504beta2GetDeviceByNameResponse
object
1 property
v202504beta2CreateDeviceResponse
object
1 property
v202504beta2DeleteDeviceResponse
object
v202504beta2DeviceDetailed
object
67 properties
v202504beta2CreateDevicesResponse
object
2 properties
v202504beta2DeviceNmsConfig
object
4 properties
v202504beta2UpdateDevicesRequest
object
1 property 1 required
v202504beta2DeviceNmsStConfig
object
4 properties
v202504beta2DeviceSnmpV3Conf
object
5 properties
v202504beta2DeleteDevicesResponse
object
1 property
rpcStatus
object
3 properties
v202504beta2DeviceNmsSnmpConfig
object
3 properties
v202504beta2CreateDeviceRequest
object
1 property 1 required
v202504beta2UpdateDevicesResponse
object
2 properties
v202504beta2CustomColumnData
object
6 properties
v202504beta2CreateDevicesRequest
object
1 property 1 required
v202504beta2GetDeviceResponse
object
1 property
DeviceServiceUpdateDeviceLabelsBody
object
1 property 1 required
DeviceServiceUpdateDeviceBody
object
1 property 1 required
v202504beta2ListDevicesResponse
object
2 properties
v202504beta2UpdateDeviceResponse
object
1 property
v202504beta2DeleteDevicesRequest
object
1 property 1 required
v202504beta2UpdateDeviceLabelsResponse
object
1 property
protobufAny
object
1 property
v202504beta2DeviceConcise
object
25 properties
devicev202504beta2Label
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kentik-deviceservice-api-openapi.yml Raw ↑

Other APIs Kentik publishes across the network.

Kentik AiAdvisorDataService API
Kentik AlertService API
Kentik ASGroupService API
Kentik AuditService API
Kentik BgpMonitoringAdminService API
Kentik BgpMonitoringDataService API
Kentik CapacityPlanService API
Kentik CloudExportAdminService API
Kentik CostService API
Kentik CustomDimensionService API
Kentik FlowTagService API
Kentik KmiService API