# Gateways

> Gateways documentation: platform and console guides, product comparisons, and REST API reference.

## Docs

- [API reference](https://docs.gateways.app/api-reference/introduction.md): How to authenticate, where the full REST catalog lives, and how this tab is organized.
- [Authentication & API access](https://docs.gateways.app/api/00-authentication-access.md): Base URL, session tokens, API keys (sk_), WebSocket URL auth, and restrictions.
- [Authentication & User Management](https://docs.gateways.app/api/01-authentication.md): HTTP API: Authentication & User Management
- [Projects and Environments](https://docs.gateways.app/api/02-projects-environments.md): HTTP API: Projects and Environments
- [List connected connections for a workspace (default behavior)](https://docs.gateways.app/api/03-cloud-connections.md): HTTP API: List connected connections for a workspace (default behavior)
- [With auto-generated slug (slug will be generated from name)](https://docs.gateways.app/api/04-servers-instances.md): HTTP API: With auto-generated slug (slug will be generated from name)
- [Public — no auth required](https://docs.gateways.app/api/05-resources.md): HTTP API: Public — no auth required
- [GitHub](https://docs.gateways.app/api/06-applications.md): HTTP API: GitHub
- [07-resource-connections](https://docs.gateways.app/api/07-resource-connections.md): HTTP API: 07-resource-connections
- [08-firewalls](https://docs.gateways.app/api/08-firewalls.md): HTTP API: 08-firewalls
- [09-storage-buckets](https://docs.gateways.app/api/09-storage-buckets.md): HTTP API: 09-storage-buckets
- [10-resource-positions](https://docs.gateways.app/api/10-resource-positions.md): HTTP API: 10-resource-positions
- [Get database metrics for the last hour (default)](https://docs.gateways.app/api/11-utility-resources.md): HTTP API: Get database metrics for the last hour (default)
- [Get active regions for the project's connected cloud provider](https://docs.gateways.app/api/12-cloud-infrastructure.md): HTTP API: Get active regions for the project's connected cloud provider
- [13-legacy](https://docs.gateways.app/api/13-legacy.md): HTTP API: 13-legacy
- [14-bucket-explorers](https://docs.gateways.app/api/14-bucket-explorers.md): HTTP API: 14-bucket-explorers
- [List all files in root (bucketExplorerId = 1)](https://docs.gateways.app/api/15-bucket-files.md): HTTP API: List all files in root (bucketExplorerId = 1)
- [Static Websites](https://docs.gateways.app/api/16-static-websites.md): HTTP API: Static Websites
- [Sync database data from cloud provider and update database](https://docs.gateways.app/api/18-databases.md): HTTP API: Sync database data from cloud provider and update database
- [Sync cache server status from cloud provider](https://docs.gateways.app/api/19-cache-servers.md): HTTP API: Sync cache server status from cloud provider
- [Serverless Functions](https://docs.gateways.app/api/21-functions.md): HTTP API: Serverless Functions
- [Activity Logs](https://docs.gateways.app/api/22-activities.md): HTTP API: Activity Logs
- [Pricing Plans](https://docs.gateways.app/api/23-pricing-plans.md): HTTP API: Pricing Plans
- [Workspaces](https://docs.gateways.app/api/24-workspaces.md): HTTP API: Workspaces
- [DNS Management](https://docs.gateways.app/api/25-dns.md): HTTP API: DNS Management
- [Payments](https://docs.gateways.app/api/25-payments.md): HTTP API: Payments
- [Subdomain Management](https://docs.gateways.app/api/26-subdomains.md): HTTP API: Subdomain Management
- [Scalable Servers](https://docs.gateways.app/api/27-scalable-servers.md): HTTP API: Scalable Servers
- [Runtimes & Runtime Servers](https://docs.gateways.app/api/28-runtimes.md): HTTP API: Runtimes & Runtime Servers
- [API Documentation](https://docs.gateways.app/api/index.md): HTTP API: API Documentation
- [Account and workspace](https://docs.gateways.app/gateways/account.md): Account settings routes, workspace administration, session termination, and workspace invitations.
- [Activity and project settings](https://docs.gateways.app/gateways/activity-and-project-settings.md): Environment activity auditing and project-level configuration in the Gateways console.
- [Architecture canvas](https://docs.gateways.app/gateways/canvas.md): Canvas controls, resource provisioning, cloud account linkage, and inter-resource connections in the Gateways console.
- [Command reference](https://docs.gateways.app/gateways/cli/commands.md): All gateways CLI subcommands for auth, init, push, deploy, list, and SSH.
- [CLI Introduction](https://docs.gateways.app/gateways/cli/index.md): The Gateways CLI for sign-in, project linking, push, deploy, and SSH from your terminal.
- [Initialize project](https://docs.gateways.app/gateways/cli/initialize-project.md): Create .gateways.yaml from a working project directory with gateways init.
- [Install](https://docs.gateways.app/gateways/cli/install.md): Install the gateways binary on macOS, Linux, Windows, or build from source.
- [Project file](https://docs.gateways.app/gateways/cli/project-file.md): Fields in .gateways.yaml for project, environment, uploads, and deploy commands.
- [Authentication and registration](https://docs.gateways.app/gateways/create-account.md): Account creation, sign-in, OAuth, two-factor authentication, and password recovery for the Gateways console.
- [Navigation](https://docs.gateways.app/gateways/navigation.md): Header layout, workspace and project selection, primary routes, and user menu behavior in the Gateways console.
- [Overview](https://docs.gateways.app/gateways/overview.md): How workspaces, projects, and environments fit together in Gateways, plus theming and URL conventions.
- [Application: Canvas and operations](https://docs.gateways.app/gateways/resources/application/canvas-and-operations.md): Application cards on the canvas, connections to other resources, deploy state, and deletion.
- [Application: Docker image](https://docs.gateways.app/gateways/resources/application/docker-image.md): Deploy from a container registry or image upload—docker-image variant.
- [Application: Git repositories](https://docs.gateways.app/gateways/resources/application/git-repositories.md): GitHub, GitLab, and Bitbucket application flows—repo selection, connections, branch, runtime, and deploy.
- [Application](https://docs.gateways.app/gateways/resources/application/index.md): Deploy workloads from upload, Git, or Docker—API subtype application and five source types in Create.
- [Application sources](https://docs.gateways.app/gateways/resources/application/sources.md): The five ways to create an application in Create—upload, GitHub, GitLab, Bitbucket, or Docker image—and how they map to the API.
- [Application: Upload app & build commands](https://docs.gateways.app/gateways/resources/application/upload-and-build.md): Upload-app panel—artifact, runtime, install/run commands, environment variables, reverse proxy.
- [Cache server](https://docs.gateways.app/gateways/resources/cache-server.md): Managed cache tiers—API subtype cache_server; engine and instance type in the panel.
- [Resource connections](https://docs.gateways.app/gateways/resources/connections.md): Relationships between resources on the canvas—API subtype resource_connection.
- [Database](https://docs.gateways.app/gateways/resources/database.md): Managed databases—engine submenu, configuration panel, API subtype database.
- [DNS](https://docs.gateways.app/gateways/resources/dns.md): Hosted DNS zones—API subtype dns; Native and Cloudflare variants in the panel.
- [Firewall](https://docs.gateways.app/gateways/resources/firewall.md): Network security rules—API subtype firewall; inbound and outbound rules in the panel.
- [Function](https://docs.gateways.app/gateways/resources/function.md): Serverless functions—API subtype function; runtime, architecture, handler, and region in the panel.
- [Resource Types](https://docs.gateways.app/gateways/resources/index.md): Catalog of infrastructure and tooling you can add from Create—each type has its own page below.
- [Runtime: Application servers](https://docs.gateways.app/gateways/resources/runtime/application-servers.md): Optional application server stack selection for Python, PHP, .NET, and Perl runtimes in the runtime configuration panel.
- [Runtime: Canvas and connections](https://docs.gateways.app/gateways/resources/runtime/canvas-and-connections.md): Connecting runtime resources to servers, SSH install behavior, and API references.
- [Runtime: Families and versions](https://docs.gateways.app/gateways/resources/runtime/families-and-versions.md): Language family selector and version dropdown in the runtime configuration panel; runtime catalog API.
- [Runtime](https://docs.gateways.app/gateways/resources/runtime/index.md): Language runtime cards on the canvas—catalog, configuration panel, and connection to servers.
- [Scalable server](https://docs.gateways.app/gateways/resources/scalable-server.md): Auto scaling groups and scaled compute—API subtype scalable_server.
- [Server](https://docs.gateways.app/gateways/resources/server.md): Single-instance compute (VM)—Create, configuration panel, and API subtype instance.
- [Static website](https://docs.gateways.app/gateways/resources/static-website.md): Static site hosting—API subtype static_website; provider-specific naming rules in the panel.
- [Storage bucket](https://docs.gateways.app/gateways/resources/storage-bucket.md): Object storage—API subtype storage_bucket; region, versioning, and public access in the panel.
- [Utilities](https://docs.gateways.app/gateways/resources/utilities.md): Terminal, bucket explorer, IDE, DB monitoring, subdomain, and generic utility resources.
- [Troubleshooting](https://docs.gateways.app/gateways/troubleshooting.md): Operational guidance for maintenance windows, authentication failures, connectivity, and data visibility in the Gateways console.
- [Platform](https://docs.gateways.app/index.md): Gateways is a cloud operations console for designing infrastructure visually, connecting accounts, and shipping with your team—from architecture to activity in one place.
- [Gateways vs Fly.io](https://docs.gateways.app/platform/compare-to-fly-io.md): Multi-cloud resource design vs Fly.io’s global app platform.
- [Gateways vs Heroku](https://docs.gateways.app/platform/compare-to-heroku.md): Your-cloud architecture console vs Heroku’s classic PaaS dynos and add-ons.
- [Gateways vs Netlify](https://docs.gateways.app/platform/compare-to-netlify.md): Owned cloud operations vs Netlify's composable web platform.
- [Gateways vs Railway](https://docs.gateways.app/platform/compare-to-railway.md): Enterprise multi-cloud canvas vs Railway’s developer PaaS workflows.
- [Gateways vs Render](https://docs.gateways.app/platform/compare-to-render.md): Multi-cloud canvas in your accounts vs Render’s unified PaaS.
- [Gateways vs Vercel](https://docs.gateways.app/platform/compare-to-vercel.md): Multi-cloud architecture canvas vs Vercel’s frontend cloud and edge platform.
- [Compare Gateways](https://docs.gateways.app/platform/index.md): How Gateways compares to popular deployment and PaaS platforms.