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

Get package

Request a specific package resource belonging to a tenant. Use get packages to obtain the unique package ID.
Service endpoint
/packages/v2/{unique_package_id}
Optional query string parameters
—
Example
https://protectapi.cylance.com/packages/v2/e378dacb-9324-453a-b8c6-5a8406952195
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
     with the opticspkgconfig:read 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 a list of examples of how to use the package.
    • description: This is a description of what the example does.
    • invocationString: This is an example of how to invoke the package.
  • name: This is the name of the package.
  • packageInfo: This is the package level documentation or annotation.
    • entryPoint: This is the point of execution for the package.
    • fileName: This is the name of the package file.
    • fileType: This is the file type of the package. Only Python is supported.
  • packageId: This is the unique identifier for the package.
  • version: This is the version of the package.
packageId
This is the unique identifier for the package.
playbookCount
This is the number of playbooks that the package is associated with.
size
This is the size of the package, in bytes.
status
This is the status of the package in the upload process. The statuses are started, success, failed, and timeout.
timeout
This is the amount of time (in seconds) for a package upload before the status changes to timeout.
uploadedBy
These are the unique identifiers of the user who uploaded the package.
  • id: This is the unique ID for the user.
  • login: This is the email address of the user.
uploadedOn
This is the date and time (in UTC) when the package was uploaded.