Umbraco REST API

The Umbraco REST API is for content, media, members & relations. It's Based on the HAL specification (GitHub link) and is using a wonderful WebApi implementation of HAL which can be found on GitHub: https://github.com/JakeGinnivan/WebApi.Hal

Installation

Umbraco REST API can be installed via Nuget:

Install-Package UmbracoCms.RestApi

This package will also install another add-on for Umbraco called Identity Extensions.

Once installed, a readme is displayed with a snippet of code to enable the REST API. This can be done using OWIN startup classes and because the IdentityExtensions package has been installed, a few classes have been added to your ~/App_Startup folder. The easiest way to enable the REST API is to copy the code snippet from the readme that is displayed:

app.ConfigureUmbracoRestApi(new UmbracoRestApiOptions()
	{
		//Modify the CorsPolicy as required
		CorsPolicy = new CorsPolicy()
            {
                AllowAnyHeader = true,
                AllowAnyMethod = true,
                AllowAnyOrigin = true
            }
	});

then open the file: ~/App_Startup/UmbracoStandardOwinStartup.cs

and paste this snippet just underneath this line of code: base.Configuration(app);

That's it, you've now enabled the REST API.

Discovery

A great way to browse Umbraco's REST service is to use the great html/javascript HAL Browser. The starting endpoints are:

• /umbraco/rest/v1/content
• /umbraco/rest/v1/media
• /umbraco/rest/v1/members
• /umbraco/rest/v1/relations

We will be enabling a single root endpoint that list these HAL links in the very near future!