Getting Started with Management API

The Management API is the control plane for FoxNose. Use it to create environments, model folders and fields, automate resource updates, and configure Flux APIs from code.

Management API vs Flux API

The two APIs are complementary:

  • Management API is the control plane. You call it when you want to create or modify anything inside FoxNose: environments, schemas, resources, revisions, roles, keys, Flux configuration. Every write (and most reads used by automation) flows through this API.
  • Flux API is the delivery plane. Once content is published, Flux handles caching, localization, full-text and vector search, pagination, and edge delivery for your apps. You don’t mutate content through Flux—you simply request it in the shape you need.

Practically, your automation, custom admin tools, and integration scripts talk to Management API; your public apps and services consume Flux. Keeping this separation makes it easier to lock down authoring while letting delivery scale independently. Learn the delivery side in the Flux Get Started guide.

What You Can Achieve

  • Model the content layer – Define everything from environments and locales to folders, fields, and components using API calls, so your data model lives in code.
  • Evolve safely – Promote schema or configuration changes through preview/staging environments before they hit production.
  • Automate content lifecycles – Create, update, and publish resources via scripts or CI jobs, keeping test and production data in sync.
  • Configure delivery centrally – Map folders to Flux APIs, update authentication settings, or rotate keys from the same API that manages your content.
  • Govern access – Assign roles, generate keys, and audit changes programmatically so each integration has the right scope—and nothing more.

If your workflow already uses automation, internal admin tools, or partner integrations, the Management API is the layer that keeps your content architecture aligned with those systems.

How the Platform Is Structured

  1. Workspace & Projects – Your company (workspace) can host multiple projects (brands, regions).
  2. Environments – Each project has environments with their own locales, feature flags, and Flux connections.
  3. Schemas – Folders, components, fields, and versions describe the shape of content.
  4. Content – Resources represent entries; revisions capture draft/published states.
  5. Access – Roles & keys secure both Management and Flux APIs.

Once this foundation is in place, your authors use the CMS UI while your apps consume published content via Flux.

How You'll Use the API

1. Authenticate

Decide whether your integration uses a service account, dashboard-issued key, or OAuth token. All requests require an Authorization header; see Authentication for samples.

2. Prepare Environments

Create or configure environments, set default locales, and establish fallback chains. Environments also contain Flux API settings, so scripted changes here ripple into delivery automatically. See the Environments guide for payloads and restrictions.

3. Design Schemas

Use folders to define collections, components for reusable blocks, and fields to control validation. Versions help you stage schema changes without breaking existing content.

4. Automate Content

Create resources, update draft revisions, and publish when ready. Import/export jobs, migration scripts, or custom admin tools all hit these endpoints.

5. Wire Up Flux

Use the Management API to map folders to Flux APIs, generate Flux roles / keys, and roll the configuration out. Delivery becomes a byproduct of your schema + content setup.

Next Steps

Once these pieces click, you have a programmable content platform that mirrors your business processes and scales with your automation.

Was this page helpful?