Data Catalog
The Data Catalog is the central library of reusable database blueprints (Data Domains) on the API Now! platform.
Instead of re-creating standard database structures from scratch for every new project, you can browse, import, and share structured domain blueprints.
Why Publish to the Catalog?
Section titled “Why Publish to the Catalog?”To keep your backend architecture stable, the API Modeler cannot connect directly to a draft or actively changing Data Domain.
Before you can build endpoints or set up security rules, you must publish a versioned blueprint of your Data Domain to the Catalog:
- Stable Release: Publishing acts as a “stable release” of your database structure.
- API Binding: Once published, your API Model attaches to this specific version (e.g.,
1.0.0). - Safe Iteration: If you need to make changes to your database later, you design the updates as a new draft, publish a new version (e.g.,
1.1.0), and upgrade your API when you are ready.
Publishing Scopes (Visibility Levels)
Section titled “Publishing Scopes (Visibility Levels)”When you publish a Data Domain to the Catalog, you can choose who has access to view, import, or connect to that model:
| Scope | Visibility | Ideal Use Case |
|---|---|---|
| Private | Only visible to you. | Drafting new blueprints, personal testing, or sandbox experimentation. |
| Organization | Visible to all members inside your API Now! organization space. | Standardizing schemas for team-wide projects (e.g., sharing a unified Customer structure). |
| Public | Globally visible to all builders on the API Now! platform. | Sharing open-source database templates or industry-standard schemas. |
How to Publish a Domain
Section titled “How to Publish a Domain”- Open your draft inside the Domain Modeler.
- Once your tables and semantic modules are configured, click the Publish to Catalog button in the top navigation bar.
- Set the Version Tag (following semantic guidelines, e.g.,
1.0.0). - Select your desired Publishing Scope (Private, Organization, or Public).
- Click Publish. Once completed, this version becomes immediately available in the API Modeler dropdown list.
Reusing Domains Across APIs (Foreign Domain Imports)
Section titled “Reusing Domains Across APIs (Foreign Domain Imports)”Publishing a Data Domain with Organization scope enables you to import it as a dependency into other Data Domains.
This is the recommended pattern for sharing a single, unified User table or product catalog across multiple distinct APIs (such as a public customer API and an internal admin API) without table collisions or sync scripts.
For detailed architecture diagrams and step-by-step instructions, see the Single Database Architecture & Multi-API Integration Guide.