Skip to main content
POST
/
v1
/
machines
/
{id}
/
git
/
pull
Pull from a remote
import requests

url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/git/pull"

payload = { "path": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "summary": "<string>"
}

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Machine ID (e.g. mch_a1b2c3d4)

Body

application/json
path
string
required
remote
string
default:origin
branch
string
set_upstream
boolean
default:false
auth
object

Per-operation git credentials. Materialised by the guest agent into an op-lifetime scratch path and removed when the operation completes; never persisted to durable guest state by these endpoints.

Response

200 - application/json

Pull result

summary
string
required

Human-readable summary git emitted for the push/pull.