Process Search

GET {{cb_url}}/api/v1/process?q=chrome.exe&rows=1&start=0&sort=&facet=false&facet.field=process_name&facet.field=hostname&facet.field=process_md5

Process search. Parameters passed as a query string.


See the Documentation

Request Params

KeyDatatypeRequiredDescription
qstringREQUIRED Query string. Accepts the same data as the search box on the Process Search page.
rowsnumberOPTIONAL Return this many rows, 10 by default.
startnumberOPTIONAL Start at this row, 0 by default.
sortnullOPTIONAL Sort rows by this field and order. last_update desc by default.
facetbooleanOPTIONAL Return facet results. โ€˜falseโ€™ by default, set to โ€˜trueโ€™ for facets.
facet.fieldstringOPTIONAL facet field name to return. Multiple facet.field parameters can be specified in a query.
facet.fieldstringOPTIONAL facet field name to return. Multiple facet.field parameters can be specified in a query.
facet.fieldstringOPTIONAL facet field name to return. Multiple facet.field parameters can be specified in a query.
cb.comprehensive_searchnullOPTIONAL if set to true, CB will automatically fix the query and insert joins to make it comprehensive (reducing performance)
cb.facet.fuzzynullOPTIONAL if set to true, enable fuzzy faceting for performance (default is set in the cb.conf file)
cb.groupnullOPTIONAL group by a field name. For example, if query parameter cb.group=id, search will return one result per process
cb.urlvernumber

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring