Skip to content

Adding allow list data type configuration for 17 #7705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NillasKA merged 2 commits into from
Dec 12, 2025
Merged

Adding allow list data type configuration for 17 #7705

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe1229a
Refactor and addition
NillasKA Dec 10, 2025
66e023c
Update based on suggested changes
NillasKA Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion 17/umbraco-cms/reference/content-delivery-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
Expand All @@ -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.

<table><thead><tr><th width="340">Configuration key</th><th>Description</th></tr></thead><tbody><tr><td><code>PublicAccess</code></td><td>Determines whether the enabled Delivery API should be publicly accessible or if access should require an API key.</td></tr><tr><td><code>ApiKey</code></td><td>Specifies 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.</td></tr><tr><td><code>DisallowedContentTypeAliases</code> </td><td>Contains the aliases of the content types that should never be exposed through the Delivery API, regardless of any other configurations.</td></tr><tr><td><code>RichTextOutputAsJson</code></td><td>Enable 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.</td></tr></tbody></table>
<table>
<thead>
<tr>
<th width="340">Configuration key</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>PublicAccess</code></td>
<td>Determines whether the enabled Delivery API should be publicly accessible or if access should require an API key.</td>
</tr>
<tr>
<td><code>ApiKey</code></td>
<td>Specifies 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.</td>
</tr>
<tr>
<td><code>DisallowedContentTypeAliases</code></td>
<td>Contains the aliases of the content types that should never be exposed through the Delivery API.</td>
</tr>
<tr>
<td><code>AllowedContentTypeAliases</code></td>
<td>Contains the aliases of the content types that should be exposed through the Delivery API. This configuration takes precedence over the <code>DisallowedContentTypeAliases</code> 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 <code>DisallowedContentTypeAliases</code></td>
</tr>
<tr>
<td><code>RichTextOutputAsJson</code></td>
<td>Enable 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.</td>
</tr>
</tbody>
</table>

{% hint style="info" %}
**Are you using Umbraco Cloud?**
Expand Down