API Overview
Table 1 describes the KooDrive APIs.
| Type | API | Description |
|---|---|---|
| Query information about a user. | ||
| Modify information about a user. | ||
| Delete a user and the corresponding resources. | ||
| Query individual space information. | ||
| Delete a space. | ||
| Modify individual space information. | ||
| Query space usage overview, total number, total space capacity, and used total space. | ||
| Query the total allocated quota, total space, and total used space by allocated quota. | ||
| Query user space details by user. | ||
| Create a shared folder. | ||
| Delete a shared folder. | ||
| View the shared folders I created or joined. | ||
| Rename a shared folder. | ||
| View details about a shared folder. | ||
| Invite a member to join a shared folder. | ||
| Remove a member from a shared folder. | ||
| View the list of invitees. | ||
| View invitation details. | ||
| List members in a group. | ||
| Edit the alias of a group member. | ||
| Confirm whether to join a shared folder. | ||
| View the pending invitation list. | ||
| Update the notification status to read. | ||
| Query unread notifications. | ||
| Query audit logs. | ||
| Unbind devices. | ||
| List devices bound to a user. | ||
| Bind devices to a user. | ||
| View the module configuration information. | ||
| List all configuration information of a specified module. | ||
| Add the module configuration information. | ||
| Modify the module configuration information. | ||
| Add backup scopes of modules in batches. | ||
| Delete backup scopes of modules in batches. | ||
| List backup scopes. | ||
| Create a backup record. | ||
| Complete the backup. | ||
| Delete a backup record. The backup file is also deleted. | ||
| View backup records. | ||
| List backup files. | ||
| Create a backup file. | ||
| List backup records. | ||
| Create a backup lock with an expiration time of 10 minutes. | ||
| Backup lock renewal. The renewal duration for an expired backup lock starts from the expiration time. | ||
| Release a backup lock. | ||
| Create an album. | ||
| Update an album, including updating the album collection scope and type, and updating the name of the manual album. | ||
| Delete an album. | ||
| View an album (album list). | ||
| List album files. | ||
| Add album content. Add associated content to the manual album, instead of uploading files. | ||
| Remove contents from a manual album without deleting the original files. | ||
| Export bill information. | ||
| Check data. Carriers can download the reconciliation import template from the KooDrive official website, fill in data, and call this API to check data. | ||
| Query the reconciliation discrepancy list based on the reconciliation batch number returned by the data check API. | ||
| Register a user. | ||
| Create a batch provisioning task. | ||
| Query batch provisioning. | ||
| Verify the verification code. | ||
| Reset the password. | ||
| Change a password. | ||
| Modify user information. | ||
| Query user information. | ||
| Deregister a user. | ||
| Log in to the system. | ||
| Log out of the system. | ||
| Refresh authentication. | ||
| List compressed package directories. Data files need to be loaded to the Singapore node for processing. | ||
| List batch tasks. | ||
| Create a batch task. | ||
| Query details about a batch task. | ||
| Cancel a batch task whose status is 0 (to be processed) or 1 (processing). After the task is canceled, the task scheduling module ignores its record. | ||
| Notifying a User that a Package Expires and Enters the Grace or Retention Period | Notify a user that the package expires and enters the retention period. This function can be called only after the whitelist is added. | |
| Carrier reverse notification API – pay-per-use. | ||
| Modifying the Version Information of a Specified File or Version ID | Modify the version information of a specified file or version ID. Note: This API is used only to determine whether the version is permanently retained. | |
| Obtaining the Version Information of a Specified File or Version ID | Obtain the version information of a specified file or version ID. | |
| Deleting the Version Information of a Specified File or Version ID | Delete the version information of a specified file or version ID. Note: The latest version cannot be deleted. Only historical versions can be deleted. | |
| Create multiple historical versions. | ||
| Restoring the Version Information of a Specified File or Version ID | Restore the version information of a specified file or version ID. | |
| List all version information of a specified file. | ||
| This API is called after the complete data of a file is uploaded. The API checks the file integrity. If the file passes the check, the file upload is complete. | ||
| Obtain the retention period policy configuration list. | ||
| Set a new carrier retention period policy. | ||
| Query a carrier's retention period policy. | ||
| List files in an individual space. | ||
| Obtain file details, such as the file size, name, and modification time. | ||
| Obtain the operation record list of a file. | ||
| Add a file directory. | ||
| Create the metadata of the uploaded file. If flash upload is not hit, the upload process is triggered. If flash upload is hit, the file upload is complete. Data files need to be loaded to the Singapore node for processing. | ||
| Generate the upload link of a file part for multipart upload. | ||
| Check the file integrity after the service uploads the complete data of a file. If the file passes the check, the file upload is complete. Data files need to be loaded to the Singapore node for processing. | ||
| Obtain the download links of files. | ||
| Rename a file. | ||
| Add a custom tag to the file, overwriting the existing tag with the same name. | ||
| Create an asynchronous task to clear all files in the recycle bin of the space. | ||
| You can search for files or folders in the cloud space by file name or type. | ||
| Collect statistics on the number of directories, number of files, and total file size in a folder. | ||
| Obtain the full name and ID paths of a file. | ||
| Generate a document thumbnail. | ||
| Generate a video thumbnail. | ||
| Delete a custom tag of a file. | ||
| Obtain the link for previewing a file. | ||
| Obtain the link for previewing a shared file. | ||
| Add files to favorites or remove files from favorites. Up to 100 files are supported. | ||
| List files in favorites. Up to 100 files are supported each time. | ||
| Share a file. | ||
| Obtain sharing details. | ||
| List files shared by you. One sharing record occupies one line. When multiple files are shared, a folder with the first file name is displayed. When a single file is shared, the file information is displayed. | ||
| Modify sharing settings. | ||
| Stop sharing files. | ||
| Create an asynchronous sharing task. | ||
| Query the details about an asynchronous task. | ||
| List the files related to you. | ||
| List the files that you recently visited. | ||
| Access a sharing link shared by other users. (This function is available only to whitelisted users.) | ||
| Obtain the shared link information. (This function is available only to whitelisted users.) | ||
| Verify a sharing access code. (This function is available only to whitelisted users.) | ||
| List shared files. (This function is available only to whitelisted users.) | ||
| Obtain the download address of a single file in the sharing link. (This function is available only to whitelisted users.) |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
