SandboxesGit

Initialise a repository

Create a git repository at path, with initial_branch as the first branch, and return its root.

  • Git creates a missing directory.
  • 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/init
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.

initial_branch?string

Name of the first branch; defaults to the git default

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

Directory to initialise: absolute, or relative to the sandbox working directory. Git creates it when it is missing

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

Response Body

application/json

application/problem+json

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