Skip Navigation

Create package

Create a new
BlackBerry Optics
package resource for a tenant.
Service endpoint
/packages/v2
Optional query string parameters
Example
https://protectapi.cylance.com/packages/v2
Method
HTTP/1.1 POST
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
    with the opticspkgconfig:create scope encoded

Request

{ "checksum": "bf17366ee3bb8068a9ad70fc9e68496e7e311a055bf4ffeeff53cc5d29ccce52", "packageDescriptor": { "name": "Test Package", "description": "This is a test package", "examples": [], "packageInfo": { "fileType": "python", "fileName": "hello_world.py", "entryPoint": "" }, "version": 1 } }

Response

Please see the Response status codes for more information.

Request JSON schema

Field Name
Description
checksum
This is the SHA256 hash for the package.
description
This is a description of what the package does.
examples
This is a list of examples of how to use the package. This information is optional.
  • description: A description of what the example does.
  • invocationString: An example of how to invoke the package.
name
This is the name of the package.
packageInfo
This is the package level documentation and annotation.
  • entryPoint: The point of execution for the package.
  • fileName: The name of the package file.
  • fileType: The file type of the package. Only
    Python
    is supported.
version
This is the version of the package, which must be 1 or higher.

Response JSON schema

Field Name
Description
packageId
This is the unique identifier for the package.
packageUrl
This is the URL to retrieve the package (after the actual package has been uploaded).
uploadTo
This is the URL used to upload the package.