An Organization API Hub brings your organization's published API documentation together in one place. Readers can browse participating documentation sites and search across them without opening each site separately. Organization administrators manage the Hub's branding, publication status, access settings, and search index.Unlike the public Apidog API Hub, which helps developers discover APIs contributed by the community, an Organization API Hub collects documentation from your own organization.Prerequisites#
An organization on the Enterprise plan in Apidog SaaS. This page covers the SaaS Organization API Hub.
Organization administrator permissions to configure and publish the Hub.
Published main documentation sites belonging to the organization, with a site administrator available to opt each site into the Hub.
Set Up the Hub#
Open your organization's API Hub settings to configure the Hub.1.
Set the Hub's name and icon so readers can identify your organization.
2.
Configure the Hub's domain. You can use its provided address or configure a custom domain.
3.
Choose public or organization SSO access, as described below.
4.
Save your settings and enable publication when the Hub is ready to share.
Choose Who Can Access the Hub#
| Access mode | Reader experience |
|---|
| Public | Anyone with the Hub link can open it. Public search includes only publicly visible content. |
| Organization SSO | Readers authenticate through the organization's configured SAML SSO. Participating sites follow the Hub's access policy. |
Choose the access mode before sharing the Hub link. Adding documentation to the organization Hub is separate from contributing it to the public Apidog community API Hub.Add Documentation Sites#
Sites must opt into the organization Hub; publishing a site alone does not automatically add it.1.
Open the project and go to Publish Docs.
3.
In the site's publishing settings, select the option to follow the organization API Hub and save the configuration. The participating site inherits the Hub's access policy.
4.
Open the published Hub and check that the site appears in its catalog.
Only published main sites belonging to the organization are eligible. Sub-sites, unpublished sites, and deleted sites are excluded. Each site's administrator controls whether it participates.Browse and Search Documentation#
Share the published Hub URL with your readers. They can browse its catalog and open the documentation they need. Search lets them find content across participating sites from one place.Public search includes publicly visible content. Authenticated Hub search covers content included in the Hub. Organization administrators can rebuild the search index when needed.Maintain the Hub#
Update branding or access: Return to the organization's API Hub settings to update its configuration.
Review participating sites: Check that each site is published, belongs to the organization, and is opted into the Hub.
Refresh search: Use the Hub's search-index rebuild action when the index needs refreshing.
Stop publication: Turning off the Hub also affects access to documentation sites that follow it. Review those sites before disabling publication.
A Site Is Missing from the Hub#
The site belongs to a project in the same organization.
It is the main site, not a sub-site.
It is published and has not been deleted.
Its administrator has enabled participation in the organization Hub.
If the site is listed but its content is missing from search, review its visibility and rebuild the Hub's search index as needed. Modified at 2026-11-16 10:30:36