Skip to content

correct instructions for blocking API endpoints #12636

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

Open
pdurbin wants to merge 3 commits into
base: develop
Choose a base branch
from
+19 −2
Open

correct instructions for blocking API endpoints #12636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27ad4a3
correct instructions for blocking API endpoints #12232
pdurbin Aug 21, 2026
70258b0
add release note snippet #12232
pdurbin Aug 21, 2026
67b96ec
typo
pdurbin Aug 21, 2026
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
17 changes: 17 additions & 0 deletions doc/release-notes/12232-block-api-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Upgrade Instructions

1. Ensure API endpoints are blocked

It is very important for the "admin" API endpoint to be blocked. Additionally, we recommend blocking the "builtin-users" endpoint. See [the guides](https://guides.dataverse.org/en/6.12/installation/config.html#blocking-api-endpoints) for details.

In the command below, replace "demo.dataverse.org" with the name of your server. Do the check remotely, not from the server itself.

`curl https://demo.dataverse.org/api/admin/settings`

If you can see your settings, follow the instructions in [the guides](https://guides.dataverse.org/en/6.12/installation/config.html#blocking-api-endpoints) to block API endpoints.

Please note that as reported in #12232, versions of the guides from 6.7 through 6.11 incorrectly described how to configure the setting `dataverse.api.blocked.endpoints`. This was fixed in pull request #12636 for the 6.12 guides. The following is the correct command to use:

`asadmin create-jvm-options '-Ddataverse.api.blocked.endpoints=admin,builtin-users'`

That is, the comma-separated list should be "admin,builtin-users" and not "api/admin,api/builtin-users" as described in previous versions of the guides.
4 changes: 2 additions & 2 deletions doc/sphinx-guides/source/installation/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3394,11 +3394,11 @@ dataverse.api.blocked.endpoints

A comma-separated list of API endpoints that should be blocked. A minimal example that blocks endpoints for security reasons:

``./asadmin create-jvm-options '-Ddataverse.api.blocked.endpoints=api/admin,api/builtin-users'``
``./asadmin create-jvm-options '-Ddataverse.api.blocked.endpoints=admin,builtin-users'``

Another example:

``./asadmin create-jvm-options '-Ddataverse.api.blocked.endpoints=api/admin,api/builtin-users,api/datasets/:persistentId/versions/:versionId/files,api/files/:id'``
``./asadmin create-jvm-options '-Ddataverse.api.blocked.endpoints=admin,builtin-users,datasets/:persistentId/versions/:versionId/files,files/:id'``

Defaults to an empty string (no endpoints blocked), but, in almost all cases, should include at least ``admin, builtin-users`` as a security measure.

Expand Down