Skip to main content
Sumo Logic

Box Source

The Box API integration ingests events from the Get Events API.

The Box API integration ingests events from the Get Events API. It securely stores the required authentication, scheduling, and state tracking information.

Rules

  • JSON is the only supported log format
  • Data is collected in five minute intervals.

Authentication

You'll need a Box App Key, App Secret, and Access Code to provide to Sumo Logic.

The following steps must be followed to get the credentials:

  1. Login into the Box Account.

  2. Create and register a new app from the App Console. To register the App with Box follow these steps.

  3. Generate public private key pair as described in the following steps Key Pair and download the JSON file.

  4. Go to the Configuration and change App Access Level to App + Enterprise Access and enable Manage Enterprise properties in Application Scopes and save changes as shown below.

    clipboard_e61540defb8d4d33f8ca2a8c3eadde494.png
    clipboard_e2dfc77277d64dd16d4e8ec650f950809.png
    clipboard_e79ee2d5a3a68c279de8d87b699bf0107.png

  5. Authorize your app by following these steps Authorize.

States

A Box Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A Box Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Box.
  5. Collecting: The Source is actively collecting data from Box.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. 

clipboard_e0737d3e3c532412fe3d3d3204d9bc3a6.png

You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

hover c2c error.png

Hover your mouse over the status icon to view a tooltip with details on the detected issue.

health error generic.png

Create a BOX Source

When you create a Box Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Create a Hosted Collector.

To configure a Box Source:

  1. In the Sumo Logic web app, navigate to Manage Data > Collection and open the Collection tab. 
  2. On the Collectors page, click Add Source next to a Hosted Collector.
  3. Select Box.
    clipboard_ef2eec21432dc4b695ce7a6fed146b49e.png
  4. Enter a Name for the Source. The description is optional.
    clipboard_ea0785f267775582602e2b75f719a84d7.png
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise.
    forward-siem.png
    When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor Box
_siemProduct Enterprise Events
_siemFormat JSON
_siemEventID {event_type}
  1. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a checkmark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
  2. Upload the JSON file.

  3. Processing Rules. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
  4. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which it quits. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which it quits. FirstPartyGenericError

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"Box"} for a Box Source. not modifiable
sourceType String Yes Use Universal for a Box Source. not modifiable

The following table shows the config parameters for a Box Source.

Parameter Type Required Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
credentialsJson String Yes   Its the authentication credentials to access Box platform. modifiable

Box Source JSON example:

{
  "api.version":"v1",
  "source":{
    "schemaRef":{
      "type":"Box"
    },
    "config":{
      "name":"box-test-1",
      "fields":{
        "_siemForward":false
      },
      "credentialsJson":"********"
    },
    "state":{
      "state":"Collecting"
    },
    "sourceType":"Universal"
  }
}