Home > REST API > Endpoints > Management Endpoint
REST API

Management Endpoint

Updated: September 10, 2026

The Nuxeo Management REST API is a set of endpoints allowing the management of the Nuxeo Platform.

Configuration

Authentication

The Management REST API is accessible for any administrator user.

Furthermore, a "technical" user can be configured to access the Management REST API in nuxeo.conf:

nuxeo.management.api.user=transient/technical_user

The user does not need to exist in Nuxeo, and must start with transient/ as we are relying on the transient user feature.

Since 2025.16
Every call made to the Management REST API fires a managementApiAccess event. By contributing an Audit route and the appropriate extended info mappings on this event, you can persist who called what, when and how to the Audit service to enable full traceability of the Management REST API. See the worked example on the Audit Router page.

Once you have created the user, configure a JWT secret in nuxeo.conf:

nuxeo.jwt.secret=abracadabra

Then, to use the Management REST API:

  • Share the JWT secret (abracadabra here) between the Nuxeo Server and the client calling the Management REST API,
  • Generate a JWT token with the user (transient/technical_user here) as claim subject,
  • Call the API using the Authorization: Bearer JWT_TOKEN header.

Deploy the Management REST API on a Separate HTTP Port

For security reasons, it is recommended to deploy the Management REST API on a different port from the regular Nuxeo application one.

For instance, to configure the HTTP port to 9090, in nuxeo.conf add:

nuxeo.management.api.http.port=9090

Endpoints

Here are the endpoints provided by the Management REST API.

Name Endpoint Description
Audit /audit Audit Router introspection and Blue/Green Audit migration.
Binaries /binaries Binaries management.
Blobs /blobs Blobs management.
Bulk /bulk Bulk actions management.
Configuration /configuration Configuration information.
Connect /connect Connect information.
Distribution /distribution Distribution information.
Elasticsearch /elasticsearch Elasticsearch management.
Fulltext /fulltext Fulltext management.
Migration /migration Migrations management.
OAuth2 /oauth2 OAuth2 management.
PageProviders /page-providers Page Providers information.
Pictures /pictures Picture views recomputation.
Probes /probes Probes information.
Scheduler /scheduler Scheduler Management.
Search /search Nuxeo Search Management.
Streams /stream Nuxeo Stream Management.
Thumbnails /thumbnails Thumbnails recomputation.
Versions /versions Versions management.
Workflows /workflows Workflows management.
WorkManager /work-manager Works in failure reprocessing.