Use the Resource and Data Exchange dataset using the API

Authenticated UVA users on an APPROVED IP (high security VPN, health system network, or Ivy VM) can interact with permissioned objects in the UVA RDE for Health Research Private Data Enclave via the browser interface or directly via an API that is hosted on UVA HIT servers. At this time, authentication through UVA netbadge is required every 12 hours and the authentication token much be collected from a browser once each session.

A swagger interface with sample code for the API is provided here: https://uvathriv.healthsystem.virginia.edu/docs#/

The RDE team is available to help you use this API from the command line for from analytics environments. Email rde_admin@virginia.edu for assistance. We have also provided a few samples below.

Example 1: Using the Private Data Enclave API with a Python script from Ivy VM:

1.From within your Ivy VM, set the proxy server as Address: http://felix-s.hpc.virginia.edu and Port 8080. Inside Chrome Settings, search for "proxy" and click "Open your computer's proxy settings" and set the proxy server under Manual proxy setup. NOTE: ONLY HAS TO BE DONE ONCE FOR INITIAL SETUP

2.Download the attached Python Script to your Ivy VM and set your destination path.

3.Get your dataset id:

  • Navigate to the project page in Private Commons.
  • Click on the dataset you need to download.
  • Get the dataset id
    • Example: if the dataset URL is https://health-research-uva.rdexchange.org/private-data-enclave/dataset/view/9b6cf42e-6be6-4b50-b0c3-5808d81e1adb  then the dataset_id is 9b6cf42e-6be6-4b50-b0c3-5808d81e1adb, that is, anything after /dataset/view/.

4.Getting your User Authentication token (only valid for 8 hours, repeat this step as needed):

  • Login to the UVA RDE for Health Research from any browser (on Ivy VM or on your machine).
  • In your browser, open DevTools (F12 for Chrome; or use right click and click Inspect).
  • Open the Console tab.
  • Copy your token by running 'localStorage.getItem('token')' in Chrome DevTools console. (You might have to scroll past the error messages.)

5. Paste the above two values in the provided Python script and run.

Attachments

Filename
Size
Date Modified
download_dataset_file.py2.29 KBJune 17, 2026 6:09 PM UTC
bulk export script.docx16.79 KBJune 17, 2026 6:10 PM UTC
download_dataset_file.py2.29 KBMay 16, 2026 4:38 AM UTC