# Guardway

> Official documentation for Guardway — the AI gateway platform: self-host the gateway, govern it from the SaaS dashboard.

## Docs

- [CLAUDE](https://docs.guardway.ai/CLAUDE.md)
- [API Reference](https://docs.guardway.ai/api-reference/coming-soon.md): The public Guardway API is coming soon. The gateway already speaks an OpenAI-compatible API you can use today.
- [What's New](https://docs.guardway.ai/changelog/whats-new.md): Documentation changes and product updates, newest first.
- [Findings](https://docs.guardway.ai/discovery/findings.md): Drill into a scanned repository, browse AI dependencies by type, review MCP security scores and SCA vulnerabilities.
- [Organizations](https://docs.guardway.ai/discovery/organizations.md): Sync GitHub organizations, inspect repositories, and trigger scans.
- [Overview](https://docs.guardway.ai/discovery/overview.md): Automatically inventory every AI dependency across your GitHub repositories — models, SDKs, MCP tools, gateway configs.
- [Repositories](https://docs.guardway.ai/discovery/repositories.md): Inventory every synced repository, its scan state, and which AI categories are present (LLM providers, AI services, SDKs, MCP tools, gateways).
- [Introduction](https://docs.guardway.ai/getting-started/introduction.md): Guardway is an LLM gateway you self-host, governed from a SaaS dashboard. Unified API, guardrails, and observability across every provider.
- [Quickstart](https://docs.guardway.ai/getting-started/quickstart.md): Go from zero to a working LLM request through your own Guardway gateway in about ten minutes.
- [Sign Up](https://docs.guardway.ai/getting-started/sign-up.md): Create your Guardway account, activate it from the invite email, and land on the dashboard.
- [Activate](https://docs.guardway.ai/guardway-gateway/activate.md): What success looks like once a freshly registered gateway is running — Pending becomes Online, the dashboard sees the first heartbeat, and you can drive a request through Playground.
- [Deploy](https://docs.guardway.ai/guardway-gateway/deploy.md): Run the Guardway gateway container with the Register Gateway dialog — pick a deployment target, download the bundle (or take just the token), and start it with Docker Compose.
- [Environment](https://docs.guardway.ai/guardway-gateway/environment.md): Every environment variable the Guardway gateway container reads, grouped by purpose. Pair with the Register Gateway dialog on Deploy.
- [Functionalities](https://docs.guardway.ai/guardway-gateway/functionalities.md): Security functionalities, best practices, and compliance considerations for Guardway Gateway.
- [Overview](https://docs.guardway.ai/guardway-gateway/overview.md): What the Guardway gateway is, how it talks to the dashboard, and why prompts and completions never leave your network.
- [Requirements](https://docs.guardway.ai/guardway-gateway/requirements.md): Hardware, software, and network requirements for running a Guardway gateway.
- [Agents](https://docs.guardway.ai/platform/agents.md): Inventory of AI agents in your connected cloud providers — tools, MCP servers, models, gateway routing, Entra identities, and OWASP Agentic Top 10 findings.
- [API Keys](https://docs.guardway.ai/platform/configuration/api-keys.md): Issue, scope, rotate, and revoke API keys that authenticate applications calling your gateway.
- [Access](https://docs.guardway.ai/platform/configuration/members.md): Manage the users and teams that operate this gateway, with roles, budgets, and per-team spend.
- [Models](https://docs.guardway.ai/platform/configuration/models.md): Discover the models each provider exposes per gateway and enable the ones you want to use.
- [Providers](https://docs.guardway.ai/platform/configuration/providers.md): Add an LLM provider to Guardway, pick a preset, paste an API key, and attach it to a gateway.
- [Routing](https://docs.guardway.ai/platform/configuration/routing.md): Routing strategies and rules that decide which provider handles each request.
- [Security](https://docs.guardway.ai/platform/configuration/security.md): Configure MCP servers, guardrail rules, and SLM-based guardrails for the gateway.
- [Agents](https://docs.guardway.ai/platform/dashboard/agents.md): Org-wide agent discovery metrics on the Dashboard — routing posture, OWASP findings, models in use, and agents by provider.
- [Overview](https://docs.guardway.ai/platform/dashboard/overview.md): At-a-glance health and traffic for every gateway in your organization.
- [Security](https://docs.guardway.ai/platform/dashboard/security.md): Guardrail activity, severity breakdowns, and MCP traffic across every attached gateway.
- [Spend](https://docs.guardway.ai/platform/dashboard/spend.md): Cost view across gateways, teams, API keys, providers, and models, with budget tracking.
- [Usage](https://docs.guardway.ai/platform/dashboard/usage.md): Track requests, tokens, and latency across gateways, teams, API keys, providers, and models.
- [Logs](https://docs.guardway.ai/platform/logs.md): Inspect every request, MCP tool call, guardrail trigger, and trace through the gateway.
- [Platform Overview](https://docs.guardway.ai/platform/overview.md): What the Guardway SaaS dashboard does and how it relates to your self-hosted gateways.
- [Playground](https://docs.guardway.ai/platform/playground.md): Send test requests through your gateway, tune parameters, and inspect the raw request and response.
- [Audit Log](https://docs.guardway.ai/platform/settings/audit-log.md): Filter and inspect administrative actions recorded by your gateway.
- [Console](https://docs.guardway.ai/platform/settings/console.md): Session timeout and display timezone for the Guardway dashboard. Both are per-browser preferences.
- [Integrations](https://docs.guardway.ai/platform/settings/integrations.md): Connect external products to Guardway — GitHub discovery, Azure AI Foundry and Amazon Bedrock agent inventory, and Microsoft Entra ID identity signals.
- [Users](https://docs.guardway.ai/platform/settings/members.md): Invite teammates to your Guardway organization, change their roles, and revoke access.
- [Notifications](https://docs.guardway.ai/platform/settings/notifications.md): Subscribe webhooks to gateway events and create alert rules that fire into them.
- [Organization](https://docs.guardway.ai/platform/settings/organization.md): Tenant-level facts about your Guardway organization — display name, slug, tenant ID, and quick links to people and gateways.
- [Pricing](https://docs.guardway.ai/platform/settings/pricing.md): Per-model input/output cost table that powers Spend. Edit prices inline, import from JSON, or sync from the Guardway-maintained list.
- [Roles](https://docs.guardway.ai/platform/settings/roles.md): Reference for the three Guardway organization roles — Owner, Admin, and Read Only — and what each can do.
- [Traffic](https://docs.guardway.ai/platform/settings/traffic.md): Org-wide rate limits and cache settings applied across every gateway in your organization.
- [Topology](https://docs.guardway.ai/platform/topology.md): Live graph of gateways, providers, models, and discovered agents — with OWASP severity on agent nodes.
- [FAQ](https://docs.guardway.ai/resources/faq.md): Answers to the questions we get most often about Guardway.
- [Glossary](https://docs.guardway.ai/resources/glossary.md): Comprehensive glossary of terms used across the Guardway.ai platform and documentation.
- [Limitations](https://docs.guardway.ai/resources/limitations.md): Current limitations, known issues, and planned improvements for Guardway Gateway.
- [Privacy and Security](https://docs.guardway.ai/resources/privacy-and-security.md): How Guardway handles your data, the boundaries between the gateway and the cloud dashboard, and the security controls you can rely on.
- [Support](https://docs.guardway.ai/resources/support.md): How to get help, report bugs, and disclose security issues.

## OpenAPI Specs

- [openapi](https://docs.guardway.ai/api-reference/openapi.json)

## Optional

- [Blog](https://blog.guardway.ai)
- [Website](https://guardway.ai)