SandboxesGit

Create a git branch

Create a branch at start_point. With checkout, switch to it.

  • 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.
POST
/v1/sandboxes/{sandboxId}/git/branches
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.

checkout?boolean

Switch to the new branch

name*string

New branch name; git check-ref-format --branch must accept it

Match^[^-\x00\n\r][^\x00\n\r]*$
path?string

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

Default"."
start_point?string

Revision the branch starts at; defaults to HEAD

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

Response Body

application/problem+json

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

No body.

Clone a repository POST

Clone `url` into `path` and return the root of the new work tree. - An HTTPS remote authenticates with the project's Git Credentials at the egress gateway. SSH remotes are not supported. The command stops after 4 minutes. - 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.

Create a git commit POST

Commit the staged changes and return the commit id. - Without `author_name` and `author_email`, the git config in the sandbox must set `user.name` and `user.email`, else 422 `git_identity_missing`. - When there is nothing to commit and `allow_empty` is not set, the commit returns 409 `nothing_to_commit`. `all` commits the changes to tracked files only, as `git commit --all` does. - The hooks of the repository run as the image user. - 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.