Create a gateway
Learn how to set up your first application on SuperAPI and configure it to improve your API performance.
Welcome to SuperAPI, the programmable API gateway that makes all your fetch APIs cacheable. This guide will walk you through setting up your first application on SuperAPI and configuring it to dramatically improve your API performance.
Overview
SuperAPI allows you to:
- Make traditionally non-cacheable APIs cacheable
- Reduce API response times by up to 10x
- Monitor both database and API changes to keep cache fresh
- Deploy globally to bring your API responses closer to users
Creating Your First Gateway
After logging in to SuperAPI, the first step is to create a gateway. A gateway acts as the entry point for all your API traffic, routing requests through SuperAPI's caching layer.
To create a gateway:
Navigate to the Gateways tab in the SuperAPI dashboard
Click the "+ Add Gateway" button in the top right corner
In the "Create a new Gateway" dialog, provide the following information:
- Unique name for your gateway: A descriptive name for your application (e.g.,
superapi_application) - Unique DNS for your gateway: This will be your application's subdomain (e.g.,
superapi-application) - Cloud provider: Select where your application is hosted (AWS or GCP)
- Region: Choose the region closest to your application or users
Click "Save" to create your gateway
Once created, your gateway will appear in the list with a "Deployed" status of "NO" initially. SuperAPI will begin provisioning your gateway infrastructure.
Exploring Your Gateway Details
After creating your gateway, you can view its details by clicking on its name in the gateway list. This will take you to the gateway details page where you can see:
- Gateway Name: The name you provided
- DNS: The full domain for your gateway (e.g.,
superapi-application.superapi.cloud) - Cloud: The cloud provider you selected
- Region: The deployment region
From this page, you can access the controls to deploy your gateway and manage your cache once deployed.
Deploying Your Gateway
Once you've configured your database and endpoints, you can deploy your gateway by clicking the "Deploy" button on the gateway details page.
Note that the Deploy button will remain disabled until you've properly connected at least one database and configured at least one endpoint.
After successful deployment, the "Purge Cache" and "Pause Cache" buttons will become active, allowing you to manage your cache as needed:
- Purge Cache: Clears all cached responses, forcing fresh data to be fetched
- Pause Cache: Temporarily disables caching without removing existing cached data
What's Next?
In the next section, we'll walk through connecting your database to SuperAPI. This critical step enables SuperAPI's intelligent cache invalidation system and unlocks the full potential of the platform.
Next: Adding a Database to the gateway
Learn how to connect your database to enable intelligent cache invalidation
Need help? Contact our support team at founders@trysuperapi.com