DFS API Surface
Use this page as a quick endpoint map when planning integrations, tests, or automation around DFS. Keep the deployment's API specification as the source for exact request and response fields.
Access assumptions
API access depends on tenant access, RBAC permissions, package gates, and deployment configuration.
Confirm:
- authentication method;
- tenant scope;
dfs:read,dfs:write, ordfs:deletepermissions;- DFS Pro package access for governance workflows;
- BI permissions for report APIs.
DFS Lite connector APIs
| Area | Endpoint family | Use |
|---|---|---|
| Connectors | /api/v1/dfslite/connectors | Create, list, update, delete, test, start, stop, and sync connectors. |
| Connector mappings | /api/v1/dfslite/connectors/{id}/mappings | Create and manage mapping rules for a connector. |
| Source browse | /api/v1/dfslite/connectors/{id}/browse | Inspect source hierarchy or available fields. |
| Source preview | /api/v1/dfslite/connectors/{id}/preview | Preview source values before mapping or sync. |
| Sync logs | /api/v1/dfslite/connectors/{id}/sync-logs | Review connector run history. |
| Quality | /api/v1/dfslite/quality | Review quality metrics and quality trends. |
| Metrics | /api/v1/dfslite/metrics | Review operational health across Lite and Pro workflows. |
DFS Pro dataset APIs
| Area | Endpoint family | Use |
|---|---|---|
| Datasets | /api/v1/dfslite/datasets | Create, list, update, and delete governed datasets. |
| Dataset stats | /api/v1/dfslite/datasets/stats | Review dataset totals. |
| Validate | /api/v1/dfslite/datasets/{id}/validate | Mark a dataset as validated after review. |
| Deprecate | /api/v1/dfslite/datasets/{id}/deprecate | Mark a dataset as deprecated. |
| Steward | /api/v1/dfslite/datasets/{id}/steward | Assign a dataset steward. |
| Versions | /api/v1/dfslite/datasets/{id}/versions | Review dataset version history. |
| Lineage | /api/v1/dfslite/datasets/{id}/lineage | Review upstream and downstream relationships. |
| Change impact | /api/v1/dfslite/datasets/{id}/change-impact | Compare version impact for downstream review. |
| Preview | /api/v1/dfslite/datasets/{id}/preview | Preview dataset rows. |
| Profile | /api/v1/dfslite/datasets/{id}/profile | Compute or review column profile. |
Method Library APIs
| Area | Endpoint family | Use |
|---|---|---|
| Methods | /api/v1/dfslite/methods | Create, list, update, and delete methods. |
| Publish | /api/v1/dfslite/methods/{id}/publish | Publish a method after review. |
| New version | /api/v1/dfslite/methods/{id}/new-version | Create a new method version. |
| Test | /api/v1/dfslite/methods/{id}/test | Test method behavior with sample input. |
| Usage | /api/v1/dfslite/methods/{id}/usage | Review where a method is used. |
| Performance | /api/v1/dfslite/methods/{id}/performance | Review method execution performance. |
Fusion, review, and rejection APIs
| Area | Endpoint family | Use |
|---|---|---|
| Fusion tasks | /api/v1/dfslite/fusion-tasks | Create, run, retry, cancel, and inspect fusion tasks. |
| Fusion runs | /api/v1/dfslite/fusion-tasks/{id}/runs | Review run history. |
| Review queue | /api/v1/dfslite/review/items | List and inspect human review items. |
| Review actions | /api/v1/dfslite/review/items/{id}/actions | Review action history. |
| Assign review | /api/v1/dfslite/review/items/{id}/assign | Assign review owner. |
| Approve review | /api/v1/dfslite/review/items/{id}/approve | Approve a reviewed item. |
| Reject review | /api/v1/dfslite/review/items/{id}/reject | Reject a reviewed item. |
| Manual resolve | /api/v1/dfslite/review/items/{id}/manual-resolve | Resolve an item with reviewer decision. |
| Rejection queue | /api/v1/dfslite/rejection-queue | List and inspect rejected source rows. |
| Acknowledge | /api/v1/dfslite/rejection-queue/{id}/acknowledge | Acknowledge a rejected row. |
| Fixed in source | /api/v1/dfslite/rejection-queue/{id}/fixed-in-source | Mark a row as fixed upstream. |
| Reprocess | /api/v1/dfslite/rejection-queue/{id}/reprocess | Reprocess a rejected row using source reread. |
Governance pipeline APIs
| Area | Endpoint family | Use |
|---|---|---|
| Pipelines | /api/v1/dfslite/pipelines | Create, list, update, and delete governance pipelines. |
| Pipeline runs | /api/v1/dfslite/pipelines/{id}/runs | Review run history. |
| Run steps | /api/v1/dfslite/pipelines/{id}/runs/{runId}/steps | Inspect node-level execution logs. |
| Validate | /api/v1/dfslite/pipelines/{id}/validate | Validate the pipeline. |
| Execute | /api/v1/dfslite/pipelines/{id}/execute | Run the pipeline. |
Audit API
| Area | Endpoint family | Use |
|---|---|---|
| Audit log | /api/v1/dfslite/audit/log | Filter audit entries by entity type, entity ID, action, and paging. |
DFS Pro BI APIs
| Area | Endpoint family | Use |
|---|---|---|
| Reports | /api/v1/bi/reports | Create, list, update, publish, archive, duplicate, and delete reports. |
| Report folders | /api/v1/bi/folders | Organize reports. |
| Report versions | /api/v1/bi/reports/{id}/versions | Review and restore report versions. |
| BI datasets | /api/v1/bi/datasets | List datasets available to BI. |
| Dataset query | /api/v1/bi/datasets/{id}/query | Query a dataset for report rendering. |
| Dataset preview | /api/v1/bi/datasets/{id}/query/preview | Preview a dataset query. |
| Render report | /api/v1/bi/reports/{id}/render | Render report widgets. |
| Refresh channels | /api/v1/bi/reports/{id}/refresh-channels | Get refresh configuration. |
| Export widget | /api/v1/bi/widgets/{widgetId}/export/csv | Export widget data. |
| Export report | /api/v1/bi/reports/{id}/export/xlsx and /api/v1/bi/reports/{id}/export/pdf | Export report output. |
| Embed token | /api/v1/bi/reports/{id}/embed-token | Issue embed token. |
| Embed render | /api/v1/bi/embed/{token}/render | Render report through embed token. |
| Schedules | /api/v1/bi/schedules | Create, update, delete, run, and inspect schedules. |
Integration checklist
Before building an integration:
- confirm tenant and permission model;
- identify source and target workflows;
- use stable IDs as primary references;
- validate mappings in the UI before automating changes;
- store connector credentials through approved secrets handling;
- record audit evidence for write actions;
- test with a small dataset before increasing scope.
Next step
Use Permissions to confirm access before calling these APIs.