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

The Checks API from Kolide — 5 operation(s) for checks.

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

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

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

7 operations 5 paths 9 schemas 4 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 Checks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

Paths & Operations 7

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

Checks 7
GET
/checks/{checkId}/results
Fetch a list of Check results
5 params → 200401403
GET
/checks/{checkId}/configurations
Fetch information for a specific Check configuration
2 params → 200401403
PATCH
/checks/{checkId}/configurations
Update an existing Check configuration
2 params body → 200401403
PUT
/checks/{checkId}/configurations
Update an existing Check configuration
2 params body → 200401403
POST
/checks/{checkId}/runs
Create a new External check run
2 params body → 200401403
GET
/checks
Fetch a list of Checks
4 params → 200401403
GET
/checks/{id}
Fetch information for a specific Check
2 params → 200401403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are check_configuration (25 properties), check (16 properties), check_configuration_request_body (11 properties), check_result (10 properties). Each schema is shown below with its type and property counts.

check_configuration
object
25 properties
check_result
object
10 properties
check_tag
object
4 properties
external_check_run_request_body
object
4 properties
check_targeting_config
object
2 properties
check_configuration_request_body
object
11 properties
check
object
16 properties
external_check_run
object
7 properties
check_auth_blocking_config
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kolide-checks-api-openapi.yml Raw ↑

Other APIs Kolide publishes across the network.

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