Class DeliveryApiSettings.MediaSettings

Typed configuration options for the Media APIs of the Delivery API.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

public class MediaSettings

Remarks

The Delivery API settings (as configured in DeliveryApiSettings) supersede these settings in levels of restriction. I.e. the Media APIs cannot be enabled, if the Delivery API is disabled.

Properties

View Source

Enabled

Gets or sets a value indicating whether the Media APIs of the Delivery API should be enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the Media APIs should be enabled; otherwise, `false`.

Remarks

Setting this to true will have no effect if the Delivery API itself is disabled through DeliveryApiSettings

View Source

PublicAccess

Gets or sets a value indicating whether the Media APIs of the Delivery API (if enabled) should be publicly available or should require an API key for access.

Declaration

public bool PublicAccess { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the Media APIs should be publicly available; `false` if an API key should be required for access.

Remarks

Setting this to true will have no effect if the Delivery API itself has public access disabled through DeliveryApiSettings