Move a file or directory
Rename from to to.
- An existing destination returns 409
already_exists, unlessoverwrite=true. - 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.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Sandbox ID (ULID)
Query Parameters
Wake a paused sandbox to serve this request
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Source path; a symlink is moved, not its target
1 <= lengthReplace an existing destination (atomic rename); otherwise 409 already_exists
Destination path; its parent directory must exist
1 <= lengthGuest user to run as, by name or uid; defaults to the image user. Needs write access to the sandbox
^[a-z_][a-z0-9_-]{0,31}$|^[0-9]{1,10}$Response Body
application/json
application/problem+json
curl -X PUT "https://example.com/v1/sandboxes/string/files/move" \ -H "Content-Type: application/json" \ -d '{ "from": "string", "to": "string" }'{ "entry": { "gid": 0, "group": "string", "mode": 0, "modified_at": "2019-08-24T14:15:22Z", "name": "string", "owner": "string", "path": "string", "size": 0, "symlink_target": "string", "type": "file", "uid": 0 }}{ "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"}Create a directory PUT
Create `path` and its missing parents, like `mkdir -p`. - An existing directory, or a symlink to one, returns `created=false` and keeps its mode. - Any other existing entry returns 409 `already_exists`. A parent that is a file returns 400 `not_a_directory`. - Needs write access to the sandbox. - 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.
Read file content GET
Stream the file bytes, at any size. - An unconditioned read of a file up to 1 MiB has a strong `ETag`. - A `Range` response has no `ETag`, unless `If-Range` carries the strong `ETag` of the file. Then the range comes with the `ETag`, and a file that changed meanwhile gets the whole file with 200. - `If-Range` with a date, a weak `ETag` or a file above 1 GiB always gets the whole file. See [Read files](https://docs.tektona.ai/files#read-files) in the guide.