BoxFetcher

Box fetcher (box://) for filesystem-like traversal and content download through Box APIs.

crawler/fsJavadoc: BoxFetcher

Notes

Fetches documents from Box using stable ID-based references.

Supported scheme:

• box://{enterpriseId}/folders/{folderId}
• box://{enterpriseId}/folders/{folderId}/items/{itemId}

V1 authentication is bearer-token based.

Incremental source-delta mode:

• Box SOURCE_DELTA support is not implemented in v1.
• In incremental crawls, Box currently relies on standard crawler-side scan semantics (changeDiscovery: CRAWLER_SCAN).

Examples

The following example starts from the Box root folder boundary.

YAML

class: BoxFetcher
accessToken: <token>
apiBaseUrl: https://api.box.com/2.0

JSON

{
  "class": "BoxFetcher",
  "accessToken": "<token>",
  "apiBaseUrl": "https://api.box.com/2.0"
}

XML

<class>BoxFetcher</class>
<accessToken>&lt;token&gt;</accessToken>
<apiBaseUrl>https://api.box.com/2.0</apiBaseUrl>

Use a start reference such as:

box://my-enterprise/folders/0

Usage

Full configuration skeleton, with every option and its default

YAML

class: BoxFetcher
accessToken: string
apiBaseUrl: string
notFoundStatusCodes:
  - 0
referenceFilters: []
validStatusCodes:
  - 0

JSON

{
  "class": "BoxFetcher",
  "accessToken": "string",
  "apiBaseUrl": "string",
  "notFoundStatusCodes": [
    0
  ],
  "referenceFilters": [],
  "validStatusCodes": [
    0
  ]
}

XML

<boxFetcher>
  <class>BoxFetcher</class>
  <accessToken>string</accessToken>
  <apiBaseUrl>string</apiBaseUrl>
  <notFoundStatusCodes>
    <notFoundStatusCode>0</notFoundStatusCode>
  </notFoundStatusCodes>
  <referenceFilters>
    <referenceFilter/>
  </referenceFilters>
  <validStatusCodes>
    <validStatusCode>0</validStatusCode>
  </validStatusCodes>
</boxFetcher>

Properties

Property	Type	Required	Default
accessToken	string	No	-
apiBaseUrl	string	No	https://api.box.com/2.0
notFoundStatusCodes	integer[]	No	[404]
referenceFilters	ReferenceFilter[]	No	-
validStatusCodes	integer[]	No	[200, 201, 202, 204]

Property Details

accessToken

OAuth access token used for Box API requests.

apiBaseUrl

Box API base URL.

Default: https://api.box.com/2.0

notFoundStatusCodes

HTTP status codes treated as "not found" outcomes. Defaults to 404.

referenceFilters

Filters applied to document references (URLs or file paths) to control which ones are fetched. Documents whose references do not pass the filters are skipped.

validStatusCodes

HTTP status codes treated as successful API responses. Defaults to 200, 201, 202, and 204.