Search files in libraries

get

https://{server}/api2/search/

By providing an exact match or a vague match to the name, you can find files that match the search criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

required

keyword for searching.

page

integer

Defaults to 1

per_page

integer

search_repo

string

enum

Defaults to all

all, mine, shared, group, public or a repo_id, (all for searching in all libraries, etc.), optional. For searching in shared libraries, you can also pass shared_from or not_shared_from parameter beside shared to filter shared libraries.

Allowed:

search_path

string

path of specifiy library.(This option works only when search_repo is a single repo_id.)

search_ftypes

string

Defaults to all

all or custom, (all for searching all file types, custom for only searching the specific file types you defined in ftype and input_fexts).

ftype

string

must be in (Text, Document, Image, Video, Audio, PDF, Markdown).

TEXT: ('ac', 'am', 'bat', 'c', 'cc', 'cmake', 'cpp', 'cs', 'css', 'diff', 'el', 'h', 'html', 'htm', 'java', 'js', 'json', 'less', 'make', 'org', 'php', 'pl', 'properties', 'py', 'rb', 'scala', 'script', 'sh', 'sql', 'txt', 'text', 'tex', 'vi', 'vim', 'xhtml', 'xml', 'log', 'csv', 'groovy', 'rst', 'patch', 'go'),
DOCUMENT: ('doc', 'docx', 'ppt', 'pptx', 'odt', 'fodt', 'odp', 'fodp'),
IMAGE: ('gif', 'jpeg', 'jpg', 'png', 'ico', 'bmp', 'tif', 'tiff', 'eps'),
VIDEO: ('mp4', 'ogv', 'webm', 'mov'),
AUDIO: ('mp3', 'oga', 'ogg'),
PDF: ('pdf',),
MARKDOWN: ('markdown', 'md'),

with_permission

boolean

true or false. Whether return permission info of the file or not, default is false.

input_fexts

string

file extensions manually specific.

time_from

integer

filter the result that the updated time greater than or equal to this value. default unit is second.

time_to

integer

filter the result that the updated time less than or equal to this value. default unit is second.

size_from

string

filter the result that the size greater than or equal to this value. default unit is byte.

size_to

string

filter the result that the size less than or equal to this value. default unit is byte.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK