Download a tar archive
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
pathgives one entry. A symlink to a directory aspatharchives 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
userwhen set. Settinguserneeds write access to the sandbox. - Served at the access endpoint of the sandbox (
access_endpointofGET /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 409sandbox_update_requireduntil 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.~namereturns 422.
See Download a folder in the guide for several paths, exclude, symlinks and failures.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Query Parameters
Entry to archive; repeat for more, at most 64
1 <= items <= 64"tar"Value in
- "tar"
- "tar.gz"
Skip entries that match; repeat for more, at most 64
items <= 64Response Body
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/sandboxes/string/files/archive?path=string"The body is not JSON: application/gzip, application/x-tar
{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}Delete a file or directory DELETE
Delete the entry at `path`. - A non-empty directory needs `recursive=true`, else 409 `directory_not_empty`. - A recursive delete removes a directory symlink and never follows it. - 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.
Download through a signed URL GET
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](https://docs.tektona.ai/files#share-a-file-with-a-signed-url) in the guide.