Skip to main content
GET
/
v1
/
machines
/
{id}
/
git
/
status
Parsed working-tree status
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "detached": true,
  "clean": true,
  "changed": [
    {
      "path": "<string>",
      "status": "<string>",
      "staged": true,
      "unstaged": true,
      "original_path": "<string>"
    }
  ],
  "branch": "<string>",
  "ahead": 123,
  "behind": 123
}

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Machine ID (e.g. mch_a1b2c3d4)

Query Parameters

path
string
required

Absolute path of the repository working tree.

Response

200 - application/json

Parsed git status

detached
boolean
required
clean
boolean
required
changed
object[]
required
branch
string

Current branch; omitted on detached HEAD.

ahead
integer<int32>
behind
integer<int32>