Skip to main content

Hosting Your Generated Portal

When you generate an API portal with the APIMatic CLI, it writes a folder of portal artifacts: plain HTML, CSS, JavaScript, and assets. That output is a static site. It runs no server of its own, so you host it wherever you already serve static content.

This gives you full control. The portal lives on your own domain, behind your own access rules, alongside the rest of your developer content. You decide how it deploys, when it updates, and who can reach it.

What you get from generation​

Generate the portal with the CLI by following the Quickstart. When it finishes, the CLI reports where the portal artifacts landed and starts a local preview server. That artifacts folder is the self-contained static site you deploy.

Point any static host at the folder and the portal works. There's no runtime to install, no database to provision, and no server process to keep alive. Because it's static, the portal is fast to serve, cheap to run, and easy to put behind a CDN.

Where to host it​

You can serve the portal from any platform that hosts static sites. These are the common choices:

  • Netlify. Connect a Git repository or push the build folder directly. Netlify handles builds, previews, and custom domains.
  • Cloudflare Pages. Deploy from Git or upload the build output, and serve it from Cloudflare's global network.
  • Vercel. Import the project or drop in the static output, and Vercel serves it with automatic HTTPS and preview deployments.
  • Microsoft Azure. Use Azure Static Web Apps for a managed static host, or serve the folder from Azure Blob Storage with Azure CDN in front.
  • Amazon Web Services. Upload the build to an Amazon S3 bucket and put Amazon CloudFront in front of it for global delivery and HTTPS.

Any host that serves a folder of static files over HTTPS works here, so you aren't limited to this list. Pick the platform your team already runs on.

A typical deployment flow​

  1. Generate the portal with the APIMatic CLI by following the Quickstart.
  2. Find the portal artifacts folder that the CLI reports on completion.
  3. Deploy that folder to your chosen host, either by connecting your Git repository or by uploading the folder.
  4. Map your custom domain and let the host issue an HTTPS certificate.

To keep the portal current, wire this into your CI/CD pipeline. Regenerate the portal whenever your API specification changes, then let the pipeline redeploy it.

info

Don't want to host it yourself? APIMatic can host the portal for you. Reach out to support@apimatic.io and the team will walk you through the options.