View Source

Class DeliveryApiSettings

Typed configuration options for Delivery API settings.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

public class DeliveryApiSettings

Properties

ApiKey

Gets or sets the API key used for authorizing API access (if the API is not publicly available) and preview access.

Declaration

public string ApiKey { get; set; }

Property Value

Type	Description
System.String	A string representing the API key.

DisallowedContentTypeAliases

Gets or sets the aliases of the content types that may never be exposed through the Delivery API. Content of these types will never be returned from any Delivery API endpoint, nor added to the query index.

Declaration

public string[] DisallowedContentTypeAliases { get; set; }

Property Value

Type	Description
System.String[]	The content type aliases that are not to be exposed.

Enabled

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

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	true if the Delivery API should be enabled; otherwise, false.

Media

Gets or sets the settings for the Media APIs of the Delivery API.

Declaration

public DeliveryApiSettings.MediaSettings Media { get; set; }

Property Value

Type	Description
DeliveryApiSettings.MediaSettings

MemberAuthorization

Gets or sets the member authorization settings for the Delivery API.

Declaration

public DeliveryApiSettings.MemberAuthorizationSettings MemberAuthorization { get; set; }

Property Value

Type	Description
DeliveryApiSettings.MemberAuthorizationSettings

PublicAccess

Gets or sets a value indicating whether 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 Delivery API should be publicly available; false if an API key should be required for access.

RichTextOutputAsJson

Gets or sets a value indicating whether the Delivery API should output rich text values as JSON instead of HTML.

Declaration

public bool RichTextOutputAsJson { get; set; }

Property Value

Type	Description
System.Boolean	true if the Delivery API should output rich text values as JSON; false they should be output as HTML (default).

Methods

MemberAuthorizationIsEnabled()

Gets a value indicating if any member authorization type is enabled for the Delivery API.

Declaration

public bool MemberAuthorizationIsEnabled()

Returns

Type	Description
System.Boolean

Remarks

This method is intended for future extension - see remark in DeliveryApiSettings.MemberAuthorizationSettings.