StorageConnectionService

ListFiles

List files in a storage connection. Supports prefix filtering and, when recursive is false, delimiter-based hierarchical listing.

get/v1/storage-connections/{storage_connection_id}/files

Request

  • Base URL: https://cloud-api.usw2.elembio.io
  • URL: https://cloud-api.usw2.elembio.io/v1/storage-connections/{storage_connection_id}/files
  • Auth: API key in header x-api-key

Path parameters

storage_connection_idstring required

The storage connection ID to browse

Query parameters

prefixstring

Path prefix relative to the storage connection's configured root, directory-shape with implicit trailing "/". The connection's saved sub-prefix (if any) is not part of this value — it's an implementation detail of the connection. Example: "A24-S2/run-001/". Round-trips with File.path. For an unrestricted key, optional: omitting it lists from the connection root. For a key scoped to a path prefix, a prefix WITHIN the scope is required: omitting it, or supplying one outside the scope, returns PermissionDenied with the allowed prefix(es) in the error (allowed_prefixes metadata).

recursiveboolean

If true, list all files recursively under the prefix (default: true) If false, list only files and subdirectories at the current level

pageSizeinteger

Maximum number of files to return per page (default: 1000, max: 1000) Note: This is passed through to the underlying storage system

pageTokenstring

Continuation token from previous response This is an opaque token from the underlying storage system

includeDownloadUrlboolean

If true, populate File.download_url (a presigned URL) on each returned file. Defaults to false. Set to true only when the caller intends to fetch file content from the response: generating presigned URLs has a per-object cost and the URLs themselves are credentials with a multi-hour lifetime. Use GetDownloadCredentials when long-lived bulk access is required.

downloadUrlExpirationSecondsinteger

Lifetime of the presigned download_url, in seconds. Optional; defaults to 1 hour. Only applies when include_download_url = true. Max 7 days.

includeDownloadChecksumboolean

If true, presign each download_url with S3 ChecksumMode=ENABLED so the object's stored checksum is returned on the GET (in the x-amz-checksum-<algo> response header) and a client can verify download integrity in a single streaming pass. Defaults false; has no effect unless include_download_url = true. When enabled the presigned URL signs the x-amz-checksum-mode request header, so the fetch MUST send x-amz-checksum-mode:ENABLED — a plain GET that omits it fails with HTTP 403. Best-effort: objects stored without a checksum return none.

Applies only to AWS S3-backed storage connections; other storage backends do not presign S3 GETs and silently ignore this field.

Response

Success

subdirectoriesstring[]

Subdirectories at this level (only populated when recursive=false). Namespace-relative, matching the request prefix. Example: ["A24-S2/", "A24-S2_other/"]

nextPageTokenstring

Continuation token for the next page (empty if no more results) This is an opaque token from the underlying storage system

isTruncatedboolean

Indicates if the results were truncated (more results available)

Example response

{
  "files": [
    {
      "lastModified": "2023-01-15T01:30:15.01Z"
    }
  ]
}

Changes

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