Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.13 KB

livequery-api.rst

File metadata and controls

49 lines (34 loc) · 1.13 KB

CB LiveQuery API

This page documents the public interfaces exposed by cbapi when communicating with Carbon Black LiveQuery devices.

Main Interface

To use cbapi with Carbon Black LiveQuery, you use CbLiveQueryAPI objects.

The LiveQuery API is used in two stages: run submission and result retrieval.

cbapi.psc.livequery.rest_api.CbLiveQueryAPI

Queries

The LiveQuery API uses QueryBuilder instances to construct structured or unstructured (i.e., raw string) queries. You can either construct these instances manually, or allow CbLiveQueryAPI.select() to do it for you:

cbapi.psc.livequery.query.QueryBuilder

cbapi.psc.livequery.query.RunQuery

cbapi.psc.livequery.models.ResultQuery

Models

cbapi.psc.livequery.models.Run

cbapi.psc.livequery.models.Result