API reference

Method reference

Call these update/query methods on the ICPay backend canister with Internet Identity or a bucket API key.

Canister ID: 6vbhm-nqaaa-aaaan-q6muq-cai. Sign in through ICPay or use @dfinity/agent with your Internet Identity delegation.

Method	Type	Auth
getBucketPrice	query	none
createBucket	update	owner
listBuckets	query	owner
getBucket	query	owner
getBucketStats	query	owner
getRenewQuote	query	owner
renewBucket	update	owner
updateBucket	update	owner
deleteBucket	update	owner
getBucketCycleStatus	query	none
getBucketCloudStats	query	none
uploadFile	update	owner / write key
beginFileUpload	update	owner / write key
uploadFileChunk	update	owner / write key
uploadFileChunkIndexed	update	owner / write key
completeFileUpload	update	owner / write key
getUpload	query	owner / write key
cancelUpload	update	owner / write key
downloadFile	update	owner / read key
getPublicFileUrl	query	none
listFiles	query	owner / read key
getFile	query	owner / read key
fileExists	query	owner / read key
listFolder	query	owner / read key
searchFiles	query	owner / read key
updateFile	update	owner / write key
moveFile	update	owner / write key
copyFile	update	owner / write key
deleteFile	update	owner / delete key
setFileTags	update	owner / write key
addFileTags	update	owner / write key
removeFileTags	update	owner / write key
getFileMetadata	query	owner / read key
setFileMetadata	update	owner / write key
bulkDeleteFiles	update	owner / delete key
bulkMoveFiles	update	owner / write key
bulkCopyFiles	update	owner / write key
createApiKey	update	owner
listApiKeys	query	owner
getApiKey	query	owner
updateApiKey	update	owner
regenerateApiKey	update	owner
revokeApiKey	update	owner