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

Kolide Devices API

The Devices API from Kolide — 7 operation(s) for devices.

Kolide Devices API is one of 17 APIs that Kolide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 9 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2023-05-26.

Requests are made against a single base URL, https://api.kolide.com/.

9 operations 7 paths 10 schemas 2 DELETE4 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2023-05-26
Base URL
https://api.kolide.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kolide Devices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

Paths & Operations 9

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

Devices 9
GET
/devices/{deviceId}/open_issues
Fetch a list of Issues
5 params → 200401403
PATCH
/devices/{deviceId}/authentication_mode
Update an existing Device authentication mode
2 params body → 200401403
PUT
/devices/{deviceId}/authentication_mode
Update an existing Device authentication mode
2 params body → 200401403
DELETE
/devices/{deviceId}/registration
Delete a device registration
2 params → 200401403
POST
/devices/{deviceId}/check_refreshes
Create a new Check refresh
2 params body → 200401403
GET
/devices/{deviceId}/check_results
Fetch a list of Check results
5 params → 200401403
GET
/devices
Fetch a list of Devices
4 params → 200401403
GET
/devices/{id}
Fetch information for a specific Device
2 params → 200401403
DELETE
/devices/{id}
Delete a specific Device
2 params → 200401403

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are device (17 properties), issue (12 properties), check_result (10 properties), device_registration (4 properties). Each schema is shown below with its type and property counts.

device_registration
object
4 properties
device_authentication_mode_request_body
object
2 properties
check_result
object
10 properties
person_group
object
2 properties
check_refresh
object
3 properties
issue
object
12 properties
check_refresh_request_body
object
1 property
device_authentication_mode
object
3 properties
device
object
17 properties
link-object
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kolide-devices-api-openapi.yml Raw ↑

Other APIs Kolide publishes across the network.

Kolide Admin Users API
Kolide Audit Logs API
Kolide Auth Logs API
Kolide Checks API
Kolide Custom Check Drafts API
Kolide Deprovisioned People API
Kolide Device Groups API
Kolide Exemption Requests API
Kolide Issues API
Kolide Live Query Campaigns API
Kolide Packages API
Kolide People API