API Reference
REST API. Well documented. Honest with you.
Every SOFI endpoint listed with method, path, description, and schema. JWT in Bearer header, httpOnly cookies in production, multi-tenant by default.
curlBase URL
https://api.sofi.ioUse Authorization: Bearer <token> on every request.
Authentication
JWT HS256: 15min access, 7-day refresh. Tokens in httpOnly cookies.
/api/v1/auth/loginAuthenticate via email/password
/api/v1/auth/refreshRenew access token
/api/v1/auth/logoutInvalidate session
/api/v1/auth/meCurrent authenticated user
Data sources
Register, configure, and test connections to production databases.
/api/v1/datasourcesList sources for the tenant
/api/v1/datasourcesRegister a new source
/api/v1/datasources/:idUpdate credentials
/api/v1/datasources/:id/testTest connection (15s timeout)
/api/v1/datasources/:idSoft-delete source
Virtual Databases
Provision, manage, and expire VDBs on shared cluster pools.
/api/v1/vdbsList VDBs for the tenant
/api/v1/vdbsProvision new VDB
/api/v1/vdbs/:idVDB details
/api/v1/vdbs/:id/refreshRe-apply masking + CDC
/api/v1/vdbs/:idDestroy VDB and free storage
Masking
Define rules, fire jobs, and inspect masking history.
/api/v1/masking/rulesCatalog of available rules
/api/v1/masking/jobsTrigger a masking job
/api/v1/masking/jobs/:idJob status and progress
/api/v1/masking/detectAutomatic PII detection
CDC
Continuous change streams via WAL, binlog, or LogMiner.
/api/v1/cdc/streamsList active streams
/api/v1/cdc/streamsCreate a new stream
/api/v1/cdc/streams/:id/pausePause replication
/api/v1/cdc/streams/:id/dlqRejected events (DLQ)
RBAC
Manage users, roles, and permissions inside the tenant.
/api/v1/usersList tenant users
/api/v1/users/inviteInvite user by email
/api/v1/rolesList roles (default + custom)
/api/v1/rolesCreate custom role