Search File(s)

Returns results containing files and directories matching the search criteria. The search is performed on the filename, meta and properties data.

GET /search

API Permissions

OBJECTS_LIST

Query Parameters

Parameter Type Default Description
q string [REQUIRED] Search pattern matching the file name or properties (tags).
dir string / [OPTIONAL] Directory to start the search from. Case sensitive.
limit intege 1000 [OPTIONAL] Specifies the maximum amount of files and directories to return. [1-4000].
offset integ 0 [OPTIONAL] Specifies the offset of files and directories to display.
mime mimeType None [OPTIONAL] Returns only files from specified mimeType.
order string filename [OPTIONAL] Order results by: updated_at created_at Append ,asc or ,desc to get ascending or descending results. Example: updated_at,desc

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com/fusqadtm' path: /search headers: Content-Type: 'application/json; charset=utf-8' X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca parameters: q: '*car*' dir: '*' limit: 10 order: 'filename,desc' theme: clouds-midnight editor_theme: clouds_midnight method: GET render: curl_tab: true

Response

{
    "status": "success",
    "files": [
        {
            "uuid": "a6ef3fa9-c9c2-5495-b530-e982b3c50000",
            "name": "car.jpeg",
            "size": 152756,
            "size_pretty": "149.18 KB",
            "type": "image/jpeg",
            "meta": {
                "img_h": 667,
                "img_w": 1000,
                "img_type": "JPEG"
            },
            "properties": {
                "lang": "en",
                "tags": [
                    "Land vehicle",
                    "Vehicle",
                    "Car",
                    "Mercedes-benz sls amg",
                    "Performance car",
                    "Sports car",
                    "Automotive design",
                    "Motor vehicle",
                    "Personal luxury car",
                    "Mercedes-benz"
                ],
                "search": " Land vehicle Vehicle Car Mercedes-benz sls amg Performance car Sports car Automotive design Motor vehicle Personal luxury car Mercedes-benz",
                "description": ""
            },
            "url_public": "https://store.filerobot.com/fusqadtm/car.jpeg?v=7139c2",
            "url_permalink": "https://api.filerobot.com/fusqadtm/v1/get/_/a6ef3fa9-c9c2-5495-b530-e982b3c50000/car.jpeg?v=7139c2",
            "sha1": "7139c2fce5a3ba35ae7ea6b3ecee51dc49793158",
            "created_at": "2019-06-10T17:24:39Z",
            "modified_at": "2019-06-10T19:13:18Z",
            "dir_uuid": "7e766397-b258-53b1-933a-a338503e7ebe",
            "dir_name": "/",
            "container": "airstore_094dd930_ccd3_4945_a051_a55b484678a8"
        }
    ],
    "directories": [],
    "info": {
        "total_files_count": 1,
        "total_files_method": "COUNT_EXACT",
        "atom": "atom009",
        "response_time": 0.052
    }
}