Restore git files
Restore files in the work tree (default), the index (staged), or both.
sourcedefaults to the index, or toHEADwithstaged.- Restored work tree changes are lost.
- Local git writes on one work tree run one at a time. A write through the files endpoints does not wait for them. After a timeout, the outcome is unknown: the command can have run.
- Runs in the sandbox as the image user. Needs write access to the sandbox, because git runs the repository's own config and filters.
- 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.
Paths relative to the work tree root, read literally (no globs)
1 <= itemsA directory inside the work tree: absolute, or relative to the sandbox working directory
"."Revision to restore from; defaults to the index, or HEAD with staged
^[^-\x00\n\r][^\x00\n\r]*$Restore the index
Restore the work tree; the default when staged is not set
Response Body
application/problem+json
curl -X PUT "https://example.com/v1/sandboxes/string/git/restore" \ -H "Content-Type: application/json" \ -d '{ "files": [ "string" ] }'No body.
{ "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"}Reset git HEAD PUT
Move the current branch to `ref` (default `HEAD`). - `mode` `soft` keeps the index and the work tree. `mixed` (default) resets the index. `hard` resets both and loses local changes. - With `files`, reset only those index entries (`mode` `mixed`). - Local git writes on one work tree run one at a time. A write through the files endpoints does not wait for them. After a timeout, the outcome is unknown: the command can have run. - Runs in the sandbox as the image user. Needs write access to the sandbox, because git runs the repository's own config and filters. - 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.
Set a git config value PUT
Write `key` to the repository config only, never the global config. - Allowed keys: `user.name`, `user.email`, `core.autocrlf`, `pull.rebase`, `init.defaultBranch`. - Local git writes on one work tree run one at a time. A write through the files endpoints does not wait for them. After a timeout, the outcome is unknown: the command can have run. - Runs in the sandbox as the image user. Needs write access to the sandbox, because git runs the repository's own config and filters. - 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.