---
title: Sgbox
slug: connectors/sgbox
docTags: 
createdAt: 2026-06-09T16:30:04.135Z
---

SGBox is a modular platform for controlling and managing ICT security. Its modular and distributed architecture means it can adapt to the various company needs. With SGBox, the user can create an aggregate display with all the information gathered from log collection, vulnerability scan and endpoint status.

## Prerequisites

The SGBox asset requires a `Host URL`, `Username`, `Password`, `API Key`.
SGBox REST API is hosted on port 4000. The `Host URL` should include the port number as well.

## Capabilities

This Connector supports the following capabilities:

- Get Events
- Get Logs
- Get Tenants

## Notes

- [https://www.sgbox.it/sgbox/EN/knowledge-base/sgbox-api/](https://www.sgbox.it/sgbox/EN/knowledge-base/sgbox-api/)

# Configurations

## Asset

Authenticates using SGBox credentials

### Configuration Parameters

| **Parameter** | **Description**                                             | **Type** | **Required** |
| ------------- | ----------------------------------------------------------- | -------- | ------------ |
| url           | A URL to the target host. SGBox API is hosted on port 4000. | string   | Required     |
| apikey        | API Key                                                     | string   | Required     |
| username      | Username                                                    | string   | Required     |
| password      | Password                                                    | string   | Required     |
| verify\_ssl   | Verify SSL certificate                                      | boolean  | Optional     |
| http\_proxy   | A proxy to route requests through.                          | string   | Optional     |

# Actions

## Get Events

Get Events for both Single Tenant and Multiple Tenants.

### Endpoint

- **URL:** `api/events`
- **Method:** `POST`

### Input

| **Argument Name** | **Type** | **Required** | **Description**          |
| ----------------- | -------- | ------------ | ------------------------ |
| `tenant`          | array    | Optional     | Parameter for Get Events |
| `tsstart`         | string   | Optional     | Parameter for Get Events |
| `tsend`           | string   | Optional     | Parameter for Get Events |
| `search`          | array    | Optional     | Parameter for Get Events |
| `search.paramid`  | string   | Optional     | Unique identifier        |
| `search.paramval` | string   | Optional     | Parameter for Get Events |
| `search.type`     | string   | Optional     | Type of the resource     |
| `multi_patternid` | object   | Optional     | Unique identifier        |
| `patternid`       | array    | Optional     | Unique identifier        |

### Input Example

`{"json_body":{"tenant":["tenant1","tenant2"],"tsstart":"20210818000000","tsend":"20230818235959","search":[{"paramid":"10433","paramval":".*admin","type":"regex"}],"multi_patternid":{},"patternid":["10958","10011"]}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Date":"Thu, 28 Sep 2023 09:37:21 GMT","Server":"Apache","Cache-Control":"no-cache, private","Content-Length":"6962","Keep-Alive":"timeout=5, max=100","Connection":"Keep-Alive","Content-Type":"application/json"},"reason":"OK","json_body":[{"uuid":"6442a5e2-1fe4-68de-d081-000000000000","ts":"20230711151320","hostid":1,"classid":0,"class_name":"SGBox Security Messages","patternid":11099,"pattern_name":"[SGBox] Logon Fail","host_name":"localhost","host_ip":"12...`

## Get Logs

To search and filter in the raw log.

### Endpoint

- **URL:** `api/logs`
- **Method:** `POST`

### Input

| **Argument Name** | **Type** | **Required** | **Description**        |
| ----------------- | -------- | ------------ | ---------------------- |
| `tsstart`         | string   | Optional     | Parameter for Get Logs |
| `tsend`           | string   | Optional     | Parameter for Get Logs |
| `limit`           | number   | Optional     | Parameter for Get Logs |
| `search`          | string   | Optional     | Parameter for Get Logs |
| `hostid`          | array    | Optional     | Unique identifier      |

### Input Example

`{"json_body":{"tsstart":"20200818000000","tsend":"20230818235959","limit":10,"search":"Auth","hostid":[55]}}`

## Get Tenants

Get Tenants from SGBox.

### Endpoint

- **URL:** `api/tenants`
- **Method:** `POST`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Date":"Wed, 27 Sep 2023 15:08:11 GMT","Server":"Apache","Cache-Control":"no-cache, private","Content-Length":"111","Keep-Alive":"timeout=5, max=100","Connection":"Keep-Alive","Content-Type":"application/json"},"reason":"OK","json_body":[{"id":"ddae270a642454f1cce98d4768ded081","name":"SGBox ddae270a642454f1cce98d4768ded081","remote_id":"sgbox"}]}`

# Response Headers

| **Header**     | **Description**                                          | **Example**                   |
| -------------- | -------------------------------------------------------- | ----------------------------- |
| Cache-Control  | Directives for caching mechanisms                        | no-cache, private             |
| Connection     | HTTP response header: Connection                         | Keep-Alive                    |
| Content-Length | The length of the response body in bytes                 | 6962                          |
| Content-Type   | The media type of the resource                           | application/json              |
| Date           | The date and time at which the message was originated    | Wed, 27 Sep 2023 15:08:11 GMT |
| Keep-Alive     | HTTP response header: Keep-Alive                         | timeout=5, max=100            |
| Server         | Information about the software used by the origin server | Apache                        |