Zerofox
Introduction
This guide explains how to authenticate the ZeroFox connector in Swimlane using API Key authentication. You will generate an API token in ZeroFox, collect the required endpoint details, and configure the connector asset in Swimlane Turbine.
Prerequisites
ZeroFox Access Requirements
You must have appropriate access in ZeroFox to:
- Access ZeroFox platform
- Generate API tokens
- View API endpoint information
- Manage alerts and threat submissions
Required Credentials
During setup you will collect:
- ZeroFox API Base URL
- API Token
Generate ZeroFox API Token
- Log in to the ZeroFox platform.
- Navigate to the account or user settings section.
- Locate API or Developer Settings.
- Click Create API Token or Generate Token.
- Provide a name or description for the token.
- Click Generate.
- Copy and securely store the API token.
Retrieve API Endpoint URL
- Refer to your ZeroFox deployment or API documentation.
- Identify the base API endpoint URL (example: https://api.zerofox.com/).
- Copy the URL for use in Swimlane configuration.
Connector Configuration in Swimlane
- Log in to Turbine.
- From the left navigation pane, click ORCHESTRATION and select Assets.
- Click the Plus (+) icon to create a new asset.
- Select ZeroFox from the Asset Type list.
- Fill in the Asset Settings and Asset Input fields as shown below.
Field | Description | Required |
|---|---|---|
url | Base URL of the ZeroFox API | Required |
api_token | API token generated from ZeroFox | Required |
verify_ssl | Enable or disable SSL certificate verification | Optional |
http_proxy | Proxy configuration if required | Optional |
Troubleshooting
- Ensure the API token is correctly copied and has not expired.
- Verify the API endpoint URL is correct for your ZeroFox environment.
- If authentication fails, regenerate the API token and update the Swimlane asset.
- Ensure the API token has sufficient permissions for required actions.
- Check network connectivity to ZeroFox API endpoints.
- If required, configure proxy settings using http_proxy.
You have successfully authenticated the ZeroFox connector in Swimlane.
Sources
- ZeroFox API Documentation: https://docs.zerofox.com/ο»Ώ