- Overview
- CylanceON-PREM architecture
- Steps to get started with CylanceON-PREM
- Requirements: CylanceON-PREM
- Configuring the CylanceON-PREM virtual appliance
- Migrating to the most recent version of CylanceON-PREM
- Configuring the CylanceON-PREM console
- Log in to CylanceON-PREM
- Administrative dashboard
- Filter lists
- Export lists
- CylanceON-PREM policies
- Setting up the CylancePROTECT agent
- Adding the CA certificate to endpoints
- Installing the CylancePROTECT Desktop agent for Windows
- Installing the CylancePROTECT Desktop agent for macOS
- Installing the CylancePROTECT Desktop agent for Linux
- Manually update the Linux driver
- Upgrading the CylancePROTECT Desktop agents
- Using virtual machines
- Manage devices in CylanceON-PREM
- Threat management in CylanceON-PREM
- CylanceON-PREM Global lists
- CylanceON-PREM Administration
- Managing CylanceON-PREM users
- Managing roles
- Update profile information
- CylanceON-PREM audit logs
- Managing Certificates
- Setting up email notifications for CylanceON-PREM
- CylanceON-PREM Settings
- Upgrade CylanceON-PREM
- Reboot the virtual appliance
- Configure session timeout
- Update CylanceON-PREM SSL certificate version 1.3.1 and later
- Update CylanceON-PREM SSL certificate version 1.2.2.1 and earlier
- Change the certificate cipher mode
- Enable maintenance mode
- Change network settings
- Check an IP address
- Change the log level
- Download logs
- Configure syslog/SIEM settings
- Update database connection settings
- Configure active directory
- Configure identity provider settings
- Using certificate-based authentication
- Add a banner to the login screen
- Applications
- CylanceON-PREM API
- Troubleshooting
- Agent not communicating with CylanceON-PREM
- Web browser reports insecure webpage
- Unable to connect to external database
- Configure static IP using the OVF tool
- Remote server 404 error in log files
- Log in with a local administrator account
- Online Certificate Status Protocol issues
- A user is not receiving email notifications
- Before you contact support
Response codes
Each API request will receive a response with a JSON payload and a standard HTTP status code.
Some API request sections include additional response status descriptions (specific to that request) to help you troubleshoot issues.
Status Code | Description |
---|---|
200 - OK | This indicates a successful call and operation. The response payload will be JSON, structured according to the nature of the request. |
400 - Bad Request | There was a problem with the structure of the request or the payload. If determinable, the response payload will identify the failure in the request. A common case of this type of error is malformed JSON in the request body. A JSON validator can be used to troubleshoot these issues. |
401 - Unauthorized | This indicates invalid credentials were passed or some other failure in authentication. |
403 - Forbidden | The request has been successfully authenticated, but authorization to access the requested resource was not granted. |
404 - Not Found | A request was made for a resource that doesn't exist. Common causes are either an improperly formed URL or an invalid API key. |
409 - Conflict | A request was made to create or update an aspect of the resource that conflicts with another. The most common reason for this code is a Tenant name or User email that is already in use. |
500 - Internal Server Error | A catch-all code response for any unhandled error that has occurred on the server. Contact BlackBerry Support for help with this issue. |
501 - Not Implemented | A request was made against a resource with an operation that has yet to be implemented. Such operations should be identified accordinly in documentation. |
Other | Contact BlackBerry Support if you encounter any status codes that are not on this list. |