# Routebase Documentation

> Documentation for Routebase — the API lifecycle platform for design, testing, mock servers, monitoring, security testing, and developer portals.

## Docs

- [Alert Policies](https://docs.routebase.dev/alert-policies/): Define alert rules once and assign them across whole environments, API specs or individual monitors.
- [API Design Settings](https://docs.routebase.dev/api-design-settings/): Configure the API Designer at three levels, from personal editor preferences to project defaults and organization-wide rules.
- [API Keys](https://docs.routebase.dev/api-keys/): Create API keys so CI/CD pipelines, the CLI and AI agents reach your organization without a browser login.
- [API Specifications — MCP Tools](https://docs.routebase.dev/api-specifications-mcp-tools/): Create, read, update and delete API specifications.
- [Audit Log](https://docs.routebase.dev/audit-log/): Review a chronological record of security-relevant activity, covering sign-ins, role changes and revealed secrets.
- [Auth Configuration — MCP Tools](https://docs.routebase.dev/auth-configuration-mcp-tools/): Auth configurations for test environments (org defaults and per-environment).
- [Billing & Plans](https://docs.routebase.dev/billing/): See how your plan sets limits across projects, specifications, test runs and mock requests, and how to change it.
- [Branches & Merge Requests — MCP Tools](https://docs.routebase.dev/branches-merge-requests-mcp-tools/): Spec branches, clones and merge requests.
- [Branching](https://docs.routebase.dev/branching/): Work on a larger spec change in a branch, have a colleague review it, and merge it back when it is ready.
- [CLI in CI/CD](https://docs.routebase.dev/cli-in-cicd/): Run test suites and security scans from your pipeline, and read the exit codes that decide whether a build fails.
- [CLI Overview](https://docs.routebase.dev/cli-overview/): Install the command-line client, authenticate it, and learn the commands it offers for tests, scans and docs.
- [Components](https://docs.routebase.dev/components/): Define reusable responses, request bodies, parameters and headers once per specification and reference them from every endpoint.
- [Context & Session — MCP Tools](https://docs.routebase.dev/context-session-mcp-tools/): Session context, organizations, projects and toolset management.
- [Contract Drift](https://docs.routebase.dev/contract-drift/): Detect when production quietly starts returning something your specification no longer promises.
- [Contract Testing](https://docs.routebase.dev/contract-testing/): Prove that your running API still matches the specification you designed, not only that it answers at all.
- [Coverage](https://docs.routebase.dev/coverage/): Track the share of a specification's endpoints that have a monitor, so new endpoints do not go unwatched.
- [Custom Domains](https://docs.routebase.dev/custom-domains/): Verify an email domain for your organization and serve your documentation portal from a domain of your own.
- [Dashboard](https://docs.routebase.dev/dashboard/): See the health of every project in one place, covering failing suites, drifting contracts and open incidents.
- [Data-Driven Tests](https://docs.routebase.dev/data-driven-tests/): Run a whole test suite once per row of a test data set instead of duplicating the same case per account.
- [Deprecation](https://docs.routebase.dev/deprecation/): Mark an endpoint as deprecated with a sunset date, so everyone reading your documentation sees what is going away and by when.
- [Deprecation — MCP Tools](https://docs.routebase.dev/deprecation-mcp-tools/): Deprecation lifecycle for endpoints, schemas and versions.
- [Desktop App](https://docs.routebase.dev/desktop-app/): Install the macOS or Windows app for native notifications, real save dialogs and sessions in the credential store.
- [Diagrams](https://docs.routebase.dev/diagrams/): Write Mermaid diagrams anywhere in your documentation and have them rendered in your portal's own colors and fonts.
- [Authoring Pages](https://docs.routebase.dev/doc-authoring/): Write documentation pages in a block editor with Markdown support, slash commands and real-time collaboration.
- [Portal Branding](https://docs.routebase.dev/doc-branding/): Set the theme, brand colors, fonts, logo and custom CSS of your published documentation portal.
- [Changelog Pages](https://docs.routebase.dev/doc-changelog/): Generate a changelog page from the differences between two published specification versions.
- [Documentation Overview](https://docs.routebase.dev/doc-overview/): Organize pages, folders and API references into one versioned documentation portal per project.
- [Publishing the Portal](https://docs.routebase.dev/doc-publishing/): Publish a documentation version, then build it into the static portal your readers reach.
- [Docs as Code](https://docs.routebase.dev/docs-as-code/): Pull a documentation version into Markdown files, edit them in your repository and push the changes back.
- [Page Templates](https://docs.routebase.dev/doc-templates/): Start a new documentation page from a built-in or organization template that gives it a proven structure.
- [Documentation — MCP Tools](https://docs.routebase.dev/documentation-mcp-tools/): Doc hub pages, tree, versions, snapshots and snippets.
- [Documentation Versioning](https://docs.routebase.dev/doc-versioning/): Keep an independent copy of the content tree per documentation version, so readers see the current release while you rework the next.
- [Endpoints](https://docs.routebase.dev/endpoints/): Create and document endpoints, which pair an HTTP method with a path and describe the parameters, request body and responses.
- [Endpoints — MCP Tools](https://docs.routebase.dev/endpoints-mcp-tools/): Endpoints with parameters, request bodies, responses and security.
- [Environments](https://docs.routebase.dev/environments/): Model the stages your API runs through, each with its own base URL, variables and authentication.
- [Folders — MCP Tools](https://docs.routebase.dev/folders-mcp-tools/): Folders that organize endpoints within a spec.
- [Getting Started](https://docs.routebase.dev/getting-started/): Go from sign-up to your first documented endpoint, covering your workspace, your first project and your first specification.
- [Global Search](https://docs.routebase.dev/global-search/): Find projects, endpoints, schemas, test suites, mock rules and pages across every project from one command palette.
- [Google Workspace SSO Setup](https://docs.routebase.dev/google-workspace-sso-setup/): Connect Google Workspace to Routebase with SAML 2.0, one step at a time.
- [Governance — MCP Tools](https://docs.routebase.dev/governance-mcp-tools/): Spec validation, score weights, custom rules and severities.
- [Header Components — MCP Tools](https://docs.routebase.dev/header-components-mcp-tools/): Reusable header components on org, project and spec level.
- [Header Policies](https://docs.routebase.dev/header-policies/): Apply reusable response headers to every response whose status code matches, so header sets stay consistent across your APIs.
- [Header Policies — MCP Tools](https://docs.routebase.dev/header-policies-mcp-tools/): Header policies on org, project and spec level.
- [Import & Export](https://docs.routebase.dev/import-export/): Import OpenAPI files and Postman or Insomnia collections, and export your specification back out as OpenAPI.
- [Incidents](https://docs.routebase.dev/incidents/): Track a failing monitor as an incident with its cause, its duration and a timeline of what happened.
- [Integrations](https://docs.routebase.dev/integrations/): Connect Routebase to the rest of your toolchain through webhooks, chat alerts, the CLI, MCP and the REST API.
- [Lifecycle Walkthrough](https://docs.routebase.dev/lifecycle-walkthrough/): Follow one small API through design, mocking, testing, documentation and monitoring to see where the pieces meet.
- [Maintenance Windows](https://docs.routebase.dev/maintenance-windows/): Suppress monitoring alarms during planned work, so expected downtime does not page anyone.
- [MCP Authentication](https://docs.routebase.dev/mcp-authentication/): Authenticate your AI agent against the Routebase MCP server with an API key or with OAuth 2.1.
- [MCP CLI Reference](https://docs.routebase.dev/mcp-cli-reference/): Read every flag and environment variable of the command your agent launches as a stdio MCP server.
- [MCP Quickstart](https://docs.routebase.dev/mcp-quickstart/): Connect your AI agent to Routebase in a couple of minutes and let it work under the same permissions as your team.
- [MCP Resources & Prompts](https://docs.routebase.dev/mcp-resources-prompts/): Use the read-only resources and the guided prompts the MCP server exposes alongside its tools.
- [MCP Tool Reference](https://docs.routebase.dev/mcp-tool-reference/): Every tool the Routebase MCP server exposes, grouped by capability, with its parameters and the permissions it needs.
- [Members & Invitations](https://docs.routebase.dev/members/): Invite people into your organization, assign their roles and manage the invitations that are still outstanding.
- [Messaging](https://docs.routebase.dev/messaging/): Send Routebase alerts into Slack or Microsoft Teams, formatted for the client instead of as raw JSON.
- [Microsoft Entra ID SSO Setup](https://docs.routebase.dev/microsoft-entra-id-sso-setup/): Connect Microsoft Entra ID to Routebase with SAML 2.0 and set up automatic user provisioning.
- [Mock Server](https://docs.routebase.dev/mock-server/): Turn any API specification into a live, callable endpoint your frontend, tests and demos can use before the backend exists.
- [Mock Server — MCP Tools](https://docs.routebase.dev/mock-server-mcp-tools/): Mock server rules, responses, smart matching and org defaults.
- [Mock Server Settings](https://docs.routebase.dev/mock-server-settings/): Configure CORS, access tokens, proxy mode and generated data for a mock server, per server or across the organization.
- [Monitoring — MCP Tools](https://docs.routebase.dev/monitoring-mcp-tools/): Monitors, checks, alert policies, incidents and maintenance windows.
- [Monitoring Overview](https://docs.routebase.dev/monitoring-overview/): Run scheduled health checks against your live APIs, track uptime and latency, and open incidents when something breaks.
- [Monitors](https://docs.routebase.dev/monitors/): Set up a scheduled HTTP health check against a URL or an endpoint from your specification, and read every recorded check.
- [Navigation & Search — MCP Tools](https://docs.routebase.dev/navigation-search-mcp-tools/): Project dashboard and cross-entity search.
- [Notification Defaults](https://docs.routebase.dev/notification-defaults/): Set the starting point for everyone's notifications instead of leaving each new member to decide from scratch.
- [Notifications](https://docs.routebase.dev/notifications/): Choose which events reach you in the app and by email, from a published specification to a failing test run.
- [Notifications & Webhooks — MCP Tools](https://docs.routebase.dev/notifications-webhooks-mcp-tools/): Notifications, notification preferences and webhooks.
- [Offline Mode](https://docs.routebase.dev/offline-mode/): Keep working when the connection drops, because your changes are queued locally and sent the moment you are back.
- [Okta SSO Setup](https://docs.routebase.dev/okta-sso-setup/): Connect Okta to Routebase with SAML 2.0 and SCIM provisioning, one step at a time.
- [Onboarding](https://docs.routebase.dev/onboarding/): Set up your workspace in the onboarding wizard, which provisions nothing until you complete the final step.
- [OneLogin SSO Setup](https://docs.routebase.dev/onelogin-sso-setup/): Connect OneLogin to Routebase with SAML 2.0, one step at a time.
- [Organization Settings](https://docs.routebase.dev/organization/): Manage the organization-wide settings behind your workspace, from its name and region to how members work in it.
- [Organization & Access (read-only) — MCP Tools](https://docs.routebase.dev/organization-access-read-only-mcp-tools/): Read-only members, teams, custom roles and effective permissions.
- [Parameters](https://docs.routebase.dev/parameters/): Add path, query, header, cookie and query string parameters to an endpoint, each with a location, a type, a style and a required flag.
- [Security Personas](https://docs.routebase.dev/personas/): Store named authentication identities so the security scanners can call your API as different users.
- [Ping Identity SSO Setup](https://docs.routebase.dev/ping-identity-sso-setup/): Connect PingOne or PingFederate to Routebase with SAML 2.0, one step at a time.
- [Plan & Usage (read-only) — MCP Tools](https://docs.routebase.dev/plan-usage-read-only-mcp-tools/): Read-only plan, usage limits, credit balance and trial status.
- [Portal Administration — MCP Tools](https://docs.routebase.dev/portal-administration-mcp-tools/): Portal branding, custom domains and build management.
- [Portal Docs Search — MCP Tools](https://docs.routebase.dev/portal-docs-search-mcp-tools/): Search across published portal docs.
- [Profile & Preferences](https://docs.routebase.dev/profile/): Manage how you appear to teammates, your timezone, your password and how the app looks for you.
- [Project Auth](https://docs.routebase.dev/project-auth/): Configure API authentication per environment, so every test run inherits the right scheme and credentials.
- [Projects](https://docs.routebase.dev/projects/): Group the specifications, environments, variables, tests and documentation of one API effort into a project.
- [Projects & Environments — MCP Tools](https://docs.routebase.dev/projects-environments-mcp-tools/): Projects and their environments.
- [Promotions, Sync & Audit — MCP Tools](https://docs.routebase.dev/promotions-sync-audit-mcp-tools/): Promotion history, artifact sync reviews and the audit log of a spec.
- [Region Selection](https://docs.routebase.dev/region-selection/): Choose whether your workspace data lives in the European Union or the United States, a choice that is permanent.
- [Release Notes](https://docs.routebase.dev/release-notes/): Product updates and new capabilities are announced here — newest first. 1.9.0 — September 14, 2026 Added Specifications can be authored, imported and exporte...
- [Request Body Components — MCP Tools](https://docs.routebase.dev/request-body-components-mcp-tools/): Reusable request body components.
- [Responses](https://docs.routebase.dev/responses/): Describe what an endpoint returns for each status code, covering the body structure, content type, headers and example payloads.
- [Reusable Components — MCP Tools](https://docs.routebase.dev/reusable-components-mcp-tools/): Reusable parameter, response and security-scheme components.
- [Roles & Permissions](https://docs.routebase.dev/roles-permissions/): Understand the three built-in roles, define custom roles, and see which permission gates each action.
- [Scanner Reference](https://docs.routebase.dev/scanner-reference/): Read what each scanner checks, which OWASP API Security Top 10 category it covers and what it needs in order to run.
- [Scan Profiles](https://docs.routebase.dev/scan-profiles/): Save a reusable scan configuration with its target environment, specification, scanners, personas and rate limit.
- [Scheduling](https://docs.routebase.dev/scheduling/): Run a test suite automatically on a cron schedule, from nightly regression runs to hourly smoke tests.
- [Schema Drift](https://docs.routebase.dev/schema-drift/): Validate every monitor response against the schema of the endpoint it is linked to, which turns a monitor into a continuous contract test.
- [Schemas](https://docs.routebase.dev/schemas/): Model the objects your API works with as reusable schemas and reference them from every request body and response.
- [Schemas — MCP Tools](https://docs.routebase.dev/schemas-mcp-tools/): Schemas within a spec.
- [Security in CI/CD](https://docs.routebase.dev/security-in-cicd/): Queue a security scan from your pipeline over the REST API and fail the build on the findings you care about.
- [Security — MCP Tools](https://docs.routebase.dev/security-mcp-tools/): Security scans, findings, scan profiles and personas.
- [Security Overview](https://docs.routebase.dev/security-overview/): Test your running APIs against the OWASP API Security Top 10 with a scanner that already knows your specification.
- [Shared Library](https://docs.routebase.dev/shared-library/): Define common schemas and responses once at the organization level and reuse them across every project.
- [Shared Library — MCP Tools](https://docs.routebase.dev/shared-library-mcp-tools/): Shared schema library on project and org level.
- [Single Sign-On (SSO)](https://docs.routebase.dev/sso/): Let members sign in through your company identity provider with SAML 2.0, and provision accounts with SCIM.
- [SSO Setup Overview](https://docs.routebase.dev/sso-setup-overview/): See how SAML 2.0 and SCIM work in Routebase before you follow the guide for your own identity provider.
- [SSO Troubleshooting](https://docs.routebase.dev/sso-troubleshooting/): Work through sign-in failures, SCIM provisioning problems and roles that do not follow your directory.
- [Style Guide](https://docs.routebase.dev/style-guide/): Lint every specification against built-in and custom rules covering naming, completeness, best practices, security and structure.
- [Style Guide & Governance — MCP Tools](https://docs.routebase.dev/style-guide-governance-mcp-tools/): Style guide rules and naming conventions.
- [Tags — MCP Tools](https://docs.routebase.dev/tags-mcp-tools/): Endpoint tags: create, assign, reorder and bulk update.
- [Team Access](https://docs.routebase.dev/team-access/): Group members into teams and grant each team access to specific projects at a level you choose.
- [Test Data](https://docs.routebase.dev/test-data/): Use fixtures, seeds and snapshots so your tests need no inline setup, no shared database and no external scripts.
- [Testing — MCP Tools](https://docs.routebase.dev/testing-mcp-tools/): Test suites, cases, runs, fixtures, seeds, snapshots and schedules.
- [Test Scenarios](https://docs.routebase.dev/test-scenarios/): Chain test cases into a multi-step workflow where each step can extract values from the response before it.
- [Test Suites](https://docs.routebase.dev/test-suites/): Send automated requests against your live API, organize them into suites and track their health over time.
- [Variables](https://docs.routebase.dev/variables/): Reference values as {{variableName}} and let the active environment supply them, so URLs, tokens and IDs stay out of your requests.
- [Variables — MCP Tools](https://docs.routebase.dev/variables-mcp-tools/): Org and project variables (secret values are never readable).
- [Spec Versioning](https://docs.routebase.dev/versioning/): Release specification versions, keep drafts editable, freeze published ones and route consumers to the version they expect.
- [Versions — MCP Tools](https://docs.routebase.dev/versions-mcp-tools/): Spec versions: lifecycle, publishing, promotion and environment pins.
- [Webhooks](https://docs.routebase.dev/webhooks/): Push Routebase events to your own services as HTTP POST requests, with signed payloads and a delivery history.

## API Reference

- [Routebase Public API Reference](https://docs.routebase.dev/api/routebase-public-api/)
- [API Specs](https://docs.routebase.dev/api/routebase-public-api/api-specs/)
- [CI & Test Runs](https://docs.routebase.dev/api/routebase-public-api/ci-test-runs/)
- [Docs as Code](https://docs.routebase.dev/api/routebase-public-api/docs-as-code/)
- [SCIM](https://docs.routebase.dev/api/routebase-public-api/scim/)
- [Security](https://docs.routebase.dev/api/routebase-public-api/security/)