Download files

The response of the get file API request contains a download url when a file is successfully uploaded, which can be used to download the file.

By default, download urls are valid for 60 minutes. The validity period can be customized by setting the urlDuration query parameter. The url duration may be between five minutes(5m) and seven days(7d).

Prerequisites

• A file should be created. To know more about uploading a file refer here

Direct Download

Request

1. Use the download=true query parameter to download a file directly. This will redirect to the file download URL allowing direct file access.

GET {baseUrl}/spaces/{spaceId}/files/{fileId}?download=true

2. Or by file path:

GET {baseUrl}/spaces/{spaceId}/files?path={filePath}&download=true

Response

There will be no data in the body of the response when downloading a file.

Get Download URL

Request

1. Get the download URL for an existing file (by file ID):

GET {baseUrl}/spaces/{spaceId}/files/{fileId}?urlDuration=5m&complete=true

• HEADER:

  • Authorization: Bearer {tid token}

Response

Example response:

{
       "id": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
       "resourceTrn": "trn:2:fileservice:<region>:file:e28982f5-ebd8-4a76-97f4-0783fc143f30",
       "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
       "spaceTrn": "trn:2:fileservice:<region>:space:f85bc802-5481-4581-b972-c4652d595ec7",
       "name": "FileName.ext",
       "acl": {
       "contentManager": [],
       "contentContributor": [],
       "contentViewer": []
       },
       "createdAt": "2023-05-30T10:30:00Z",
       "createdByTrn": "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
       "updatedAt": "2023-05-30T10:30:00Z",
       "updatedByTrn": "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
       "deleted": false,
       "parentId": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
       "path": "testA/testB/",
       "version": "1.2",
       "fileset": false,
       "restrictedAccess": false,
       "expiresAt": "2024-01-01T12:25:00.000Z",
       "metadata": {
       "language": "Suomi"
       },
       "download": {
       "url": "https://example.com/download/12345678-90ab-cdef-1234-567890abcdef.1"
       },
       "multipart": false,
       "responseHeaders": {
       "response-content-type": "image/jpeg",
       "response-content-disposition": "inline",
       "response-cache-control": "max-age=3000"
       },
       "malwareScanStatus": "CLEAN",
       "lastMalwareScanDate": "2023-05-30T10:30:00Z",
       "size": 1024,
       permissionsInherited": {
           "acl": [
               {
                   "actor": "trn:tid:application:67996eef-3d72-4925-aac3-4f70d006cddc",
                   "inheritedFrom": "794134f3-a705-49cc-bfb1-87b09950cf92",
                   "inheritedFromTrn": "trn:2:fileservice:<region>:space:f85bc802-5481-4581-b972-c4652d595ec7",
                   "role": "contentManager"
               },
               {
                   "actor": "trn:tid:application:67996eef-3d72-4925-aac3-4f70d006cddc",
                   "inheritedFrom": "794134f3-a705-49cc-bfb1-87b09950cf92",
                   "inheritedFromTrn": "trn:2:fileservice:<region>:space:f85bc802-5481-4581-b972-c4652d595ec7",
                   "role": "spaceManager"
               }
           ]
       },
       "capabilities": {
           "canCreate": true,
           "canDelete": true,
           "canLock": true,
           "canManageAccess": true,
           "canRead": true,
           "canUnlock": true,
           "canUpdate": true
       },
   }

2. Use the download URL to access the file:

   GET {DOWNLOAD URL}

   —OR—

   Use a browser to go to the download URL.

   Limitations

   • The overall size limit of a file download is 50 GB. To download larger files use ranged GET requests.

For more information on files, see Upload a file.