Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Delete a specific role by id
Search
JUMP TO
Dataverse API
Access
Retrieve a zip of the datafile bundle identified by the file ID.
get
Retrieves datafile details based on given fileId
get
Retrieve auxiliary data for a specific datafile.
get
Retrieve details of a specific auxiliary data file
get
Create a new auxiliary data file for a particular data file
post
Delete a specific auxiliary data file
del
Retrieve auxiliary information of specific datafile
get
Retrieve metadata for a specific datafile
get
Retrieve DDI metadata for a specific datafile.
get
Grants access to a specific datafile using its ID and the identifier of the user
put
Retrieves a list of all requests relevant to a specified datafile
get
Reject access to specified datafile using ids
put
Requests access to a specific datafile by ID.
put
Revoke access to a specific file using its ID and an identifier
del
Retrieve the status of a user file access request
get
Retrieve user permissions for a specific datafile.
get
Uploads access details of a data file
post
Retrieve access data for specified files
get
Retrieve access information for a specific dataset
get
Retrieve specific version of an accessible dataset by ID
get
Retrieves the version-specific Data Card image
get
Fetch the Dataverse card image
get
Retrieves the card image for the specified file ID.
get
Update permission to allow access request based on the provided ID
put
Admin
Archives all unarchived dataset versions. Allows options to limit the number of versions archived, archive only the latest versions, or simply list the versions that would be archived without actually doing it.
post
Retrieve a specific assignee detail by ID.
get
Retrieve details of a specific assignee by raIdtf
get
Retrieves a list of authenticated users. This endpoint is deprecated.
get
Creates a new authenticated user.
post
Convert an authenticated user from built-in to OAuth
put
Convert Authenticated Users from Built-in system to Shibboleth
put
Delete an authenticated user by ID
del
Converts a remote user to a built-in user by their ID
put
Converts the authentication method of an authenticated user from Shibboleth to Built-In.
put
Deactivates an authenticated user by ID
post
Retrieve details of a specified authenticated user
get
Delete a specified authenticated user
del
Deactivate an authenticated user by identifier
post
Retrieve all authentication provider factories
get
Retrieve list of authentication providers
get
Add a new authentication provider
post
Fetch specific authentication provider using ID
get
Delete specific authentication provider using ID
del
Enable a specific authentication provider by its ID
post
Retrieves the status of a specific authentication provider
get
Updates the status of a specific authentication provider
put
Retrieve a current banner message
get
Add a new banner message
post
Delete a specific banner message by ID
del
Deactivates a specific banner message
put
Retrieve all batch jobs
get
Retrieve details for a job given its name
get
Retrieve details of a specific admin batch job
get
Deletes the metrics cache for admin
del
Deletes a specific metric cache.
del
Deletes a thumbnail failure flag
del
Delete the thumbnail failure flag for a specified Dataverse id
del
Computes the hash value of the specified file using the given algorithm
post
Retrieve Confirmation Email Associated with User ID
get
Send Confirmation Email to User ID
post
Convert a user's encryption scheme from Bcrypt to Sha1
post
Retrieve a limited number of records with missing original sizes and fix them
get
Retrieve a report of datafiles with missing original types and apply fixes
get
Retrieve the dataset fields available to administrators
get
Retrieve a list of controlled vocabulary subjects
get
Load dataset field as an admin
post
Retrieve North American controlled vocabulary value
get
Load dataset field property files as a ZIP.
post
Retrieve information of the specified dataset field
get
Update or recalculate dataset integrity by fixing missing UNF in specified dataset version
post
Retrieves thumbnail metadata for a specific dataset using its ID
get
Retrieve all curation label sets
get
Retrieves all storage drivers
get
Retrieve role assignments associated with a dataverse
get
Retrieve the curation label set of the specified Dataverse
get
Update or create a curation label set for the specified Dataverse
put
Remove the curation label set from the specified Dataverse
del
Retrieve the storage driver of a specific dataverse
get
Update the storage driver of a specific dataverse
put
Remove the storage driver of a specific dataverse
del
Retrieve a temporary file via its fully qualified path
get
Retrieve a list of all external tools
get
Create a new external tool
post
Retrieve an external tool by its ID
get
Delete an external tool by its ID
del
Create or post feedback as an admin
post
Retrieve domain-related groups information from the admin endpoint
get
Submit new domain-related groups information to the admin endpoint
post
Retrieves information of the group alias specified in the path
get
Updates the group alias specified in the path
put
Deletes the group alias specified in the path
del
Retrieve IP-based groups information
get
Create a new IP-based group
post
Fetches a group by the groupIdtf provided in the path
get
Deletes a group by the groupIdtf provided in the path
del
Retrieve information about Shibboleth groups
get
Create a new Shibboleth group
post
Delete a Shibboleth Group by given Primary Key
del
Retrieve details of admin index with queried parameters
get
Clears the admin index
get
Retrieve and clear orphans from the admin index
get
Continues the process of indexing partitions based on given parameters.
get
Retrieve the index of a dataset given its persistentId
get
Delete a specific dataset by its ID
del
Retrieve file metadata for a specific dataset
get
This endpoint retrieves data about file search index by persistentId, q, and/or semanticVersion.
get
Retrieves modification of the admin index based on provided query parameters
get
Retrieve permissions for the admin index
get
Retrieve a specific admin index permissions by ID
get
Retrieves permission debug info for specified id and key
get
Retrieve the Solr schema configuration.
get
Retrieve status of the admin index
get
Obtain specific parameters from the Admin Test Index
get
Delete timestamps from the admin index
del
Delete index timestamp by dvObjectId
del
Retrieves specific type and ID details in admin index
get
Retrieve ORCID status for a specific admin
get
Retrieve a list of all users
get
Add usage metrics from a SUSHI report
post
Send data count to the admin hub.
post
Add usage metrics for a specific Dataverse file from a SUSHI Report
post
Updates the citation count for a specified dataset
post
Retrieve the export timestamps
get
Fetches all metadata for export by admin
get
Update the OAI export specification using provided 'specname'
put
Retrieves and exports all metadata
get
Retrieves and re-exports the specific metadata for the dataset using dataset ID
get
Retrieve specific admin permission details
get
Publish Dataverse as creator using the given ID
post
Retrieve all registered data files from the admin.
get
Retrieve data file registration details for a given alias
get
Admin sends a request to receive a signed URL.
post
Retrieve a list of all admin roles
get
Create a new admin role
post
Delete a specific admin role
del
Retrieves all saved searches in the system.
get
Adds a new saved search to the system.
post
Retrieve a list of all saved searches by the administrator
get
Updates all saved search links
put
Updates the link for a specific saved search by ID
put
Retrieves a saved search by ID
get
Deletes a saved search by ID
del
Retrieve administrator settings
get
Retrieve a specified admin setting
get
Update a specified admin setting
put
Delete a specified admin setting
del
Update a specific Admin setting for a given language
put
Delete a specific Admin setting for a given language
del
Generate a new sitemap for the application
post
Fetches all storage sites
get
Creates a new storage site
post
Retrieves details of a specific storage site by its unique identifier
get
Deletes a specific storage site by its unique identifier
del
Update the primary storage of a storage site by ID
put
Submit a specific dataset version to the archive by using provided dataset ID and version number
post
Creates a new superuser with the provided identifier
post
Delete an admin template by ID
del
Retrieve all admin templates
get
Retrieve a specific admin template using its alias.
get
Gets an external tool associated with a specific dataset identified by its id
get
Retrieve the details of a specific external tool by its ID for a given file
get
Retrieve the external tools of a specific test file.
get
Retrieve hash values based on specified algorithm
get
Retrieve and validate specified dataset files
get
Validate a dataset with a specified ID
get
Validate datasets in the system
get
Validate hash value of the specified data file
post
Validates the password of an admin user
post
Retrieve all workflows associated with the admin
get
Create a new workflow for the admin
post
Fetch default workflow configured for admin
get
Retrieve a specific trigger type from workflows
get
Update a specific trigger type in workflows
put
Delete a specific trigger type from workflows
del
Retrieve current IP Whitelist for admin workflows
get
Update the IP Whitelist for admin workflows
put
Remove the IP Whitelist for admin workflows
del
Retrieve a specific workflow using its identifier
get
Retrieve data file details registered by a specific admin
get
Admin reruns the HDL to PID registration for a specific admin ID.
post
Application.wadl
Retrieves the application WADL
get
Retrieve the application WADL
get
Batch
Retrieves information about a batch harvest based on provided parameters
get
Retrieve status of a batch import request
get
Initiate a new batch import request
post
Initiate a batch job for importing datasets using the provided identifier
post
Builtin-users
Create a new builtin user
post
Create a new built-in user using a password and key
post
Create a new builtin-user with a specific key, password and email notification preference.
post
Gets the API token for the specified built-in user
get
Datasets
Retrieves export information of a dataset given its exporter and persistent ID
get
Retrieve a list of curation states for datasets
get
Retrieve information about locks on datasets
get
Modifies registration details for all datasets
post
Retrieve registration PID metadata of all datasets
get
Update a multi-part upload for a dataset using the provided global ID, storage identifier, and upload ID
put
Delete a multi-part upload for a dataset using the provided global ID, storage identifier, and upload ID
del
Retrieves a dataset version using a private URL token
get
Retrieve citation information for a dataset version via a private URL token
get
Retrieve names of summary fields in the dataset
get
Delete a link between a dataset and a dataverse
del
Retrieve a list of allowed curation labels for a specific dataset
get
Retrieves assignments for a specific dataset
get
Creates an assignment for a specific dataset
post
Delete a specific assignment for a dataset
del
Retrieves the curation label set of the specified dataset
get
Updates the curation label set of the specified dataset
put
Deletes the curation label set for the specified dataset
del
Validate checksum for specified dataset
post
Retrieve the Rsync data capture module for a specific dataset
get
Retrieves a guestbook entry for a specific dataset
get
Updates a guestbook entry for a specific dataset
put
Deletes a guestbook entry for a specific dataset
del
Lock a specific dataset identified by the given identifier and type
post
Retrieves specific dataset locks
get
Deletes specific dataset locks
del
Retrieve the details of a specific storage driver based on the provided identifier
get
Update the details of a specific storage driver based on the provided identifier
put
Delete a specific storage driver based on the provided identifier
del
Retrieves the storage size of a dataset based on its identifier. An optional query parameter can be used to include cached files.
get
Retrieves the timestamps for a given dataset identified by the path parameter 'identifier'
get
Retrieve the download size of a specific version of a dataset
get
Retrieve the specified dataset
get
Delete the specified dataset
del
Retrieve publishing details of a designated dataset
get
Publish a designated dataset with optional assurances
post
Release a migrated dataset with a specified ID
post
Add a new dataset to the existing record
post
Adds files to a specified dataset
post
Add globus files to a specific dataset
post
Update the citation date of a dataset based on dataset ID
put
Delete citation date of a dataset based on dataset ID
del
Get the status of the clean storage task for the specified dataset
get
Fetches the curation status of the specified dataset
get
Updates the curation status of the specified dataset
put
Deletes the curation status of the specified dataset
del
Update the metadata of a specific dataset
put
Delete a specific dataset by its ID.
del
Retrieve directory index of a dataset
get
Updates the metadata of a specific dataset represented by its ID
put
Set an embargo on a specific dataset's files
post
Unset embargo on files for a specific dataset
post
Retrieve the parameters for Globus download for a specified dataset
get
Retrieves Globus upload parameters for a specific dataset
get
Retrieves the links of a specified dataset
get
Retrieve the logo of a specific dataset
get
Retrieves the citation count for a specific dataset
get
Retrieve specific metrics for a specified dataset
get
Fetches a specific metric for a specific dataset
get
Retrieves the metadata of a dataset by its ID
get
Updates the metadata of a dataset by its ID, with an option to replace the existing metadata
put
Update the deletion status of the metadata of a specific dataset
put
Retrieve the modification details of a specific dataset registration
get
Modify the registration metadata of a specific dataset
post
Initiate the process to monitor a Globus download operation for a specific dataset
post
Moves a specific dataset to a target dataverse
post
Retrieve a specific dataset's private URL
get
Create a private URL for a specific dataset
post
Delete a specific dataset's private URL
del
Replace files in a specified dataset
post
Submit a request for Globus download for a specific dataset
post
Submit a request to get the paths for Globus file upload for a specified dataset
post
Returns the specified dataset back to its author
post
Submits a specified dataset for review
post
Retrieves a thumbnail from a specific dataset
get
Adds a thumbnail to a specific dataset
post
Deletes a thumbnail from a specific dataset
del
Retrieve the list of thumbnail candidates for a specific dataset
get
Upload a new thumbnail for a specific dataset
post
Retrieve the upload ID for the specified dataset
get
Retrieve upload URLs for a specific dataset
get
Retrieve user permissions for a specific dataset
get
Retrieve versions of a specific dataset
get
Fetches the dataset version details, with options to exclude files or include deaccessioned ones
get
Updates the dataset version with the given ID
put
Deletes the specified version of a dataset
del
Checks if a user has permission to download at least one file from a specific dataset version
get
Retrieve the citation of a specific dataset version
get
Retrieve a specific dataset version's custom license
get
Remove access to a specific version of a dataset
post
Fetches files within a specific version of a dataset
get
Retrieve counts of various types of files in a specified dataset version
get
Retrieve linkset of a specific dataset version
get
Retrieve the metadata of a specific version of a dataset
get
Retrieve metadata of a specified version of a dataset
get
Retrieve tool parameters of a specific version of a dataset
get
Retrieve the archival status of a specific version of a dataset
get
Update the archival status of a specific version of a dataset
put
Remove the archival status of a specific version of a dataset
del
Updates the link between a dataset and a Dataverse alias
put
Datatags
Create a new datatag and associate it with the specified unique cache ID
post
Dataverses
Create a new Dataverse
post
Retrieves a specified dataverse with the given identifier
get
Creates a new dataverse with the given identifier
post
Deletes a specified dataverse with the given identifier
del
Publishes the identified Dataverse
post
Retrieves assignments of specified Dataverse
get
Assigns new user or role to specified Dataverse
post
Delete a specific assignment from a specific dataverse
del
Update a specific attribute of a Dataverse identified by the given identifier
put
Retrieve contents of the specified Dataverse
get
Retrieve the schema of a specific dataset in the dataverse identified by the given identifier
get
Create a new dataset in the specified dataverse
post
Imports a dataset into a given Dataverse identifier
post
Imports DDI metadata to a dataset in the specified dataverse.
post
Begins the migration process of datasets in a specific Dataverse identified by the provided identifier
post
Update the default contributor role of a specific dataverse
put
Retrieves the facets of the specified dataverse
get
Updates the facets of the specified dataverse
post
Retrieves groups associated with a specified dataverse
get
Creates a new group in the specified dataverse
post
Retrieve details of a specific group within the given Dataverse
get
Update the details of a group within the specified Dataverse
put
Delete a specific group from the specified Dataverse
del
Assign a role to role assignees in a specified group within a dataverse
post
Update a specific role assignee in a dataverse group
put
Delete a specific role assignee from a dataverse group
del
Retrieve all guestbook responses for a specific dataverse
get
Retrieve all links associated with a specific dataverse identified by ID
get
Retrieve metadatablock facets for a specific dataverse
get
Add metadatablock facets to a specific dataverse
post
Updates the root status of a Dataverse
post
Retrieve the metadatablock of a Dataverse.
get
Create a new metadatablock for a Dataverse.
post
Retrieve metadata blocks for a specific dataverse identified by its unique identifier
get
Add or update metadata block associated with the specified dataverse identifier
post
Retrieve the roles for a given Dataverse identifier
get
Create a new role for a given Dataverse identifier
post
Retrieve storage quota of the dataverse identified by the given identifier
get
Delete the storage quota configuration for the dataverse identified by the given identifier
del
Sets the storage quota for a specific Dataverse
post
Retrieve storage usage of a specific dataverse
get
Retrieve the storage size of a specific Dataverse
get
Validate the JSON of a dataset in a specific Dataverse
post
Moves a Dataverse to a target Dataverse
post
Links one Dataverse to another
put
Delete a link between two dataverses
del
Edit
Edits the content of a specified file
put
Files
Retrieve the fixity algorithm of a file
get
Retrieve a specific file by ID.
get
Delete a specific file by ID.
del
Retrieve the data tables of a given file
get
Retrieve the download count of a file
get
Retrieve a file in draft mode by its ID
get
Extract Ncml information of a file based on the provided id
post
Check if specified file has been deleted
get
Retrieves metadata for a specific file
get
Updates metadata for a specific file
post
Adds new metadata categories for a specific file.
post
Retrieve the metadata of a draft file
get
Add tabular tags to a file metadata
post
Retrieves tool parameters for a specific file metadata ID
get
Retrieves the freeform provenance data for a specific file
get
Posts freeform provenance data for a specific file
post
Retrieving the PROV JSON of a specific file
get
Submit a new PROV JSON for a specific file
post
Delete the PROV JSON of a specific file
del
Invoke redetection process for the specified file
post
Reingest a file using its ID
post
Replace an existing file with a new version
post
Restrict access to a specific file
put
Uningest a file with the specified ID
post
Harvest
Retrieve all harvest clients based on the provided key
get
Retrieves a harvest client details based on the provided unique nickname and key
get
Updates an existing harvest client's details using the provided unique nickname and key
put
Creates a new harvest client using the provided unique nickname and key
post
Deletes a harvest client based on the provided unique nickname
del
Initiate a run for a specified Harvest client
post
Retrieve the OAISets from the harvest server
get
Adds a new OAI set to the harvest server
post
Retrieve details of a specific OAI set
get
Update details of a specific OAI set
put
Remove a specific OAI set
del
Retrieve datasets related to a specified OAISet
get
Inbox
Create a new inbox message
post
Info
Retrieve the terms of use of the API
get
Retrieve dataset metrics based on the data location and parent alias
get
Retrieve datasets by subject according to specified data location and parent alias
get
Retrieve monthly metrics for datasets by subject
get
Retrieve monthly metrics of datasets based on data location and parent alias.
get
Retrieve metrics of datasets from past specified days
get
Retrieve dataset metrics for a specific month
get
Retrieves metrics of dataverses based on parent alias
get
Retrieves metrics of dataverses sorted by category
get
Retrieve metrics of dataverses by subject
get
Retrieve the monthly metrics of a specific dataverse
get
Retrieves the number of dataverses created over the past specified number of days
get
Retrieve the metrics for dataverses up to the specified month.
get
Retrieve download metrics based on a parent alias.
get
Retrieve monthly download metrics
get
Retrieve download metrics for the past specified number of days
get
Retrieve download metrics till a specific month
get
Retrieve File Downloads Metrics
get
Retrieve the monthly count of file downloads
get
Retrieve file download metrics for a specific month
get
Retrieve metrics information for files
get
Retrieve file metrics information categorized by file type
get
Retrieve monthly metrics for files by type
get
Retrieve monthly metrics for files
get
Retrieve metrics for files from the past specified number of days
get
Retrieve files metrics information for a specific month
get
Retrieve specific metric data by country and parentAlias
get
Retrieve the monthly data count metrics identified by the provided metric name
get
Retrieves data metrics for a specific month
get
Fetches the metrics tree based on the provided parent alias
get
Retrieve monthly metrics for a specific alias
get
Retrieve unique download metrics data for a particular alias
get
Retrieve monthly unique downloads metrics
get
Retrieve the number of unique downloads for a specified month
get
Retrieve the number of unique file downloads
get
Retrieve the count of unique file downloads per month
get
Fetches unique file downloads up to a specific month
get
Retrieve OpenAPI info in specified output format
get
Retrieve server information
get
Retrieve the custom text for dataset publish popup.
get
Retrieve the maximum duration of embargo in months from the settings
get
Retrieves the status of incomplete metadata settings
get
Retrieve the current version information
get
Retrieve the current zip file download limit
get
Ingest
Retrieve details of a specific test file in the ingest process by filename and filetype
get
Licenses
Retrieve all the licenses
get
Add a new license
post
Fetch the current default license
get
Update a default license by ID
put
Retrieve a specific license by its ID
get
Delete a specific license by its ID
del
Updates the activity state of a specific license
put
Update the sort order of a given license
put
Logout
Log out the current user
post
Mail
Retrieve a list of mail notifications
get
Meta
Get metadata of a specific datafile by file id
get
Retrieves the metadata of a specific dataset by its ID
get
Metadatablocks
Retrieve metadata blocks available in the system
get
Retrieve a specific Metadatablock by its identifier
get
Mydata
Retrieve specific set of my data based on the provided filters
get
Notifications
Retrieve all notifications
get
Retrieve a list of muted email notifications
get
Updates a muted email notification by type name
put
Deletes a muted email notification by type name
del
Retrieve all muted notifications
get
Update details of a specific muted notification
put
Delete a specific muted notification
del
Delete a notification by ID
del
Pids
Retrieve a specific persistent identifier
get
Retrieves unreserved persistent identifiers
get
Delete a specific persistent identifier (PID)
del
Reserve a specific PID
post
Roles
Create a new role in the system
post
Retrieve details of a specific role by id
get
Delete a specific role by id
del
Search
Executes a search query with various parameters and returns the matching records.
get
Users
Retrieve the details of the logged-in user
get
Retrieves a user's authentication token
get
Deletes a user's authentication token
del
Recreates the authentication token for a given user
post
Merge the user with consumedIdentifier into the user with baseIdentifier
post
Change the identifier of a given user
post
Remove roles from a specific user
post
Retrieve a user's traces
get
Retrieve a specific trace element for a given user
get
Workflows
Initiate a workflow using the given invocation id
post
Powered by
Delete a specific role by id
delete
{protocol}://{base_url}/api/v1/roles/
{id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https
://
demo.dataverse.org
/api/v1/roles/{id}
RESPONSE
Click
Try It!
to start a request and see the response here!
