Request an archive of a published dataset (signed in)

Starts building a zip of a published version, or of files and folders
of it, up to 10 GB; above that, use the Pennsieve agent. Poll
GET /public/archives/{id} until it's READY, then get a link. The
archive is kept for 72 hours.
Signed-in archives email you when they're ready (notify, as for
workspace archives); the email links to the dataset in Discover.
Embargoed versions work for users with access to them: their files
are listed when you ask, so a selection of more than 20,000 files is
refused (413); download it with the agent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
required

The published dataset's id.

A version number, or "latest" (the default).

paths
array of strings
length ≤ 1000

Files and folders of the version; [""] is the whole version.

paths
string

A folder all paths are in, left out of the paths in the archive.

string

File name for the archive; .zip is added when missing.

string
enum
Defaults to auto

When to email you the outcome. auto emails only if you weren't
watching when it finished: you hadn't asked for or polled the
archive in the 30 seconds before, so an archive ready almost at
once sends none; email always; none never.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json