API Portal
Navigation
Configure the header and footer menus of your API Portal: add items that link to a page, a documentation hub, a product catalogue or an external site, reorder them, and understand what Active, Inactive and Public do, including for the built-in items.
The navigation is the pair of menus developers use to move around your API Portal. You edit it under Portal, Navigation: Main Navigation is the header menu and Footer Navigation is the footer menu. Each item links to a portal page, a documentation hub, a product catalogue page or an external site.
Which menus can you configure?
Two menus, one per tab. Each tab lists its items with Name, Slug and Status, in the order they appear on the portal.
| Tab | Menu |
|---|---|
| Main Navigation | The header menu across the top of the portal. |
| Footer Navigation | The footer menu at the bottom of the portal. |
How do you add a navigation item?
Choose Add New to open New Navigation. Enter a Name, pick what it links to, check the Public toggle, then choose Save. The item is added to the end of the menu on the tab you are on.
- On Main Navigation or Footer Navigation, choose Add New.
- Enter a Name. This is the text developers see in the menu.
- Pick a page in the Pages table, or turn on Use External Link and enter the Link.
- Set Public: on shows the item to everyone, off only to signed-in developers.
- Choose Save.
The Pages table lists your published pages that are not already in this menu. Turn on Show only documentation hubs or Only product categories to list those instead. Search by name... filters the list.
How do you link to an external site?
Turn on Use External Link in the item and enter the full address in Link, starting with http or https. Otherwise the field shows "Please use the proper URL format starting with http or https." and Save stays disabled.
How do you reorder navigation items?
Drag an item by the handle on its left to a new position, then choose Save Order at the top of the page. Save Order enables once the order has changed.
- Drag an item by its handle to a new position.
- Repeat until the order is right.
- Choose Save Order.
What do Active and Inactive do?
The Status toggle saves as soon as you change it. Active shows the item in its menu. Inactive hides it from the menu. For the built-in items it also takes the page itself offline.
The built-in items are the ones whose slug is /products, /full-api-reference, /teams, /subscriptions or /docs. When one of them is Inactive, anyone who opens that address sees "Whoops! 404 Page not found." For example, setting the /products item to Inactive takes your product catalogue offline, not just its menu entry.
Public works the same way on those items. With Public off, visitors who are not signed in and open the page see "This page is private." with a Go to the Login page button.
How do you edit or delete an item?
Open the row menu and choose Edit to change the item in Navigation Details, or Delete to remove it. Delete takes effect at once, without a confirmation.
The built-in items cannot be deleted. In their Edit view you can change the Name, but not the page they link to. For /teams and /subscriptions the Public toggle is locked too.
Troubleshooting
| What you see | What to do |
|---|---|
| Save stays disabled in the item | Enter a Name, and either pick a page or enter a valid Link. Save also needs a change. |
| "Please use the proper URL format starting with http or https." | Enter the full address, including https://. |
| A page is missing from the Pages table | Publish it under Portal, Pages. Pages already in this menu are not listed. |
| A private page's menu item shows to signed-out visitors | Turn Public off in the item and save. |
/products or another built-in page shows 404 Page not found | Its menu item is Inactive. Set it back to Active. |
| Save Order stays disabled | The order has not changed. Drag an item first. |
| Delete is disabled on an item | It is a built-in item and cannot be deleted. |