List of files | Uploadcare docs

curl -G https://api.uploadcare.com/files/ \
     -H "Accept: application/vnd.uploadcare-v0.7+json" \
     -H "Authorization: <apiKey>" \
     -d include=appdata

{
  "next": "https://api.uploadcare.com/files/?limit=1&from=2018-11-27T01%3A00%3A43.001705%2B00%3A00&offset=0",
  "previous": "https://api.uploadcare.com/files/?limit=1&to=2018-11-27T01%3A00%3A36.436838%2B00%3A00&offset=0",
  "total": 2484,
  "totals": {
    "removed": 0,
    "stored": 2480,
    "unstored": 4
  },
  "per_page": 1,
  "results": [
    {
      "datetime_stored": "2018-11-26T12:49:10.477888Z",
      "datetime_uploaded": "2018-11-26T12:49:09.945335Z",
      "is_image": true,
      "is_ready": true,
      "mime_type": "image/jpeg",
      "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg",
      "original_filename": "pineapple.jpg",
      "size": 642,
      "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/",
      "uuid": "22240276-2f06-41f8-9411-755c8ce926ed",
      "content_info": {
        "mime": {
          "mime": "image/jpeg",
          "type": "image",
          "subtype": "jpeg"
        },
        "image": {
          "color_mode": "RGB",
          "orientation": 6,
          "format": "JPEG",
          "sequence": false,
          "height": 500,
          "width": 500,
          "geo_location": {
            "latitude": 55.62013611111111,
            "longitude": 37.66299166666666
          },
          "datetime_original": "2018-08-20T08:59:50",
          "dpi": [
            72,
            72
          ]
        }
      },
      "metadata": {
        "subsystem": "uploader",
        "pet": "cat"
      },
      "appdata": {
        "uc_clamav_virus_scan": {
          "datetime_created": "2021-09-21T11:24:33.159663Z",
          "datetime_updated": "2021-09-21T11:24:33.159663Z",
          "data": {
            "infected": true,
            "infected_with": "Win.Test.EICAR_HDB-1"
          },
          "version": "0.104.2"
        }
      }
    }
  ]
}

Getting a paginated list of files. If you need multiple results pages, use previous/next from the response to navigate back/forth.

Authentication

Authorizationstring

Every request made to https://api.uploadcare.com/ MUST be signed. HTTPS SHOULD be used with any authorization scheme.

Requests MUST contain the Authorization header defining auth-scheme and auth-param: Authorization: auth-scheme auth-param.

Every request MUST contain the Accept header identifying the REST API version: Accept: application/vnd.uploadcare-v0.7+json.

There are two available authorization schemes:

For production: Uploadcare, a scheme where a signature, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend.
For quick tests: Uploadcare.Simple, a simple scheme where your Secret API Key MUST be specified in every request’s auth-param.

Every request made to `https://api.uploadcare.com/` MUST be signed. HTTPS SHOULD be used with any authorization scheme. Requests MUST contain the `Authorization` header defining `auth-scheme` and `auth-param`: `Authorization: auth-scheme auth-param`. Every request MUST contain the `Accept` header identifying the REST API version: `Accept: application/vnd.uploadcare-v0.7+json`. There are two available authorization schemes: * For production: `Uploadcare`, a scheme where a `signature`, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend. * For quick tests: `Uploadcare.Simple`, a simple scheme where your [Secret API Key](https://app.uploadcare.com/projects/-/api-keys/) MUST be specified in every request's `auth-param`.

Query parameters

removedbooleanOptionalDefaults to false

true to only include removed files in the response, false to include existing files. Defaults to false.

storedbooleanOptional

true to only include files that were stored, false to include temporary ones. The default is unset: both stored and not stored files are returned.

limitintegerOptional1-1000Defaults to 100

A preferred amount of files in a list for a single response. Defaults to 100, while the maximum is 1000.

orderingenumOptionalDefaults to datetime_uploaded

Specifies the way files are sorted in a returned list. datetime_uploaded for ascending order, -datetime_uploaded for descending order.

Allowed values:

fromstringOptional

A starting point for filtering the files. If provided, the value MUST adhere to the ISO 8601 Extended Date/Time Format (YYYY-MM-DDTHH:MM:SSZ).

includestringOptional

Include additional fields to the file object, such as: appdata.

Response

A list of files, paginated.

nextstring or nullformat: "uri"

Next page URL.

previousstring or nullformat: "uri"

Previous page URL.

totalinteger>=0

Total number of the files of the queried type. The queried type depends on the stored and removed query parameters.

totalsobject

per_pageinteger

Number of the files per page.

resultslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

406

Not Acceptable Error

429

Too Many Requests Error

Authentication

Headers

Query parameters

Response

Errors