Skip to main content

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, or dfs:delete permissions;
  • DFS Pro package access for governance workflows;
  • BI permissions for report APIs.

DFS Lite connector APIs

AreaEndpoint familyUse
Connectors/api/v1/dfslite/connectorsCreate, list, update, delete, test, start, stop, and sync connectors.
Connector mappings/api/v1/dfslite/connectors/{id}/mappingsCreate and manage mapping rules for a connector.
Source browse/api/v1/dfslite/connectors/{id}/browseInspect source hierarchy or available fields.
Source preview/api/v1/dfslite/connectors/{id}/previewPreview source values before mapping or sync.
Sync logs/api/v1/dfslite/connectors/{id}/sync-logsReview connector run history.
Quality/api/v1/dfslite/qualityReview quality metrics and quality trends.
Metrics/api/v1/dfslite/metricsReview operational health across Lite and Pro workflows.

DFS Pro dataset APIs

AreaEndpoint familyUse
Datasets/api/v1/dfslite/datasetsCreate, list, update, and delete governed datasets.
Dataset stats/api/v1/dfslite/datasets/statsReview dataset totals.
Validate/api/v1/dfslite/datasets/{id}/validateMark a dataset as validated after review.
Deprecate/api/v1/dfslite/datasets/{id}/deprecateMark a dataset as deprecated.
Steward/api/v1/dfslite/datasets/{id}/stewardAssign a dataset steward.
Versions/api/v1/dfslite/datasets/{id}/versionsReview dataset version history.
Lineage/api/v1/dfslite/datasets/{id}/lineageReview upstream and downstream relationships.
Change impact/api/v1/dfslite/datasets/{id}/change-impactCompare version impact for downstream review.
Preview/api/v1/dfslite/datasets/{id}/previewPreview dataset rows.
Profile/api/v1/dfslite/datasets/{id}/profileCompute or review column profile.

Method Library APIs

AreaEndpoint familyUse
Methods/api/v1/dfslite/methodsCreate, list, update, and delete methods.
Publish/api/v1/dfslite/methods/{id}/publishPublish a method after review.
New version/api/v1/dfslite/methods/{id}/new-versionCreate a new method version.
Test/api/v1/dfslite/methods/{id}/testTest method behavior with sample input.
Usage/api/v1/dfslite/methods/{id}/usageReview where a method is used.
Performance/api/v1/dfslite/methods/{id}/performanceReview method execution performance.

Fusion, review, and rejection APIs

AreaEndpoint familyUse
Fusion tasks/api/v1/dfslite/fusion-tasksCreate, run, retry, cancel, and inspect fusion tasks.
Fusion runs/api/v1/dfslite/fusion-tasks/{id}/runsReview run history.
Review queue/api/v1/dfslite/review/itemsList and inspect human review items.
Review actions/api/v1/dfslite/review/items/{id}/actionsReview action history.
Assign review/api/v1/dfslite/review/items/{id}/assignAssign review owner.
Approve review/api/v1/dfslite/review/items/{id}/approveApprove a reviewed item.
Reject review/api/v1/dfslite/review/items/{id}/rejectReject a reviewed item.
Manual resolve/api/v1/dfslite/review/items/{id}/manual-resolveResolve an item with reviewer decision.
Rejection queue/api/v1/dfslite/rejection-queueList and inspect rejected source rows.
Acknowledge/api/v1/dfslite/rejection-queue/{id}/acknowledgeAcknowledge a rejected row.
Fixed in source/api/v1/dfslite/rejection-queue/{id}/fixed-in-sourceMark a row as fixed upstream.
Reprocess/api/v1/dfslite/rejection-queue/{id}/reprocessReprocess a rejected row using source reread.

Governance pipeline APIs

AreaEndpoint familyUse
Pipelines/api/v1/dfslite/pipelinesCreate, list, update, and delete governance pipelines.
Pipeline runs/api/v1/dfslite/pipelines/{id}/runsReview run history.
Run steps/api/v1/dfslite/pipelines/{id}/runs/{runId}/stepsInspect node-level execution logs.
Validate/api/v1/dfslite/pipelines/{id}/validateValidate the pipeline.
Execute/api/v1/dfslite/pipelines/{id}/executeRun the pipeline.

Audit API

AreaEndpoint familyUse
Audit log/api/v1/dfslite/audit/logFilter audit entries by entity type, entity ID, action, and paging.

DFS Pro BI APIs

AreaEndpoint familyUse
Reports/api/v1/bi/reportsCreate, list, update, publish, archive, duplicate, and delete reports.
Report folders/api/v1/bi/foldersOrganize reports.
Report versions/api/v1/bi/reports/{id}/versionsReview and restore report versions.
BI datasets/api/v1/bi/datasetsList datasets available to BI.
Dataset query/api/v1/bi/datasets/{id}/queryQuery a dataset for report rendering.
Dataset preview/api/v1/bi/datasets/{id}/query/previewPreview a dataset query.
Render report/api/v1/bi/reports/{id}/renderRender report widgets.
Refresh channels/api/v1/bi/reports/{id}/refresh-channelsGet refresh configuration.
Export widget/api/v1/bi/widgets/{widgetId}/export/csvExport widget data.
Export report/api/v1/bi/reports/{id}/export/xlsx and /api/v1/bi/reports/{id}/export/pdfExport report output.
Embed token/api/v1/bi/reports/{id}/embed-tokenIssue embed token.
Embed render/api/v1/bi/embed/{token}/renderRender report through embed token.
Schedules/api/v1/bi/schedulesCreate, 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.