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 Device Groups API

The Device Groups API from Kolide — 5 operation(s) for device groups.

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

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

This API exposes 5 operations across 5 paths, and defines 7 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/.

5 operations 5 paths 7 schemas 1 DELETE3 GET1 POST

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 Device Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

Paths & Operations 5

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

Device Groups 5
GET
/device_groups/{deviceGroupId}/devices
Fetch a list of Devices
5 params → 200401403
POST
/device_groups/{deviceGroupId}/memberships
Add a Device to the Device Group
2 params body → 200401403
DELETE
/device_groups/{deviceGroupId}/memberships/{id}
Remove a specified Device from the Device Group
3 params → 200401403
GET
/device_groups
Fetch a list of Device groups
4 params → 200401403
GET
/device_groups/{id}
Fetch information for a specific Device group
2 params → 200401403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are device (17 properties), device_group (5 properties), device_authentication_mode (3 properties), link-object (2 properties). Each schema is shown below with its type and property counts.

person_group
object
2 properties
device_group_member_request_body
object
1 property
device_group_member
object
2 properties
device_group
object
5 properties
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-device-groups-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 Devices API
Kolide Exemption Requests API
Kolide Issues API
Kolide Live Query Campaigns API
Kolide Packages API
Kolide People API