Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

Use this file to discover all available pages before exploring further.

The Tumban dashboard at platform.tumban.com exposes the same operations as the API. Every API page in this reference has a Using the dashboard section pointing back to the corresponding UI flow; this page is the map.

Layout

The dashboard has three primary regions:
  • Left sidebar — top-level navigation. Some items are admin-only.
  • Main area — the active page.
  • Sidebar footer — organization switcher, signed-in user info, sign-out button.
ItemWhat it coversAPI pages
HomeOverview dashboard with Needs your attention and Recent scans panels, plus stat tiles.List org scans, Get usage totals
ScanSubmit a single profile URL, view your local submission history (persisted in your browser).Create scan, Get scan
UsageBar chart and donut chart for scan throughput and recommendation distribution. Admin-only in the dashboard.Get scan timeseries, Get priority distribution, Get usage totals
API KeysCreate, list, and revoke API keys.Create API key, List API keys, Revoke API key
WebhooksSet the default callback URL and rotate the webhook secret.Update org settings, Rotate webhook secret
OrganisationManage members and organization profile. Admin-only — hidden for members.(Not exposed on the API.)

Organization switcher

If your account belongs to multiple organizations, the switcher in the bottom-left of the sidebar shows the active organization and lets you change it. All API requests and dashboard data are scoped to whichever organization is active.

Role-gated UI

Some controls are hidden or display an admin-only notice in the dashboard. The role enforcement on the underlying API endpoints is documented on each endpoint page.
ActionDashboardAPI
Create / list API keysMembers and adminsMembers and admins
Revoke API keyTrash icon visible to all members; the API rejects revocations a member is not authorized forMembers revoke their own keys; admins revoke any
Set default callback URLHidden for non-adminsAdmin-only
Rotate webhook secretHidden for non-adminsAdmin-only
View Usage pageMembers see “Admin only” noticeAPI itself is not role-gated; members can call directly
View Organisation pageHidden for non-admins(Not on the API.)

Sign-in

Sign in at platform.tumban.com with the credentials provided when your organization was onboarded. After signing in for the first time, your organization is provisioned automatically — the API endpoints become reachable as soon as the dashboard loads.