v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Uploads

List uploads

get/uploads

Query parameters

pageSizenumber

Number of documents that will be returned

pagenumber

Page to search. Page numbering starts with 0.

sortBystring

Controls the sorting. Format: <field_name>.<asc|desc> (asc for ascending order, desc for descending order). If no order specified it will be in descending order.

expiredboolean

Set this to True to retrieve only the uploads that have expired. Set to False to retrieve only the ones that are not expired.

accountstring

Filter by account ID. The entire ID must match.

filenamestring

Filter by file name. This can ba a partial match.

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Response

Successful response

idstring required

createdAtstring date-time required

accountstring required

channelstring required

urlstring required

bucketstring required

filenamestring required

status'Active' | 'Deleted' required

expireInnumber required

Example response

[
  {
    "id": "61886612d37f875060b4749c",
    "createdAt": "2023-02-13T12:58:15.334Z",
    "account": "6189a359ef518ceb07fa5f19",
    "channel": "6189a359ef518ceb07fa5f19",
    "url": "https://fh-ondemand-dev-source.s3.amazonaws.com/5c926da8e117d200047d500e/5c9277169a57aca84e2cdced/6234f290f7583245aa6e7d3b_1647637136175?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQQ5MC3BWWNZ5MIQF%2F20220318%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220318T205856Z&X-Amz-Expires=3600&X-Amz-Signature=b3828b9829c41c8ac83c97b3c2012cfce8597aac72aa66c5a14b2f6b6c07a4b1&X-Amz-SignedHeaders=host",
    "bucket": "fh-image-source",
    "filename": "media.mp4",
    "status": "Active",
    "expireIn": 3600
  }
]