Get package execution

Request a specific package execution resource belonging to a tenant. Use Get Package Executions to obtain the unique package execution ID.

Service endpoint

/packages/v2/executions/{unique_execution_id}

Optional query string parameters

—

Example

https://protectapi.cylance.com/packages/v2/executions/abebf88c-f283-4edc-834b-aa8ad3bc682c

Method

HTTP/1.1 GET

Request headers
  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the opticspkgdeploy:read 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 ID for the user.
  • login: This is the email address of the user.

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 devices.

  • acked (acknowledged): This is the number of devices that received the package execution.
  • 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 ID 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 to download the package resource from.

target

These are the devices and/or zones to execute the package against.

  • devices: This is the list of device IDs to execute the packages against.
  • zones: This is the list of zone IDs to execute the packages against.