SandboxesFiles

Move a file or directory

Rename from to to.

  • An existing destination returns 409 already_exists, unless overwrite=true.
  • 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.
PUT
/v1/sandboxes/{sandboxId}/files/move
AuthorizationBearer <token>

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

In: header

Path Parameters

sandboxId*string

Sandbox ID (ULID)

Query Parameters

resume?boolean

Wake a paused sandbox to serve this request

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

from*string

Source path; a symlink is moved, not its target

Length1 <= length
overwrite?boolean

Replace an existing destination (atomic rename); otherwise 409 already_exists

to*string

Destination path; its parent directory must exist

Length1 <= length
user?string

Guest user to run as, by name or uid; defaults to the image user. Needs write access to the sandbox

Match^[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  }}