SandboxesFiles

Download through a signed URL

Serve the file of a GET signed URL.

  • The ETag, If-None-Match, Range and If-Range rules of GET files/content apply.
  • A URL with format serves the archive of its path, like GET files/archive.
  • Needs no other credential.
  • Served at the access endpoint. The mint returns the full URL.

See Share a file with a signed URL in the guide.

GET
/v1/files/signed
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Query Parameters

token*string

The token from the signed URL

Header Parameters

If-None-Match?string
Range?string
If-Range?string

Response Body

application/octet-stream

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/files/signed?token=string"

The body is not JSON: application/gzip, application/octet-stream, application/x-tar

Download a tar archive GET

Stream the tree at `path` as a tar or tar.gz archive. Names are relative to `path`, and a directory name ends in `/`. - A file `path` gives one entry. A symlink to a directory as `path` archives the children of the target. - A file that grows during the read sends its first part. A file that shrinks fails the archive. An entry that disappears during the walk is skipped. - Each entry header holds the mode, the uid and gid, the owner and group names, and the mtime. - The download takes one transfer slot and stops after 60 seconds without progress. - Runs in the sandbox as the image user, or as `user` when set. Setting `user` needs write access to the sandbox. - Served at the access endpoint of the sandbox (`access_endpoint` of `GET /v1/sandboxes/{sandboxId}`), not at the API host. - A paused sandbox returns 409, unless `resume=true`. A sandbox that started before its files server existed returns 409 `sandbox_update_required` until it restarts. - A refused operation returns its code as the problem type. - A path that starts with `~` or `~/` names the home directory of the user that the operation runs as. `~name` returns 422. See [Download a folder](https://docs.tektona.ai/files#download-a-folder) in the guide for several paths, `exclude`, symlinks and failures.

List files GET

Return the entry at `path` and, down to `depth`, the entries under it. - The listing is one traversal, not one snapshot. It walks depth first: each folder is followed by its entries, and names sort in byte order. - Symlinks are never followed. A broken link is listed. - `exclude` and `gitignore` skip an entry and everything under it. A skipped entry does not count against `limit`. - With `gitignore`, a work tree in which git ignores more than 20000 paths fails with 413 `too_large`. Use `exclude` there. - A listing with more than `limit` entries returns `pagination.next_cursor`. Pass it as `cursor`, with the same other parameters, to list the next page. An entry added after the cursor position shows up on a later page; one added before it is missed. - `truncated_paths` names the folders that miss entries that no page returns: a cut at `per_dir_limit`, a folder above 100,000 entries, or a folder that the user cannot read. - Runs in the sandbox as the image user, or as `user` when set. Setting `user` needs write access to the sandbox. - Served at the access endpoint of the sandbox (`access_endpoint` of `GET /v1/sandboxes/{sandboxId}`), not at the API host. - A paused sandbox returns 409, unless `resume=true`. A sandbox that started before its files server existed returns 409 `sandbox_update_required` until it restarts. - A refused operation returns its code as the problem type. - A path that starts with `~` or `~/` names the home directory of the user that the operation runs as. `~name` returns 422. See [Read files](https://docs.tektona.ai/files#read-files) in the guide.