Skip to content

Commit fb8d483

Browse files
committed
doc for new header
1 parent 8cf3d7a commit fb8d483

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
### Improved efficiency for per-request Filters
22

33
This release improves the performance of Dataverse's per-request handling of CORS Headers and API calls
4+
5+
It also adds an 'X-Dataverse-unblock-key' that can be used instead of the less secure 'unblock-key' query parameter when the :BlockedApiPolicy is set to 'unblock-key'

doc/sphinx-guides/source/installation/config.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3610,6 +3610,7 @@ Out of the box, ``localhost-only`` is the default policy, as mentioned in :ref:`
36103610
- localhost-only: Allow from localhost.
36113611
- unblock-key: Require a key defined in :ref:`:BlockedApiKey`.
36123612
- drop: Disallow the blocked endpoints completely.
3613+
- allow: Opens the blocked endpoints completely. This is a security risk and should never be used without blocking done in a proxy managing Dataverse access from the Internet.
36133614

36143615
Below is an example of setting ``localhost-only``.
36153616

@@ -3637,7 +3638,9 @@ See the :ref:`list-of-dataverse-apis` for lists of API endpoints.
36373638

36383639
``curl -X PUT -d unblock-key http://localhost:8080/api/admin/settings/:BlockedApiPolicy``
36393640

3640-
Now that ``:BlockedApiKey`` has been enabled, blocked APIs can be accessed using the query parameter ``unblock-key=theKeyYouChose`` as in the example below.
3641+
Now that ``:BlockedApiKey`` has been enabled, blocked APIs can be accessed using the header ``X-Dataverse-unblock-key: theKeyYouChoose`` or, less securely, the query parameter ``unblock-key=theKeyYouChose`` as in the examples below.
3642+
3643+
``curl -H 'X-Dataverse-unblock-key:theKeyYouChoose' https://demo.dataverse.org/api/admin/settings``
36413644

36423645
``curl https://demo.dataverse.org/api/admin/settings?unblock-key=theKeyYouChose``
36433646

0 commit comments

Comments
 (0)