base url

https://api.cubby.moe

authentication

Authorization: your_api_key
GET/stats

retrieve general server statistics.

GET/view/album/:album_id

view the contents and metadata of an album.

parameters

album_idstringrequired

the unique identifier of the album.

passwordstringoptional

password to unlock the album if it is protected.

GET/paste/:pasteId

retrieve a paste by its id.

parameters

pasteIdstringrequired

the unique identifier of the paste.

GET/folders

list all folders belonging to you.

GET/files

list uploaded files. supports pagination and filtering by folder.

parameters

pagenumberoptional

the page number to retrieve.

folder_idstringoptional

filter files by a specific folder id.

GET/pastes

list pastes belonging to you.

parameters

pagenumberoptional

the page number to retrieve.

GET/albums

list albums belonging to you.

parameters

pagenumberoptional

the page number to retrieve.

POST/file/presign

obtain a presigned url to upload a file directly to storage.

parameters

filenamestringrequired

the name of the file being uploaded.

sizenumberrequired

the size of the file in bytes.

folder_idstringoptional

optional folder id to place the file into.

POST/file/confirm

confirm a file upload after it has been uploaded using a presigned url.

parameters

file_namestringrequired

the generated storage name of the file.

original_namestringrequired

the original name of the file.

folder_idstringoptional

optional folder id to confirm the file into.

POST/album/:albumId/presign

obtain a presigned url to upload a file specifically into an album.

parameters

albumIdstringrequired

the id of the album.

filenamestringrequired

the name of the file being uploaded.

sizenumberrequired

the size of the file in bytes.

ordernumberrequired

the order index of the file within the album.

POST/album/:albumId/confirm

confirm a file upload for an album after using the presigned url.

parameters

albumIdstringrequired

the id of the album.

file_namestringrequired

the generated storage name of the file.

original_namestringrequired

the original name of the file.

ordernumberrequired

the order index of the file within the album.

confirm_tokenstringrequired

token required to confirm the album file.

POST/folder

create a new folder.

parameters

namestringrequired

the name of the new folder.

parent_folderstringoptional

id of the parent folder, if nesting.

POST/paste

create a new text paste.

parameters

contentfilerequired

the text content of the paste.

captcha_tokenstringoptional

optional captcha token for unauthenticated pastes.

POST/album

create a new empty album.

parameters

file_countnumberrequired

the total number of files that will be uploaded to this album.

passwordstringoptional

optional password to protect the album.

album_namestringoptional

optional name for the album.

DELETE/file/:name

delete a file from your account.

parameters

namestringrequired

the generated storage name of the file to delete.

DELETE/album/:albumId

delete an album and all its associated files.

parameters

albumIdstringrequired

the id of the album to delete.

DELETE/paste/:pasteId

delete a paste.

parameters

pasteIdstringrequired

the id of the paste to delete.

PATCH/folder/:folder_id

update the name or parent of a folder.

parameters

folder_idstringrequired

the id of the folder to modify.

namestringoptional

the new name for the folder.

parent_folderstringoptional

the new parent folder id.

PATCH/file/:file_id

move a file to a different folder.

parameters

file_idstringrequired

the id of the file to update.

folder_idstringoptional

the id of the folder to move the file to.

PATCH/album/:album_id

update the name or expected file count of an album.

parameters

album_idstringrequired

the id of the album to update.

album_namestringoptional

the new name for the album.

file_countnumberoptional

the new expected total file count.