Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Routes

The filepack server responds to the following API routes:

methodpathdescription
POST/api/directory/{hash}Verify uploaded directory with hash.
GET/api/file/{hash}Serve file with hash.
PUT/api/file/{hash}Upload file with hash.
POST/api/gcDelete files, directories, packages, and revisions not reachable by package number.
HEAD/api/head/{revision}Check whether revision is the head of a package.
POST/api/missingReport which files the server lacks.
DELETE/api/number/{number}Delete package with number.
GET/api/number/{number}Return information about package with number.
GET/api/numbersList all package numbers.
HEAD/api/package/{fingerprint}Check whether package with fingerprint is present.
POST/api/package/{fingerprint}Verify uploaded package with fingerprint.
GET/api/packagesList all package fingerprints.
POST/api/revision/{revision}Verify uploaded revision and assign it a package number.

And the following web routes:

methodpathdescription
GET/Display all packages.
GET/artwork/{fingerprint}Serve cover art of package with fingerprint.
GET/artwork/{fingerprint}/thumbnailServe thumbnail of cover art of package with fingerprint.
GET/directory/{hash}Display entries of directory with hash.
GET/favicon.icoServe favicon.
GET/file/{hash}Serve file with hash.
GET/file/{hash}/{*path}Serve file with hash, with content type inferred from path, redirecting to /file/{hash} if the extension of path is not recognized.
GET/filesDisplay all files on the server.
GET/install.shServe installation script.
GET/media/audio/{fingerprint}/item/{item}Serve audio item of package with fingerprint.
GET/media/image/{fingerprint}/item/{item}Serve image item of package with fingerprint.
GET/media/image/{fingerprint}/item/{item}/thumbnailServe thumbnail of image item of package with fingerprint.
GET/media/video/{fingerprint}/item/{item}Serve video item of package with fingerprint.
GET/media/video/{fingerprint}/item/{item}/placeholderServe placeholder image of video item of package with fingerprint.
GET/media/video/{fingerprint}/item/{item}/placeholder/thumbnailServe thumbnail of placeholder image of video item of package with fingerprint.
GET/mount/{package}Redirect to root of mounted package, with trailing slash.
GET/mount/{package}/Serve index.html from static directory of mounted package.
GET/mount/{package}/{*path}Serve path from static directory of mounted package.
GET/package/{package}Display package.
GET/package/{package}/historyDisplay revision history of package.
GET/package/{package}/item/{item}Display media item of package.
GET/package/{package}/mediaDisplay media of package.
GET/packagesDisplay all packages.
GET/static/{*path}Serve static asset at path.