---
title: "Cyble Vision collector"
canonical: "https://docs.devo.com/space/latest/377782375/Cyble%20Vision%20collector"
format: markdown
---
> Macro (toc)
## Overview
Cyble Vision is a comprehensive cybersecurity platform designed to keep businesses a step ahead of cyber threats. Cyble Vision swiftly identifies incidents and provides advanced intelligence for rapid response, helping to mitigate attack damages. The Cyble Vision collector allows users to fetch and analyze incidents and fetch IOCs for further triage in the Devo platform.
## Devo collector features
| **Feature** | **Details** |
| --- | --- |
| Allow parallel downloading (`multipod`) | `not allowed` |
| Running environments | - `collector server`
- `on-premise` |
| Populated Devo events | - `table`
- `lookups` |
| Flattening preprocessing | `no` |
## Data sources
| **Data source** | **Description** | **API endpoint** | **Collector service name** | **Devo table / lookup** | **Available from release** |
| --- | --- | --- | --- | --- | --- |
| Alerts | Fetch alerts / incidents | `/apollo/api/v1/y/alerts` | `alerts` | `threatintel.cyble.vision.alert` | `v1.0.0` |
| IOCs | Fetch IOCs and store in a Devo lookup | `/engine/api/v2/y/iocs` | `iocs` | Lookup starting with `cyble_vision_iocs` | `v1.0.0` |
For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/348258308).
## Minimum configuration required for basic pulling
Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.
> ℹ️ This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.
| **Setting** | **Details** |
| --- | --- |
| `api_key` | Token for authentication |
> ℹ️ See the **Accepted authentication methods** section to verify what settings are required based on the desired authentication method.
## Accepted authentication methods
The user must specify an Access Key ID and Secret ID for the account/RAM to authenticate with the ActionTrail API or Log Service API.
| **Setting** | **Details** |
| --- | --- |
| bearer token | Required |
## Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
> Macro (rw-ui-tabs-macro)
>
> > Macro (rw-tab)
>
> We use a piece of software called Collector Server to host and manage all our available collectors.
>
> To enable the collector for a customer:
>
> 1. In the Collector Server GUI, access the domain in which you want this instance to be created
> 2. Click Add Collector and find the one you wish to add.
> 3. In the Version field, select the latest value.
> 4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
> 5. In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.
> 6. In the Parameters section, establish the Collector Parameters as follows below:
>
> ### Editing JSON configuration
>
> ```
> {
> "global_overrides": {
> "debug": ""
> },
> "inputs": {
> "cyble_vision": {
> "id": "",
> "enabled": true,
> "override_base_url": ""
> "credentials": {
> "api_key": ""
> },
> "services": {
> "alerts": {
> "override_tag": "",
> "start_time_in_utc": ""
> },
> "iocs": {
> "override_base_lookup_name": "",
> "start_time_in_utc": ""
> }
> }
> }
> }
> }
>
> ```
>
> Please replace the placeholders with real world values following the description table below:
>
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `debug_status` | `bool` | Mandatory | true / false | If the value is `true`, the debug logging traces will be enabled when running the collector. If the value is `false`, only the info, warning, and error logging levels will be printed. |
> | `input_id_value` | `int` | Mandatory | Min Length 5 | Use this parameter to give a unique ID to this input service. This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision. |
> | `override_base_url_value` | `str` | Optional | Min length: 1 | Use this parameter to override the default base url value. (default value: [https://api.cyble.ai](https://api.cyble.ai)) |
> | `api_key_value` | `str` | Mandatory | Min length: 1 | The API Key (token) for authentication. |
> | `start_time_in_utc_value` | `str` | Mandatory | UTC datetime format: `%Y-%m-%dT%H:%M:%SZ (e.g., “2000-01-01T00:00:01Z”)` | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events. |
> | `override_lookup_name_value` | `str` | Optional | Min length: 3 | An optional lookup name to use for the IOCs lookup service. By default the collector uses `cyble_vision_iocs` |
> | `override_tag_value` | `str` | Optional | Min length: 4 | Custom devo tag value. |
>
>
>
> > ℹ️ Parameters marked as "Mandatory" are required for the collector's configuration. Optional parameters can be omitted or removed if not used, but they provide additional customization and control over the collector's behavior.
>
> > Macro (rw-tab)
>
> This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
>
> ### Structure
>
> The following directory structure should be created for being used when running the collector:
>
> ```
>
> └── devo-collectors/
> └── /
> ├── certs/
> │ ├── chain.crt
> │ ├── .key
> │ └── .crt
> ├── state/
> └── config/
> └── config.yaml
> ```
>
> > ⚠️ Replace `` with the proper value.
>
> ### Devo credentials
>
> In Devo, go to **Administration → Credentials → X.509 Certificates**, download the **Certificate**, **Private key** and **Chain CA** and save them in `/certs/`. Learn more about security credentials in Devo [here](#).
>
> 
>
> > ⚠️ Replace `` with the proper value.
>
> ### Editing the config.yaml file
>
> ```
> globals:
> debug: false
> id: not_used
> name: Cyble_Collector
> persistence:
> type: filesystem
> config:
> directory_name: state
> outputs:
> devo_us_1:
> type: devo_platform
> config:
> address:
> port: 443
> type: SSL
> chain:
> cert:
> key:
> inputs:
> cyble_vision:
> id:
> enabled: true
> override_base_url:
> credentials:
> api_key:
> services:
> alerts:
> override_tag:
> start_time_in_utc:
> obfuscation_data: []
> iocs:
> override_base_lookup_name:
> start_time_in_utc:
> ```
>
> All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
>
> Replace the placeholders with your required values following the description table below:
>
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `debug_status` | `bool` | `mandatory` | true / false | If the value is `true`, the debug logging traces will be enabled when running the collector. If the value is `false`, only the info, warning, and error logging levels will be printed. |
> | `devo_address` | `str` | `mandatory` | - collector-us.devo.io
> - collector-eu.devo.io | Use this parameter to identify the Devo Cloud where the events will be sent. |
> | `chain_filename` | `str` | `mandatory` | minimum length: 4 maximum length: 20 | Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: `chain.crt`. |
> | `cert_filename` | `str` | `mandatory` | minimum length: 4 maximum length: 20 | Use this parameter to identify the file.cert downloaded from your Devo domain. |
> | `key_filename` | `str` | `mandatory` | minimum length: 4 maximum length: 20 | Use this parameter to identify the file.key downloaded from your Devo domain. |
> | `start_time_in_utc_value` | `str` | `optional` | UTC datetime string having datetime string format `%-Y-%m-%d %H-%M-%S` (e.g., “`2000-01-01 00:00:01`”) | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events. > ℹ️ This parameter should be removed if it is not used. |
> | `obfuscation_data_values` | `array