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_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.
Remote name
^[^-\x00\n\r][^\x00\n\r]*$A directory inside the work tree: absolute, or relative to the sandbox working directory
"."HTTPS remote URL without credentials. The project's Git Credentials authenticate it at the egress gateway
^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.
{ "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"}Write file content PUT
Stream bytes to a temporary file, then replace the target. - An interrupted transfer keeps the old file. - With `mode`, the file gets those permission bits before it replaces the target, so it never appears without them. Without `mode`, a replaced file keeps its mode. See [Write files](https://docs.tektona.ai/files#write-files) in the guide.
Check out a git ref PUT
Switch to a local branch, or detach `HEAD` at any other revision. - When the switch would overwrite local changes, it fails with `git_failed`. - 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.