KEkeboola
Files

List Files

Lists all files uploaded by your token. If the canReadAllFileUploads permission is set for your token, all file uploads for project will be returned.

Note: There can be a delay of up to one second before any file change is propagated into the list of files (including addition and removal of a file).

Filters are passed as query string parameters.

get/v2/storage/branch/{branchId}/files

Request

Path parameters

branchIdstring required

Query parameters

sinceIdstring

Shows only files after the specified Id.

maxIdstring

Shows only files before the passed Id.

tagsstring[]

Shows only files with one or more of the specified tags. Pass as an array, e.g. tags[]=tag1&tags[]=tag2.

qstring

Searches files using advanced Query string syntax.

runIdstring

Shows only files with the given run Id.

limitinteger

Pagination limit.

offsetinteger

Pagination offset.

showExpiredboolean

Include expired files in response.

Response

List of files.

idinteger required

Identifier of the file.

createdstring required

Creation time of the file, ISO 8601 with a +hhmm offset.

isPublicboolean required

Whether the file is publicly accessible via a direct URL.

isSlicedboolean required

Whether the file consists of multiple slices (chunks) described by a manifest file.

isEncryptedboolean required

Whether the file content is encrypted in the storage.

namestring required

Sanitized file name.

fileTypestring required

Human readable file type derived from the file name.

urlstring required

Pre-signed download URL of the file. The URL expires after one hour.

provider'aws' | 'azure' | 'gcp' required

File storage provider.

regionstring required

Region of the file storage.

sizeBytesinteger nullable required

File size in bytes, null when not known.

tagsstring[] required

Tags assigned to the file.

maxAgeDaysinteger nullable required

Number of days the file is kept before it expires. Null for permanent files.

runIdstring nullable required

Run ID taken from the X-KBC-RunId header when the file was created.

runIdsstring[] required

All run IDs derived from the hierarchical run ID.

Example response

[
  {
    "id": 236518631,
    "created": "2017-02-13T12:01:05+0100",
    "isEncrypted": true,
    "name": "somefile.csv",
    "fileType": "csv",
    "url": "https://s3.amazonaws.com/kbc-sapi-files/exp-180/578/files/2017/02/14/236518630.somefile.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=374...a4c",
    "provider": "aws",
    "region": "us-east-1",
    "sizeBytes": 12345,
    "tags": [
      "tag1",
      "tag2"
    ],
    "maxAgeDays": 15,
    "runIds": [],
    "creatorToken": {
      "id": 27978,
      "description": "dev@keboola.com"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.