Server

REST API

Updated: January 2, 2020

Nuxeo REST API is available on Nuxeo Platform server. All endpoints follow the URL:

http://NUXEO_SERVER/nuxeo/api/v1/*

This page explains the organization and scope of the existing endpoints and other additional mechanisms which extend the behavior of the API.

Nuxeo University
Watch the related courses on Nuxeo University

Scope and Concepts

Nuxeo provides a complete API accessible via HTTP/HTTPS. This API is the best way to remotely integrate portals, workflow engines, ESBs and custom applications written in JavaScript, Ruby, etc, with the Nuxeo Platform repository. See REST API Endpoints for more detailed information on the endpoints provided by Nuxeo REST API and how to contribute your own.

Additional Features

The Nuxeo REST API offers several additional features compared to a standard REST API:

  • the ability to pipe command calls on a resource
  • the use of Content enrichers in request headers which allow you to request more information with the returned resources (for example, receiving all of a document's children in addition to the document itself)
  • the use of Web Adapters which transform the resources returned (for example, getting all the tasks of a document, or its related documents)

Learn more

Available Client SDKs

We provide several client SDKs to make it even easier to use the API integrated with the Nuxeo Platform.

  • JavaScript Client
  • Java Client
  • Python Client
  • .NET Client — Nuxeo .NET Client is a cross-platform client library developed in C# for the Nuxeo Automation and REST API.
  • iOS Client
  • PHP Automation Client — A PHP automation client is made available on GitHub. You can use it and ask for commit rights on the project if you want to improve it or fix a bug. The project contains the library and some sample use cases.
  • Client API Test suite (TCK) — This chapter provides a test suite that can be used to test the implementation of an automation client library.
  • DART Client
  • Using cURL — In this example we are using the UNIX curl command line tool to demonstrate how to invoke remote operations.

We'd love to hear your thoughts!

All fields required