All Products
Search
Document Center

Drive and Photo Service:ScanFile

Last Updated:Aug 04, 2025

Scans files.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/file/scan HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request parameters.

drive_idstringYes

The drive ID.

1
limitintegerNo

The maximum number of results to return. Valid values: 1 to 100.

The number of returned results must be less than or equal to the specified number.

50
markerstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.
By default, this parameter is left empty.

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
fieldsstringNo

The file properties to return.

  • If you want to return all file properties, set this parameter to *.
  • By default, if you do not specify this parameter, the following properties of a file are returned: - file_id, - drive_id, - parent_file_id, - type, - created_at, - updated_at, - file_extention, - size, - starred, - status, - category, and - permissions.
  • You can also specify properties to return. Separate multiple properties with commas (,).
*

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

itemsarray

The information about the files.

File

The information about a file.

next_markerstring

A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

Error codes

For a list of error codes, visit the Service error codes.