Skip to main content

​
Enrolling Data Sources

Enrollment connects your existing data source to DataHarbor. Once enrolled, you can create multiple Virtual APIs from a single source.

​
Supported sources

Source TypeStatus
REST/JSON APIsAvailable
Azure FabricComing Soon
DatabricksComing Soon
SnowflakeComing Soon
BigQueryComing Soon

​
Enrolling a REST API

Enrollment is done through the DataHarbor dashboard. You provide two things:
  1. Base URL — the root URL of your upstream API
  2. Request Path Template — the path structure with parameter placeholders

​
Base URL

The base URL is the root of your API, without any path segments: 
https://api.yourcompany.com
DataHarbor uses this to connect to your upstream service and proxy requests through your Virtual APIs.

​
Request path template

The path template describes the full route structure of your API using {parameter} placeholders for dynamic segments: 
/customers/{customerId}/orders/{orderId}/items/{itemId}
DataHarbor uses this template to understand your API’s resource hierarchy. Each static segment (like customers, orders, items) becomes a matchable object name in your Virtual API spec.

​
Required parameters

Prefix a parameter with $ to mark it as required: 
/organizations/{$orgId}/users/{userId}
Required parameters must always be provided with a specific value — they cannot be omitted or wildcarded. Use this for parameters like tenant IDs that are always needed to scope requests correctly.

​
How templates map to objects

Given this path template: 
/properties/{propertyId}/inspections/{inspectionId}/issues/{issueId}
DataHarbor extracts three object names: properties, inspections, and issues. These are the names you reference in your Virtual API spec: 
objects:
  properties:
    filters:
      - target: 'ownerFirstName'
        filterType: REDACT
  inspections:
    filters:
      - target: 'inspectorName'
        filterType: REDACT
  issues:
    filters:
      - target: 'title'
        filterType: REDACT

​
Authentication

DataHarbor supports three authentication methods for connecting to your upstream API. Configure these in the dashboard when enrolling your source.
MethodDescription
PublicNo authentication required
API KeyKey sent in a request header
BasicUsername and password

​
Schema discovery

When you enroll a source, DataHarbor:
  1. Calls each endpoint to sample the response structure
  2. Learns the schema shape over time
  3. Detects net-new fields as they appear
  4. Flags potentially sensitive fields for review
Schema discovery runs automatically as requests flow through your Virtual APIs — the more your API is used, the more complete the schema becomes.

​
Next steps

Virtual APIs

Create Virtual APIs from your enrolled source

Schema Analytics

Monitor schema changes over time