Skip Navigation

Get InstaQueries

Request a page with a list of
BlackBerry Optics
InstaQuery resources belonging to a tenant, sorted by occurrence time, in descending order (most recent occurred InstaQuery listed first). The page number and page size parameters are optional, when the values are not specified, they default to 1 and 20 respectively.
Service endpoint
/instaqueries/v2?page=m&page_size=n
Optional query string parameters
  • q: This is the case-insensitive search term (e.g. name, zones, artifact).
  • archived: Include archived surveys.
  • originated-from: Limit the query by the relationship.
  • page: This is the page number to request. Defaults to 1.
  • page_size: This is the number of detection records to retrieve per page. Defaults to 20.
  • sort: Sort by field (adding '-' in front of the value denotes descending order).
Example
https://protectapi.cylance.com/instaqueries/v2?page=m&page_size=n
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
    with the opticssurvey:list scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
page_number
This is the page number requested.
page_size
This is the page size requested.
total_number_of_items
This is the total number of resources.
total_pages
This is the total number of pages that can be retrieved based on the page size specified.
page_items
This is the list of detections belonging to the requested page.
name
This is the name of the InstaQuery.
description
This is the description of the InstaQuery.
artifact
This is the artifact type that was queried.
match_value_type
This is the type (or Facet) of the artifact that was queried.
match_values
This is the list of values that were queried for.
case_sensitive
This value indicates whether or not the InstaQuery should take case into account.
match_type
This is the match type configured for the query, either "fuzzy" or "exact."
zones
This is the list of zones queried.
filters
This is the list of filters applied to the InstaQuery.
relations
This is the list of objects (e.g.: Focus Views) that the InstaQuery is related to.
id
This is the unique ID of the InstaQuery.
archived
This is the timestamp of when the InstaQuery was archived.
results_available
This determines if the InstaQuery has returned any results.
progress
This provides the number of devices queried and the number of devices that have responded.