Developer portals

A developer portal is a public site that presents your APIs to the people who call them. To create one, choose Portals in the Pods sidebar, then New Portal. Owners, Admins and Managers can create and edit portals.

1. Type a Name, up to 128 characters.
2. Check the Slug. Pods fills it in from the name; it's 2 to 128 lowercase letters, digits and dashes, and it can't change later. The hint shows the public address, /pods/portal/ followed by the slug.
3. Choose Create Portal.

The portal starts as a Draft, so nobody can see it yet. It opens in its editor, with the sections General, Products & APIs, Pages and Publish.

A portal's General section sets how it looks and who can open it. Make your changes, then choose Save Changes. Saved changes reach the public portal the next time you publish.

• Name, and the Public URL with a copy icon.
• Theme: Match visitor (the default), Light or Dark.
• Primary color and Accent color: hex values such as #4f46e5.
• Footer (Markdown): text for the bottom of every page.
• Require sign-in: visitors must sign in with a Geiger account before they see anything. Allowed email domains, such as acme.com, partner.io, limits it to those addresses; leave it empty to let any signed-in visitor in.

A visitor who isn't signed in sees "Sign in required", and one whose email domain isn't allowed sees "Not allowed".

A product groups the docs and endpoint pages a portal shows, such as everything about one API. Open a portal and choose Products & APIs.

1. Choose New Product, type a Name (up to 128 characters) and an optional Description, then choose Create Product.
2. Choose Link beside the product to put it on this portal.

The list shows every product the project owns, and whether each is Linked or Not linked to this portal, so one product can appear on several portals. A linked product appears on the public portal after the next publish.

Pages belong to a product. Open a portal and choose Pages. Create a product first if there's none.

• Docs page: a Markdown page. Pick the Product, type a Title (up to 256 characters) and a Slug, write the Body (Markdown), and choose Add Page.
• Endpoint page: a reference page for one operation of a deployed REST API. Pick the Product and the API, type the Stage, pick the Method, type the Resource path such as /pets/{id} and, optionally, an Operation name. Choose Add Endpoint.

New pages appear on the public portal after the next publish. Members see this section read-only.

Publishing freezes the portal's products, pages and branding into a snapshot that its public page serves. Later edits don't show until you publish again. Only Owners and Admins can publish.

Open the portal, choose Publish, then Publish (or Publish again). Public page shows the address, and Open opens it. You can also choose Publish or View public page in the portal's ⋯ menu in the list.

To take a portal offline, choose Disable Portal under Danger zone, or Disable in its ⋯ menu, and confirm. Its public address stops serving straight away. Publish again to bring it back.

The Portals screen counts the project's Portals, how many are Published, how many are Drafts, and its Products. Filter by Status: Draft, Published or Disabled. Each row shows the portal's status and public URL.

• Draft: not public yet.
• Published: visitors see the last published snapshot.
• Disabled: the public address returns a not-found page.

Click a portal, or choose Edit (or Open) in its ⋯ menu, to open its editor.