Git

List branches

GET/git/branches

Get a list of all branches in the Git repository

`application/json`

curl -X GET "https://example.com/git/branches?path=string"

{  "branches": [    "string"  ],  "current": "string"}

Clone a Git repository

POST/git/clone

Clone a Git repository to the specified path. Defaults to strict TLS verification; set insecure_skip_tls=true to skip verification for self-signed or private-CA Git servers.

Request Body

application/json

Clone repository request

TypeScript Definitions

Use the request body type in TypeScript.

branch?string

commit_id?string

depth?integer

Depth creates a shallow clone truncated to the given number of commits.

insecure_skip_tls?boolean

Skip TLS certificate verification for this clone. Defaults to false (verify). Set to true ONLY for trusted internal Git servers with self-signed or private-CA certs; credentials, if supplied, will be transmitted over an unverified TLS connection and are exposed to any MITM on the route.

password?string

path*string

url*string

username?string

Response Body

`application/json`

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

Empty

Commit changes

POST/git/commit

Commit staged changes to the Git repository

Request Body

application/json

Commit request

TypeScript Definitions

Use the request body type in TypeScript.

allow_empty?boolean

author*string

email*string

message*string

path*string

Response Body

`application/json`

curl -X POST "https://example.com/git/commit" \  -H "Content-Type: application/json" \  -d '{    "author": "string",    "email": "string",    "message": "string",    "path": "string"  }'

{  "hash": "string"}

Get a Git config value

GET/git/config

Get a Git config value at the given scope (null when unset)

Query Parameters

key*string

Config key (e.g. user.name)

path?string

Repository path (required for local scope)

scope?string

Config scope: global (default), local or system

Response Body

`application/json`

curl -X GET "https://example.com/git/config?key=string"

{  "value": "string"}

Set a Git config value

POST/git/config

Set a Git config key/value at the given scope

Request Body

application/json

Set config request

TypeScript Definitions

Use the request body type in TypeScript.

key*string

path?string

Path is the repository path, required when scope is "local".

scope?string

Scope is one of global (default), local or system.

value*string

Response Body

curl -X POST "https://example.com/git/config" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "value": "string"  }'

Empty

Configure Git user

POST/git/config/user

Configure the Git user name and email at the given scope

Request Body

application/json

Configure user request

TypeScript Definitions

Use the request body type in TypeScript.

email*string

name*string

path?string

Path is the repository path, required when scope is "local".

scope?string

Scope is one of global (default), local or system.

Response Body

curl -X POST "https://example.com/git/config/user" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "name": "string"  }'

Empty

Authenticate Git

POST/git/credentials

Persist Git credentials globally via the credential store. Stores the password in plaintext on disk.

Request Body

application/json

Authenticate request

TypeScript Definitions

Use the request body type in TypeScript.

host?string

Host defaults to github.com.

password*string

protocol?string

Protocol defaults to https.

username*string

Response Body

curl -X POST "https://example.com/git/credentials" \  -H "Content-Type: application/json" \  -d '{    "password": "string",    "username": "string"  }'

Empty

`application/json`

curl -X GET "https://example.com/git/history?path=string"

[  {    "author": "string",    "email": "string",    "hash": "string",    "message": "string",    "timestamp": "string"  }]

Initialize a Git repository

POST/git/init

Initialize a new Git repository at the specified path

Request Body

application/json

Init repository request

TypeScript Definitions

Use the request body type in TypeScript.

bare?boolean

Bare creates a repository without a working tree.

initial_branch?string

InitialBranch sets the name of the initial branch.

path*string

Response Body

curl -X POST "https://example.com/git/init" \  -H "Content-Type: application/json" \  -d '{    "path": "string"  }'

Empty

Pull changes from remote

POST/git/pull

Pull changes from the remote Git repository

Request Body

application/json

Pull request

TypeScript Definitions

Use the request body type in TypeScript.

branch?string

Branch to pull (defaults to the current branch's upstream).

password?string

path*string

remote?string

Remote to pull from (defaults to "origin").

username?string

Response Body

`application/json`

curl -X POST "https://example.com/git/pull" \  -H "Content-Type: application/json" \  -d '{    "path": "string"  }'

Empty

Push changes to remote

POST/git/push

Push local changes to the remote Git repository

Request Body

application/json

Push request

TypeScript Definitions

Use the request body type in TypeScript.

branch?string

Branch to push (defaults to the current branch).

password?string

path*string

remote?string

Remote to push to (defaults to "origin").

set_upstream?boolean

SetUpstream records the pushed branch as the upstream tracking branch.

username?string

Response Body

curl -X POST "https://example.com/git/push" \  -H "Content-Type: application/json" \  -d '{    "path": "string"  }'

Empty

`application/json`

curl -X GET "https://example.com/git/remotes?path=string"

{  "remotes": [    {      "name": "string",      "url": "string"    }  ]}

Add a remote

POST/git/remotes

Add (or overwrite) a remote in the Git repository

Request Body

application/json

Add remote request

TypeScript Definitions

Use the request body type in TypeScript.

fetch?boolean

Fetch fetches from the remote immediately after adding it.

name*string

overwrite?boolean

Overwrite replaces an existing remote with the same name.

path*string

url*string

Response Body

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

Empty

Reset repository

POST/git/reset

Reset the current HEAD to the specified state

Request Body

application/json

Reset request

TypeScript Definitions

Use the request body type in TypeScript.

files?array<string>

Files constrains the reset to the given paths.

mode?string

Mode is one of soft, mixed (default), hard, merge or keep.

path*string

target?string

Target is the revision to reset to (defaults to HEAD).

Response Body

curl -X POST "https://example.com/git/reset" \  -H "Content-Type: application/json" \  -d '{    "path": "string"  }'

Empty

Restore files

POST/git/restore

Restore working tree files or unstage changes

Request Body

application/json

Restore request

TypeScript Definitions

Use the request body type in TypeScript.

files*array<string>

path*string

source?string

Source restores file contents from the given revision instead of the index.

staged?boolean

Staged restores the staging index for the given files.

worktree?boolean

Worktree restores the working tree for the given files.

Response Body

`application/json`

curl -X POST "https://example.com/git/restore" \  -H "Content-Type: application/json" \  -d '{    "files": [      "string"    ],    "path": "string"  }'

Empty

`application/json`

curl -X GET "https://example.com/git/status?path=string"

{  "ahead": 0,  "behind": 0,  "branchPublished": true,  "currentBranch": "string",  "detached": true,  "fileStatus": [    {      "extra": "string",      "name": "string",      "staging": "Unmodified",      "worktree": "Unmodified"    }  ],  "upstream": "string"}

Git

200

400application/json

409application/json

500application/json

200application/json

404application/json

500application/json

201

400application/json

409application/json

500application/json

204

400application/json

404application/json

500application/json

200

400application/json

404application/json

409application/json

500application/json

200

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

409application/json

500application/json

200application/json

200

200

200

200application/json

404application/json

500application/json

201

200

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200

200application/json

201

200

200

400application/json

401application/json

403application/json

409application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`