Dapi Service

Dapi is the public gateway for WDS. It exposes the REST API, Swagger UI, and MCP server; persists job configurations; routes work to the backend services; propagates feature flags; and coordinates tenant cleanup.

Release image: webdatasource/dapi:v3.0.0

Configuration

Name Required Default Meaning
MONGODB_CONNECTION_STRING Yes None MongoDB connection string for Dapi state. Include a database name unless MONGODB_DATABASE_NAME is set.
MONGODB_DATABASE_NAME No Database from the connection string Overrides the MongoDB database name.
DATAKEEPER_ORIGIN Yes None Origin of Datakeeper; Dapi appends port 8082 for gRPC-Web.
SCRAPER_ORIGIN Yes None Origin of Scraper; Dapi appends port 8082 for gRPC-Web.
IDEALER_ORIGIN Yes None Origin of Idealer; Dapi appends port 8082 for gRPC-Web.
JOBER_ORIGIN Yes None Origin of Jober; Dapi appends port 8082 for gRPC-Web.
RETRIEVER_ORIGIN Yes None Origin of Retriever; Dapi appends port 8082 for gRPC-Web.
JOB_TYPES Yes None Available job types, supplied as a comma-separated value.
TASKS_GET_RESULT_RETRY_DELAY_MS No 1000 Delay in milliseconds between attempts to obtain a downstream task result.
FEATURE_FLAG_RETRIEVAL_ENABLED No false Enables the Retrieval surface before license checks are applied.
FEATURE_FLAG_SCHEDULING_ENABLED No false Enables the Scheduling surface before license checks are applied.
LICENSE_KEY Yes None WDS license key. See Plans.
BASE_PATH No Root path Path base when Dapi is hosted under a reverse-proxy subpath.
GLOBAL_EXCEPTION_RESPONSE_DELAY_MS No 1000 Delay in milliseconds before returning an unhandled-error response.
HEALTH_PROBE_LOG_LEVEL No Debug Log level used for /health and /ready request messages.
MIN_LOG_LEVEL No Info Minimum application log level.

Endpoints and dependencies

Port 8080 serves the REST API, /api/swagger, /api/swagger/swagger.json, /mcp, /health, and /ready. Port 8082 serves Dapi gRPC-Web over HTTP/1.1. Dapi uses MongoDB and connects to Datakeeper, Scraper, Idealer, Jober, and Retriever over gRPC-Web.

JobTypes

Supported job execution environments. Dapi or Solidstack restricts the allowed values through JOB_TYPES; Crawler or Solidstack must also advertise a matching address configuration.

Name Description
internet Crawl data from internet sources via request gateways (Proxy addresses, Host IP addresses, etc.)
intranet Crawl data from intranet sources with no limits

Please rotate your device to landscape mode

This documentation is specifically designed with a wider layout to provide a better reading experience for code examples, tables, and diagrams.
Rotating your device horizontally ensures you can see everything clearly without excessive scrolling or resizing.

Return to Web Data Source Home