Return JSON as default from and UmbracoApiController

So you'd like to stop the UmbracoApiController from returning XML and instead always return JSON, but you don't want to be doing some hacky workaround every time or modify the global applications settings?

I've made this attribute to be the answer to that question, apply it to any Api Controller and it'll remove the XmlFormatter for you.

Use this code to create attribute:

using System;
using System.Linq;
using System.Net.Http.Formatting;
using System.Web.Http.Controllers;

/// Applying this attribute to any Umbraco API Controller will ensure that it does not contain an xml formatter.
public class JsonOnlyConfigurationAttribute : Attribute, IControllerConfiguration
    public virtual void Initialize(HttpControllerSettings controllerSettings, HttpControllerDescriptor controllerDescriptor)
        var toRemove = controllerSettings.Formatters.Where(x => x is XmlMediaTypeFormatter).ToList();

        // Remove all xml formatters
        foreach (var y in toRemove)

The apply it to your controller like this:

public class MyController : UmbracoApiController

You're done, the controller will now return json by default.

Published at

Tags: Umbraco,Api,JSON,C#

Luke Alderton


Share with
Latest Comments
By Mark Gentry on Windows Server 2019 - Change product key does nothing
20 Aug 2021, 03:30 AM
By Cathy on In-Place Upgrade for a Windows Server domain controller
31 Jul 2021, 18:28 PM
By Mr. Greymatter on Raspberry Pi - Running Java app on Raspbian
16 Feb 2021, 07:35 AM
By Mikko Seittenranta on Xamarin Forms multiple instances of same app open
16 Feb 2021, 04:34 AM
By Andrew on Auto/Custom height on Xamarin Forms WebView for Android and iOS
22 Jan 2021, 22:15 PM
By Nick on Raspberry Pi - Running Java app on Raspbian
14 Oct 2020, 19:37 PM
By Ivan on Fixed: Value cannot be null Parameter Name: source
15 Sep 2020, 19:47 PM
By Anand on Raspberry Pi - Bluetooth using Bluecove on Raspbian
7 Sep 2020, 16:53 PM
App Development
Game Development
Web Development