From fe1229a907552217bb78b6137445fa159fedcf70 Mon Sep 17 00:00:00 2001 From: NillasKA Date: Wed, 10 Dec 2025 13:40:33 +0100 Subject: [PATCH 1/2] Refactor and addition --- .../reference/content-delivery-api/README.md | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/17/umbraco-cms/reference/content-delivery-api/README.md b/17/umbraco-cms/reference/content-delivery-api/README.md index 66809fb59a2..88f034ffbfd 100644 --- a/17/umbraco-cms/reference/content-delivery-api/README.md +++ b/17/umbraco-cms/reference/content-delivery-api/README.md @@ -83,6 +83,7 @@ A few additional configuration options will allow you to restrict access to the "PublicAccess": true, "ApiKey": "my-api-key", "DisallowedContentTypeAliases": ["alias1", "alias2", "alias3"], + "AllowedContentTypeAliases": ["allowedAlias1", "allowedAlias2", "allowedAlias3"], "RichTextOutputAsJson": false } } @@ -93,7 +94,36 @@ A few additional configuration options will allow you to restrict access to the Find a description of each of the configuration keys in the table below. -
Configuration keyDescription
PublicAccessDetermines whether the enabled Delivery API should be publicly accessible or if access should require an API key.
ApiKeySpecifies the API key needed to authorize access to the API when public access is disabled. This setting is also used to access draft content for preview.
DisallowedContentTypeAliases Contains the aliases of the content types that should never be exposed through the Delivery API, regardless of any other configurations.
RichTextOutputAsJsonEnable outputting rich text content as JSON rather than the default HTML output. JSON can be a preferred format in many scenarios, not least because it supports the routing of internal links better than HTML does.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Configuration keyDescription
PublicAccessDetermines whether the enabled Delivery API should be publicly accessible or if access should require an API key.
ApiKeySpecifies the API key needed to authorize access to the API when public access is disabled. This setting is also used to access draft content for preview.
DisallowedContentTypeAliasesContains the aliases of the content types that should never be exposed through the Delivery API.
AllowedContentTypeAliasesContains the aliases of the content types that should be exposed through the Delivery API, this configuration takes precedence over the DisallowedContentTypeAliases so if there are any duplicates, they will be allowed regardless. Note that if this configuration contains any aliases, all other aliases will not be exposed through the Delivery API, if the configuration is empty, all aliases will be exposed, unless they are included in the DisallowedContentTypeAliases
RichTextOutputAsJsonEnable outputting rich text content as JSON rather than the default HTML output. JSON can be a preferred format in many scenarios, not least because it supports the routing of internal links better than HTML does.
{% hint style="info" %} **Are you using Umbraco Cloud?** From 66e023ca3668f4b9aba34502fe708e1a0d2e16b6 Mon Sep 17 00:00:00 2001 From: Nicklas Kramer Date: Wed, 10 Dec 2025 20:00:10 +0100 Subject: [PATCH 2/2] Update based on suggested changes Co-authored-by: Andy Butland --- 17/umbraco-cms/reference/content-delivery-api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/17/umbraco-cms/reference/content-delivery-api/README.md b/17/umbraco-cms/reference/content-delivery-api/README.md index 88f034ffbfd..21f30509602 100644 --- a/17/umbraco-cms/reference/content-delivery-api/README.md +++ b/17/umbraco-cms/reference/content-delivery-api/README.md @@ -116,7 +116,7 @@ Find a description of each of the configuration keys in the table below. AllowedContentTypeAliases - Contains the aliases of the content types that should be exposed through the Delivery API, this configuration takes precedence over the DisallowedContentTypeAliases so if there are any duplicates, they will be allowed regardless. Note that if this configuration contains any aliases, all other aliases will not be exposed through the Delivery API, if the configuration is empty, all aliases will be exposed, unless they are included in the DisallowedContentTypeAliases + Contains the aliases of the content types that should be exposed through the Delivery API. This configuration takes precedence over the DisallowedContentTypeAliases so if there are any duplicates, they will be allowed regardless. If this configuration contains any aliases, all other aliases will not be exposed through the Delivery API. If the configuration is empty, all aliases will be exposed, unless they are included in DisallowedContentTypeAliases RichTextOutputAsJson