Skip to content
DataRecs Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quickstart
Concepts
Workspaces
Connections
Reconciliation Jobs
Data Types, Filtering & Comparison
Supported Sources
Security & Data Residency
Guides
Creating a Connection
Connecting to Snowflake
Running a Reconciliation
Configuring a Reconciliation Job
Scheduling with the Built-in Scheduler
Temporal Handling
Managing API Keys
Connect DataRecs to AI tools (MCP)
Limits & Quotas
SSO Setup
Connection Health & Stale Connections
Using Webhooks
Customising Webhook Payloads
Scheduling with Airflow
Bring Your Own Key (BYOK)
Bring Your Own Storage (BYOS)
Errors & Troubleshooting
Events
Reconciliation Run Lifecycle Events
CLI Reference
CLI Overview
Terraform Provider
Terraform Provider
Reference
Support
Changelog & Versioning
REST API
REST API Overview
API Reference (generated)
Overview
ApiKeys
ApiKeysController_findAll
ApiKeysController_update
ApiKeysController_create
ApiKeysController_remove
ApiKeysController_findOne
audit-log
List audit log events
Authentication
AuthenticationController_handleCallback
AuthenticationController_getAuthConfig
AuthenticationController_resolveTenant
AuthenticationController_discoverTenants
AuthenticationController_getCurrentUser
AuthenticationController_login
AuthenticationController_refreshToken
AuthenticationController_logout
AuthenticationController_ssoLogin
AuthenticationController_ssoCallback
billing
Current-period usage vs entitlements for the calling tenant
connections
Get all connections
Create new connection
List connection reservations for the current tenant
Get connection by ID
Update connection
Delete connection
Get real usage statistics for a connection (jobs using it, run counts, recent runs)
Test connection credentials
Get databases for connection
Get schemas for a database connection
Get tables for a generic connection
Get columns for a generic connection
Get Microsoft admin consent URL for Excel/SharePoint
Handle Microsoft admin consent callback (browser redirect)
List SharePoint sites granted to the platform app
Groups
GroupsController_listGroups
GroupsController_createGroup
GroupsController_getGroup
GroupsController_updateGroup
GroupsController_deleteGroup
GroupsController_listMembers
GroupsController_addMember
GroupsController_removeMember
jobs
List all jobs
Create a new job
Get a job by ID
Delete a job
Update a job
job-runs
Trigger a job run
List runs for a job
Get a job run by ID
Cancel a running job
Get events for a job run
List recent runs across the workspaces the caller can access
job-results
Per-stage results summary for a job run
One page of the bounded mismatch sample for a stage
Download the full comparison result for a stage (parquet or CSV)
job-groups
List all job groups
Create a new job group
Get a job group by ID
Delete a job group
Update a job group
job-schedules
List schedules for a job
Create a schedule for a job
Delete a schedule
Update a schedule
Permissions
PermissionsController_listPermissions
Roles
RolesController_listPlatformRoles
RolesController_listCustomRoles
RolesController_updateCustomRole
RolesController_createCustomRole
RolesController_getCustomRole
RolesController_deleteCustomRole
RolesController_getRoleAssignments
Users
UsersController_listUsers
UsersController_inviteUser
UsersController_listInvitations
UsersController_cancelInvitation
UsersController_listRequests
UsersController_approveRequest
UsersController_denyRequest
UsersController_getStats
UsersController_validateImpersonation
UsersController_getUserPermissions
UsersController_updateBypassSso
UsersController_resetIdentity
UsersController_archiveUser
webhook-deliveries
List webhook deliveries
Bulk replay matching webhook deliveries
Get webhook delivery with attempts
Retry a failed webhook delivery
webhook-endpoints
List all webhook endpoints
Create a new webhook endpoint
Get webhook endpoint by ID
Update a webhook endpoint
Delete a webhook endpoint and all its subscriptions
List the templating variables (and example values) available to this endpoint
Render a payload template against a canonical sample event (preview pane)
Rotate the signing secret for a webhook endpoint
List configured secret-variable names (and setAt) for an endpoint. Never returns values.
Set or rotate a single secret variable (write-only). Returns the resulting name list, never values.
Delete a secret variable. 409 if a stored template still references it.
webhook-test
Emit a test webhook event for the caller’s tenant and report the publish result
webhook-event-types
List all subscribable event types grouped by domain
webhook-subscriptions
List webhook subscriptions
Create a new webhook subscription
Get webhook subscription by ID
Update a webhook subscription
Delete a webhook subscription
Workspaces
WorkspacesController_findAll
WorkspacesController_update
WorkspacesController_create
WorkspacesController_remove
WorkspacesController_findOne
EmailSettings
EmailSettingsController_getSettings
EmailSettingsController_updateSettings
EmailRecipientRules
EmailRecipientRulesController_list
EmailRecipientRulesController_create
EmailRecipientRulesController_delete
tenant-encryption
Get tenant encryption configuration
Configure BYOK encryption and trigger migration
Test access to a BYOK KMS key before saving configuration
Get BYOK migration status
Get detailed migration progress with step-level status
Trigger BYOK forward migration
Revert to platform-managed encryption
oidc-connectors
List all OIDC connectors
Create OIDC connector
Get OIDC connector by ID
Delete OIDC connector (soft-delete)
Update OIDC connector
oidc-token-exchange
Exchange an external OIDC token for a DataRecs Connector_Token
data-storage
Get current storage configuration
Configure BYOS storage settings
Test access to the configured BYOS bucket
Trigger BYOS forward migration
Revert to platform-managed storage
Get BYOS migration status
Get BYOS migration live progress (objects copied, bytes transferred, phase)
Operator: force-release a stuck or expired storage migration lock
DeviceAuth
DeviceAuthController_requestDeviceCode
DeviceAuthController_pollForToken
DeviceAuthController_verifyDeviceCode
DeviceAuthController_refreshCliTokens
DeviceAuthController_listSessions
DeviceAuthController_revokeSession
sso
Get active SSO connection for the tenant
Create SSO connection for the tenant
Soft-delete SSO connection for the tenant
Update SSO connection for the tenant
Enable SCIM provisioning and mint the SCIM bearer token (shown once)
Disable SCIM provisioning and revoke existing SCIM tokens
Rotate SCIM bearer token for the tenant SSO connection
Initiate a dry-run SSO login to validate the OIDC configuration
Migrate tenant from WorkOS to custom SSO
Get the latest SSO migration status for the tenant
Revert tenant from custom SSO back to WorkOS
Scim
ScimController_listUsers
ScimController_createUser
ScimController_getUser
ScimController_replaceUser
ScimController_deleteUser
ScimController_patchUser
ScimController_listGroups
ScimController_createGroup
ScimController_getGroup
ScimController_deleteGroup
ScimController_patchGroup
ScimController_getServiceProviderConfig
ScimController_getResourceTypes
ScimController_getSchemas
GitHub
Select theme
Dark
Light
Auto
RolesController_listPlatformRoles
GET
/roles/platform
Responses
Section titled “ Responses ”
200
Section titled “200 ”
