Get packages

Request a page with a list of packages belonging to a tenant, sorted by the uploaded date, in descending order (most recent uploaded package 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?page=m&page_size=n

Optional query string parameters
  • page: This is the page number to request.
  • page_size: This is the number of device records to retrieve per page.
  • sort: This sorts by the following fields (adding "-" in front of a value denotes descending order).
    • packageId: Filter by package ID
    • uploadedOn: Filter by the uploaded timestamp (in UTC)
    • uploadedBy.id: Filter by the user ID of the user who uploaded the package
    • uploadedBy.login: Filter by the email of the user who uploaded the package
    • size: Filter by the size of the package (in bytes)
    • status: Filter by the status of the package upload process, values are started, success, failed, or timeout
    • timeout: Filter by the amount of time (in seconds) for the package to upload before the status changes to timeout
    • packageDescriptor.name: Name of the package
  • category: This filters by the package category. The values are custom or cylance.

Example

retrieve the first page with up to 100 Packages, sorted by a success status: https://protectapi.cylance.com/packages/v2?page=1&page_size=100&status=success

Method

HTTP/1.1 GET

Request headers
  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the opticspkgconfig:list scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name Description

category

This is the category of the package. The values are custom or cylance.

downloadUrl

This is the URL to download the package from.

packageDescriptor

This is the package metadata, provided by the user.

  • description: This is the description of the package.
  • examples: This is the list of examples of how to use the package.
    • invocationString: This is an example of how to invoke the package.
    • description: This is a description of what the example does.
  • name: This is the name of the package.
  • packageId: This is the unique ID for the package.
  • packageInfo: This is the package level documentation or annotation.
    • fileType: This is the file type of the package, only Python is supported.
    • fileName: This is the name of the package file.
    • entryPoint: This is the point of execution for the package.
  • version: This is the version of the package.

packageId

This is the unique identifier for the package.

page_number

This is the page number requested.

page_size

This is the page size requested.

playbookCount

This is the number of playbooks to which the package is associated.

size

This is the size of the package (in bytes).

status

This is the status of the package in the upload process.

timeout

This is the amount of time (in seconds) for the package to upload before the status changes to timeout.

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.

uploadedBy

This is the unique identifier of the user who uploaded the package.

  • id: The unique ID for the user.
  • login: The email address of the user.

uploadedOn

This is the date and time (in UTC) when the package was uploaded.