SandboxesGit

Reset git HEAD

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.
PUT
/v1/sandboxes/{sandboxId}/git/reset
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.

files?array<string>|

Paths relative to the work tree root, read literally. Reset these index entries only; needs mode mixed

mode?string

soft keeps index and work tree, mixed resets the index, hard resets both

Default"mixed"

Value in

  • "soft"
  • "mixed"
  • "hard"
path?string

A directory inside the work tree: absolute, or relative to the sandbox working directory

Default"."
ref?string

Revision to reset to; defaults to HEAD

Match^[^-\x00\n\r][^\x00\n\r]*$

Response Body

application/problem+json

curl -X PUT "https://example.com/v1/sandboxes/string/git/reset" \  -H "Content-Type: application/json" \  -d '{}'

No body.

Remove a git remote DELETE

Remove a remote and its remote-tracking branches. - A missing remote returns 404 `not_found`. - 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.

Restore git files PUT

Restore `files` in the work tree (default), the index (`staged`), or both. - `source` defaults to the index, or to `HEAD` with `staged`. - 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_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.