Getting Your Team on SpecVault in 10 Minutes
SpecVault is fully hosted — there's nothing to install or operate. Here's how to go from zero to your first breaking-change alert in about ten minutes.
Because SpecVault is a managed service, onboarding isn't about provisioning servers or configuring TLS — it's about getting your APIs registered and your consumer teams subscribed. The whole flow takes a few minutes.
Step 1 — Sign in
Go to specvault.sentinelflux.in and sign in. If your team doesn't have an account yet, request access at engage@sentinelflux.in. There's nothing to install — the dashboard runs in your browser.
Step 2 — Register your first service
From the dashboard, click New Service and give it a name (e.g. Payments API), an owning team, and a base URL. This is a one-time step per API. You'll land on the service detail page with an empty version history.
Step 3 — Publish a spec
Click Publish Spec and either paste a URL to your openapi.json / openapi.yaml or upload the file directly. SpecVault stores it, counts the endpoints, and — from the second version onward — diffs it against the previous one.
Step 4 — Add subscribers
On the service page, click Add Subscriber and enter the email of anyone on a consuming team. They don't need a SpecVault account — alerts go straight to their inbox. Add as many subscribers per service as you need.
Step 5 — Automate publishing from CI
Manual publishing is fine to start, but the real value comes from publishing on every build. Generate an API token from Settings → API Tokens and add a publish step to your pipeline:
curl -X POST \
"https://specvault.sentinelflux.in/api/services/$SPECVAULT_SERVICE_ID/specs" \
-H "Authorization: Bearer $SPECVAULT_TOKEN" \
-H "Content-Type: application/json" \
-d '{"spec_url": "https://api.yourcompany.com/openapi.json"}'
Store the token and service ID as CI secrets. Your runner only needs outbound HTTPS access to specvault.sentinelflux.in. See the GitHub Actions guide for a complete workflow.
What you don't have to do
Because SpecVault is hosted, there are no servers to size, no Docker images to build, no TLS certificates to renew, and no databases to back up. We handle hosting, upgrades, and backups — your team just registers services and publishes specs.
Where to go next
- Quick Start — the same flow with more detail
- Breaking Changes — exactly what SpecVault flags and why
- Hosting & Security — how the service is run and secured