SandboxesGit

Add a git remote

Add a remote with an HTTPS url that holds no credentials.

  • An existing name returns 409 already_exists.
  • 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/remotes
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.

name*string

Remote name

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

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

Default"."
url*string

HTTPS remote URL without credentials. The project's Git Credentials authenticate it at the egress gateway

Match^https://[^@\x00\n\r]+$

Response Body

application/problem+json

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

No body.