List and search files

Lists all files in your Filerobot store. You can search by providing a search string. Can be recursive.

GET /v4/files

API permissions

OBJECTS_LIST

Query parameters

Parameter Type Default Description
q string optional Search pattern matching the file name or metadata.
folder string / optional Folder to start the search from. Case sensitive.
limit integer 1000 optional Specifies the maximum amount of files to return. [1-4000].
offset integer 0 optional Specifies the offset of files 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/fdocs' path: /v4/files method: GET parameters: folder: '/api-demo' limit: 50 offset: 0 order: 'filename,desc' variables: {} headers: X-Filerobot-Key: fa5fe3303dd34e1da4810915c7c3fd6f theme: clouds-midnight curlAPIKey: "" axiosTimeout: 35000 maxContentLength: 150000 render: curl_tab: true

Response

{
  "status": "success",
  "base": {
    "uuid": "7610923e-80d0-50e8-a2e4-c509be390158",
    "path": "/api-demo",
    "name": "api-demo",
    "meta": {},
    "visibility": "VISIBILITY_INHERIT",
    "updated_at": "2021-05-04T09:00:53Z",
    "created_at": "2021-05-04T09:00:53Z",
    "count": {
      "files_recursive": 5,
      "files_direct": 4
    },
    "size": {
      "total_recursive_bytes": 2656356,
      "total_recursive_pretty": "2.53 MB"
    },
    "public_icon": "https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"
  },
  "files": [
    {
      "uuid": "d04b0c9b-2193-5f94-83ba-aaf034450000",
      "name": "car2.jpg",
      "extension": "jpg",
      "size": {
        "bytes": 689847,
        "pretty": "673.68 KB"
      },
      "flags": {
        "auth": {
          "sass_decode": {
            "d": [
              "api.filerobot.com/fdocs",
              "fdocs.api.airstore.io"
            ],
            "p": "4611686020507556755",
            "st": "1620118816",
            "um": "22000",
            "age": "86400",
            "fid": "52",
            "umip": "22000",
            "umpm": "22000"
          },
          "filerobot_key": "SASS__v1.05__1UzN2UTN3ATNwIDM2gjNxEjN0oDcJITN6QWamlAMwQjN4oTZnFWCvlmLlJ3b0NncpFmLpBXYu0GdkFWczVnZc0GdkFWczVnZv02bj5CdvJ2byVGbpZmLpBXYboDZJADMwIjM6AXatVXCwADMyIjOtBXb1lAMwAjMyoTb1lgNxgDOxEDMyYTM6Q3c__de7addc5c9"
        },
        "flags": [],
        "product": null,
        "conflict_path_unicity_action": "VERSION",
        "conflict_sha1_unicity_action": "CONTINUE",
        "conflict_sha1_unicity_required": 0
      },
      "type": "image/jpeg",
      "info": {
        "img_h": 1210,
        "img_w": 1814,
        "img_type": "JPEG"
      },
      "meta": {
        "test key2": null,
        "test key3": null,
        "propro": null,
        "fthfth": null,
        "dsfgdfgfdg": null,
        "test_tags": null,
        "meta_key": null
      },
      "visibility": {
        "value": "VISIBILITY_INHERIT",
        "inherited": "VISIBILITY_PUBLIC",
        "set": "VISIBILITY_INHERIT",
        "actual": "VISIBILITY_PUBLIC"
      },
      "url": {
        "public": "https://store.filerobot.com/fdocs/api-demo/car2.jpg",
        "permalink": "https://api.filerobot.com/fdocs/v4/get/d04b0c9b-2193-5f94-83ba-aaf034450000",
        "cdn": "https://fdocs.filerobot.com/api-demo/car2.jpg?vh=578ea4",
        "path": "/api-demo/car2.jpg"
      },
      "hash": {
        "sha1": "578ea48be0de7fa1d458f6254a299520fa83dbe9",
        "blurhash": null
      },
      "created_at": "2021-05-04T09:01:47Z",
      "modified_at": "2021-05-04T09:01:50Z",
      "folder": {
        "uuid": "7610923e-80d0-50e8-a2e4-c509be390158",
        "name": "/api-demo"
      },
      "product": {
        "ref": null,
        "position": null
      }
    },

    ...

    {
      "uuid": "6c53bcde-9065-5fae-940a-7715b2d50000",
      "name": "car7.jpg",
      "extension": "jpg",
      "size": {
        "bytes": 451381,
        "pretty": "440.8 KB"
      },
      "flags": {
        "auth": {
          "sass_decode": {
            "d": [
              "api.filerobot.com/fdocs",
              "fdocs.api.airstore.io"
            ],
            "p": "4611686020507556755",
            "st": "1620118816",
            "um": "22000",
            "age": "86400",
            "fid": "52",
            "umip": "22000",
            "umpm": "22000"
          },
          "filerobot_key": "SASS__v1.05__1UzN2UTN3ATNwIDM2gjNxEjN0oDcJITN6QWamlAMwQjN4oTZnFWCvlmLlJ3b0NncpFmLpBXYu0GdkFWczVnZc0GdkFWczVnZv02bj5CdvJ2byVGbpZmLpBXYboDZJADMwIjM6AXatVXCwADMyIjOtBXb1lAMwAjMyoTb1lgNxgDOxEDMyYTM6Q3c__de7addc5c9"
        },
        "flags": [],
        "product": null,
        "conflict_path_unicity_action": "VERSION",
        "conflict_sha1_unicity_action": "CONTINUE",
        "conflict_sha1_unicity_required": 0
      },
      "type": "image/jpeg",
      "info": {
        "img_h": 1278,
        "img_w": 1920,
        "img_type": "JPEG"
      },
      "meta": {
        "test key2": null,
        "test key3": null,
        "propro": null,
        "fthfth": null,
        "dsfgdfgfdg": null,
        "test_tags": null,
        "meta_key": null
      },
      "visibility": {
        "value": "VISIBILITY_INHERIT",
        "inherited": "VISIBILITY_PUBLIC",
        "set": "VISIBILITY_INHERIT",
        "actual": "VISIBILITY_PUBLIC"
      },
      "url": {
        "public": "https://store.filerobot.com/fdocs/api-demo/car7.jpg",
        "permalink": "https://api.filerobot.com/fdocs/v4/get/6c53bcde-9065-5fae-940a-7715b2d50000",
        "cdn": "https://fdocs.filerobot.com/api-demo/car7.jpg?vh=f87f1c",
        "path": "/api-demo/car7.jpg"
      },
      "hash": {
        "sha1": "f87f1c2e708b1111aa8aa99640efec02aaeb130b",
        "blurhash": null
      },
      "created_at": "2021-05-04T09:01:46Z",
      "modified_at": "2021-05-04T09:01:48Z",
      "folder": {
        "uuid": "7610923e-80d0-50e8-a2e4-c509be390158",
        "name": "/api-demo"
      },
      "product": {
        "ref": null,
        "position": null
      }
    }
  ],
  "folders": [],
  "info": {
    "total_files_count": 4,
    "total_files_size": 2530340.0,
    "total_files_method": "COUNT_EXACT",
    "atom": "atom008",
    "response_time_s": 0.327
  }
}