Index of Supported API Calls

The following sections help you locate the information you need.

See API Calls by Name if you know the call you want to make but you need further information about it. See API Calls by Topic if you know what you want to do but you are not sure which call to use.

Both sections contain links to detailed information.

API Calls by Name

Calls are listed in alphabetical order within each interface. Note that there is not a one-to-one correspondence between calls in the two interfaces because the HTTP interface has fewer calls. Juxtaposition of the HTTP calls with the JSON-RPC calls in the following table is not meant to imply correspondence.

JSON-RPC Interface

API Call	Details
abortMultipart	Abort a Multipart Upload
authenticate	Log in to a Sub-directory
checkToken	Determine Your Token’s Age
completeMultipart	Complete a Multipart Upload
deleteDir	Delete a Directory
deleteFile	Delete a File
fetchFileHTTP	Copy a File
getMultipartStatus	Get Status for a Multipart Upload
getMultipartStatusMap	Get String Equivalents of Multipart Status Codes
initKeyPair	Initializing HMAC Key Pairs
listDir	List Directories
listFile	List Files
listMultipart	List Your Multipart Uploads
listMultipartPiece	List Pieces in a Multipart Upload
listPath	List Files and Directories
login	Log In
logout	Log Out
makeDir	Create a Directory
makeDir2	Create a Directory Along With Leading Paths
mediaVaultURL	Generate a URL
noop	Perform an Authenticated Server Verification
ping	Perform an Unauthenticated Server Verification
rename	Rename a File or Directory
restartMultipart	Restart a Multipart Upload
setContentType	Set a File’s Content Type
setMTime	Change a File or Directory Last Modification Time
stat	Obtain File or Directory Metadata
updateSession	Set Your Token’s Expiry

HTTP Interface

API Call	Details
account/login	Log In
multipart/complete	Complete a Multipart Upload
multipart/create	Begin a Multipart Upload
multipart-piece	Create a Multipart Piece
post/file	Web Browser Upload
post/raw	File Raw Post

API Calls by Topic

If you know what you want to do but you are not sure which call to use, refer to information in the following sections:

Authentication

Action	API Call	Details
Log in to Origin Storage	login /account/login (HTTP interface)	Log In Log In (HTTP interface)
Log into a specific sub-directory in Origin Storage	authenticate	Log in to a Sub-directory
Log out of Origin Storage	logout	Logging Out

Connections and Tokens

Calls are available in the JSON-RPC interface only.

Action	API Call	Details
Determine your token’s age	checkToken	Determine Your Token’s Age
Set your token’s expiry time	updateSession	Set Your Token’s Expiry
Verify the server API connection if you are logged in	noop	Perform an Authenticated Server Verification
Verify the server API connection if you are not logged in	ping	Perform an Unauthenticated Server Verification
Generate a new key pair for use in signing requests	initKeyPair	Initializing HMAC Key Pairs

Directories

Calls are available in the interface unless otherwise indicated.

To	Use this call	For instructions see
Change a directory’s last modified time	setMTime	Change a File or Directory Last Modification Time
Create a directory	makeDir /post/dir (HTTP interface)	Create a Directory Create a Directory (HTTP interface)
Create a directory and leading path segments	makeDir2	Create a Directory Along With Leading Paths
Delete a directory	deleteDir	Delete a Directory
List directories	listDir	List Directories
List directories and files	listPath	List Files and Directories
Obtain directory metadata	stat	Obtain File or Directory Metadata
Rename a directory	rename	Rename a File or Directory

Files

Calls are available in the JSON-RPC interface only.

To	Use this call	For instructions see
Change a file’s last modified time	setMTime	Change a File or Directory Last Modification Time
Copy a file	fetchFileHTTP	Copy a File
Delete a file	deleteFile	Delete a File
Generate a MediaVault URL	mediaVaultURL	Generate a MediaVault URL
List files	listFile	List Files
List directories and files	listPath	List Files and Directories
Obtain file metadata	stat	Obtain File or Directory Metadata
Rename a file	rename	Rename a File or Directory
Set a file’s content (MIME) type	setContentType	Set a File’s Content Type

File Upload - Non-Multipart

Calls are available in the HTTP interface only.

To	Use this call	For instructions see
Upload a file	/post/raw	File Raw Post
Web browser upload	/post/file	Web Browser Upload

File Upload - Multipart

Calls are available in the JSON-RPC interface unless otherwise indicated.

To	Use this call	For instructions see
Create a mulltipart upload	createMultipart POST to /multipart/create (HTTP interface)	Begin a Multipart Upload Begin a Multipart Upload (HTTP Interface)
Create a multipart piece	POST to /multipart/piece (HTTP interface)	Create a Multipart Piece
Get mapping of multipart status descriptions to integer codes	getMultipartStatusMap	Get String Equivalents of Multipart Status Codes
Get a list of pieces in a mulltipart upload	listMultipartPiece	List Pieces in a Multipart Upload
Get a list of mulltipart uploads started by your user	listMultipart	List Your Multipart Uploads
Get multipart upload status	getMulitpartStatus	Get Status for a Multipart Upload
Complete a multipart upload	completeMultipart POST to /multipart/complete (HTTP interface)	Complete a Multipart Upload Complete a Multipart Upload (HTTP interface)
Restart a multipart upload	restartMultipart	Restart a Multipart Upload
Abort a multipart upload	abortMultipart	Abort a Multipart Upload