AdhocSearch

Returns a structured representation of a query without running it

Parses and validates a search query, then returns a structured representation of the parsed query. Does not run the provided query.

  • Requires action source_data:Query
post/api/v1/org/{orgUID}/search/parse-query/

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/search/parse-query/
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Organization UID to query

Query parameters

limitinteger

Maximum number of results to return

Request body

case_sensitiveboolean

Whether the query is case sensitive (default false)

cluster_uidstring

An optional pre-filter field that restricts results to one cluster

context_uidstring

Context UID for this query, it's used to track the query as it flows through the system, and shouldn't be exposed to customers

end_timeinteger required

End time to query

latest_versionboolean nullable

Whether to pre-filter the results to only search with the latest version of each object (default true)

muidstring

An optional pre-filter field that restricts results to one machine

order_byunknown
output_fieldsstring[]

What fields to output from the query; default: ["id"]

querystring required

Query to execute

schemastring required

Schema to query

start_timeinteger required

Start time to query

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.