API Dokumentation

Search files in libraries

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

Full-text and file name search across the libraries the user can access (requires the search index on the server). Returns 404 Search not supported. if no search backend is configured and 403 on non-Pro servers.

SecureCloud 13.0 supports two search backends; which one is used depends on the server configuration:

  • Elasticsearch (classic): all parameters are supported, paging via page/per_page, total and has_more as documented.
  • the alternative search backend: only search_repo=all or a library ID are supported; at most per_page results are returned, page is ignored, has_more is always false and total is the number of returned results. The result fields can differ.

Items in folders shared with permission invisible are not returned. Wiki libraries are excluded from the search.

Since SecureCloud 13.0, q is no longer checked by the server (no 400 q invalid. anymore); always pass a keyword.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search keyword.

string
Defaults to all

Scope: all, mine, shared, group, public or a library ID. With the the alternative search backend backend only all or a library ID.

string

Folder to search in. Only allowed if search_repo is a library ID; the folder must exist.

string
enum
Defaults to false

true = only match file/folder names, not content.

Allowed:
string
enum

Only return file or dir.

Allowed:
string
enum
Defaults to all

all = all file types, custom = only the types given in ftype/input_fexts.

Allowed:
ftype
array of strings

File type group (only with search_ftypes=custom); repeat the parameter for several groups. Case-sensitive values:

  • Text, Document (doc, docx, ppt, pptx, odt, fodt, odp, fodp), SpreadSheet (xls, xlsx, ods, fods), Image, SVG, PDF, Markdown, Video, Audio, 3D (stl, obj), SDoc (sdoc).
ftype
string

Comma-separated file extensions (only with search_ftypes=custom), e.g. md,txt.

string
enum
Defaults to false

true = add the user's library permission (permission) to each result (Elasticsearch backend).

Allowed:
integer

Only items modified at or after this Unix timestamp (seconds).

integer

Only items modified at or before this Unix timestamp (seconds).

integer

Minimum size in bytes.

integer

Maximum size in bytes.

string

Only with search_repo=shared: only libraries shared by this user (user ID).

string

Only with search_repo=shared: exclude libraries shared by this user (user ID).

integer
Defaults to 1

Page number (Elasticsearch backend).

integer
≤ 100
Defaults to 10

Results per page, max. 100.

Responses

Updated 21 days ago

Did this page help you?
Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?