Skip Navigation
  1. BlackBerry Docs
  2. Cylance Endpoint Security
  3. Cylance User API guide
  4. Package deployment API
  5. Get package executions

Get package executions

Request a page with a list of package executions belonging to a tenant, sorted by the uploaded date, in descending order (most recent uploaded package execution listed first). The page number and page size parameters are optional. When the values are not specified, the default values are 1 and 20 respectively.
Service endpoint
/packages/v2/executions?page=m&page_size=n
Optional query string parameters
  • page: This is the page number to request.
  • page_size: This is the number of package records to retrieve per page.
  • sort: This sorts by the following fields (adding "-" in front of a value denotes descending order).
    • id: Filter by unique ID of the execution
    • name: Filter by name of the execution
    • createdAt: Filter by date and time (in UTC) when the execution was requested
    • createdBy.Id: Filter by ID of the user who requested the execution
    • createdBy.Login: Filter by the email address of the user who requested the execution
    • deviceCount: Filter by the number of online devices at the moment the package execution request was made
Example
retrieve the first page with up to 100 Detections, filtered by ID, and sorted by ID: https://protectapi.cylance.com/packages/v2/executions?page=1&page_size=100&id=1C04-1C2D&sort=id
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
     with the opticspkgdeploy:list scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
createdAt
This is the date and time (in UTC) when the execution was requested.
createdBy
This is the user who requested the execution.
  • id: This is the unique identifier of the user who requested the execution.
  • login: This is the email address of the user who requested the execution.
destination
This is the FTP, SFTP, or SAMBA URL for saving the results.
deviceCount
This is the number of online devices at the moment the package execution request was made.
deviceStatuses
These are the statuses of the package executions on the device.
  • acked (acknowledged): This is the number of devices that received the package.
  • failed: This is the number of devices that failed to execute the packages.
  • succeeded: This is the number of devices that have successfully executed the packages.
id
This is the unique identifier of the execution resource.
keepResultsLocally
This is the setting to save the results to the local disk drive. If true, the results are saved to file://[Cylance Data Directory]/Optics.
name
This is the name of the execution.
packageExecutions
This is the list of packages to execute.
  • arguments: This is the list of arguments for the package. See examples from packageDescriptor.
  • package: This is the URL from which to download the package resource.
page_number
This is the page number requested.
page_size
This is the page size requested.
target
These are the devices and/or zones to execute the packages against.
  • devices: This is the list of device IDs to execute the packages against.
  • The list of zone IDs to execute the packages against.
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.