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 Live Query Campaigns API

The Live Query Campaigns API from Kolide — 3 operation(s) for live query campaigns.

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

Tagged areas include Live Query Campaigns. 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 3 paths, and defines 4 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 3 paths 4 schemas 1 DELETE3 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 Live Query Campaigns 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 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Live Query Campaigns 7
GET
/live_query_campaigns/{liveQueryCampaignId}/query_results
Fetch a list of Live query results
5 params → 200401403
GET
/live_query_campaigns
Fetch a list of Live query campaigns
4 params → 200401403
POST
/live_query_campaigns
Create a new Live query campaign
1 param body → 200401403
GET
/live_query_campaigns/{id}
Fetch information for a specific Live query campaign
2 params → 200401403
PATCH
/live_query_campaigns/{id}
Update an existing Live query campaign
2 params body → 200401403
PUT
/live_query_campaigns/{id}
Update an existing Live query campaign
2 params body → 200401403
DELETE
/live_query_campaigns/{id}
Delete a specific Live query campaign
2 params → 200401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are live_query_campaign (10 properties), live_query_campaign_request_body (7 properties), live_query_result (7 properties), link-object (2 properties). Each schema is shown below with its type and property counts.

live_query_result
object
7 properties
link-object
object
2 properties
live_query_campaign
object
10 properties
live_query_campaign_request_body
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kolide-live-query-campaigns-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 Devices API
Kolide Exemption Requests API
Kolide Issues API
Kolide Packages API
Kolide People API