API Reference
DiscoverWorkspaces

Request an archive of a published dataset (signed in)

post
https://api2.pennsieve.io/downloads/public/archives

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.
Archives of embargoed versions aren't available yet (422); download
them 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
polling the archive when it finished; email always; none never.

Allowed:
Responses

Updated about 1 hour ago

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

Updated about 1 hour ago

Did this page help you?