Push to a git remote
Push branch to remote.
- A push does not wait for the local git writes.
- 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.
- 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 branch; with a branch and no remote, the remote is origin
^[^-\x00\n\r][^\x00\n\r]*$Overwrite the remote branch only when it is still at the commit last fetched
A directory inside the work tree: absolute, or relative to the sandbox working directory
"."Remote name; defaults to the upstream of the current branch, else origin
^[^-\x00\n\r][^\x00\n\r]*$Set the pushed branch as the upstream
Response Body
application/problem+json
curl -X PUT "https://example.com/v1/sandboxes/string/git/push" \ -H "Content-Type: application/json" \ -d '{}'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"}Pull from a git remote PUT
Fetch from `remote` and merge into the current branch. With `rebase`, rebase onto it. - 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.
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.