You are here

The ReST API Explorer

The ReST API Explorer documents all the API methods available to you, and lets you try those methods out.

The Alfresco ReST API Explorer is the reference guide for the API. It's based on the OpenAPI initiative and gives you interactive documentation for the Alfresco ReST API. You can access our online REST API Explorer at https://api-explorer.alfresco.com/api-explorer, and if you have the Alfresco SDK you can also run the Explorer on your local machine.

Follow the guidelines on this page for information on how to install the API Explorer in a trial or SDK environment.

This screenshot shows what the REST API Explorer looks like:

Use the userid admin and password admin if you're are using the online REST API explorer.

To explore the operations on a specific entity, for example nodes (i.e. folders and files), just click on it.

Now you can click on each of the available operations and test them on Alfresco.

You can use the API with another user than admin by changing the username and password in the upper right corner of the screen

The ReST API consists of a number of parts, the Core API, the Workflow API, the Search API etc. You can switch between the different APIs by clicking on the drop down box, and then selecting the API you want to work with.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.