Hosting

An APIMatic portal is a static site. apimatic portal generate turns your src directory into a self-contained folder of HTML, CSS, JavaScript, and assets, so there's no server to run. You choose where it's deployed, which domain it lives on, who can reach it, and when it updates.

Static hosting is also fast, cheap, and works well behind a CDN.

Deploy your portalCopy Anchor Link

1. Generate the portalCopy Anchor Link

From the directory that contains src, run:

apimatic portal generate --destination=./portal

Add --force to overwrite a previous build in the same folder. See Generate a Portal for all flags.

2. Find the output folderCopy Anchor Link

The folder you passed to --destination holds the complete site. That folder is what you deploy.

3. Deploy it to your hostCopy Anchor Link

Connect your host to a Git repository that contains the folder, or upload the folder directly. Any host that serves a folder of static files over HTTPS works.

4. Set up your domainCopy Anchor Link

Point your custom domain at the host and turn on HTTPS. Then set the same address in portal.site.url in apimatic.json, without a path:

{
  "portal": {
    "site": {
      "url": "https://docs.example.com"
    }
  }
}

See the apimatic.json Reference.

Choose a hostCopy Anchor Link

Keep your portal up to dateCopy Anchor Link

Regenerate and redeploy the portal whenever your API definition or guides change. The simplest way is to add apimatic portal generate to your CI/CD pipeline, so every change to src publishes a fresh portal.

In CI, sign in with an API key instead of a browser session:

apimatic portal generate --destination=./portal --auth-key=$APIMATIC_API_KEY

Then deploy the ./portal folder with your host's CLI or Git integration.