GitButler Logo
API Reference

Patch Stack

PATCH
/patch_stack/{uuid}

Patch Patch Stack Uuid

Update patch stack

Request Body (Optional)

statusstring

Status of patch stack

Value in: "active" | "closed"

titlestring

Patch stack title

descriptionstring

Patch stack description

Path Parameters

uuid
Required
string

Patch Stack UUID

Status codeDescription
200Update patch stack
401Unauthorized
404Not found
/patch_stack/{uuid}

curl -X PATCH "https://app.gitbutler.com/api/patch_stack/string" \
  -d '{
  "status": "active",
  "title": "string",
  "description": "string"
}'
GET
/patch_stack/{project_id}/{branch_id}

Get Patch Stack Project Id Branch Id

Return latest patch stack for a branch

Path Parameters

project_id
Required
string

Repository ID

branch_id
Required
string

Branch ID

Query Parameters

event_idstring

Timeline Event ID to lock to

Status codeDescription
200Return latest patch stack for a branch
401Unauthorized
404Not found
/patch_stack/{project_id}/{branch_id}

curl -X GET "https://app.gitbutler.com/api/patch_stack/string/string?event_id=string"

Butler_API_Entities_PatchStack model

{
  "branch_id": "string",
  "oplog_sha": "string",
  "uuid": "string",
  "title": "string",
  "description": "string",
  "status": "string",
  "version": "string",
  "created_at": "string",
  "stack_size": "string",
  "contributors": "string",
  "patches": "string"
}

GET
/patch_stack/{project_id}

Get Patch Stack Project Id

Return list of patch stacks

Path Parameters

project_id
Required
string

Repository ID

Query Parameters

branch_idstring

Branch ID filter

statusstring

Status of patch stack

Default: "active"Value in: "active" | "inactive" | "closed" | "loading" | "all"
Status codeDescription
200Return list of patch stacks
401Unauthorized
404Not found
/patch_stack/{project_id}

curl -X GET "https://app.gitbutler.com/api/patch_stack/string?branch_id=string&status=active"

Butler_API_Entities_PatchStack model

{
  "branch_id": "string",
  "oplog_sha": "string",
  "uuid": "string",
  "title": "string",
  "description": "string",
  "status": "string",
  "version": "string",
  "created_at": "string",
  "stack_size": "string",
  "contributors": "string",
  "patches": "string"
}

POST
/patch_stack

Post Patch Stack

Create new patch stack

Request Body

project_id
Required
string

Repository ID

branch_id
Required
string

Branch ID

oplog_sha
Required
string

Timeline Event ID to create version from

Status codeDescription
200Create new patch stack
401Unauthorized
404Not found
/patch_stack

curl -X POST "https://app.gitbutler.com/api/patch_stack" \
  -d '{
  "project_id": "string",
  "branch_id": "string",
  "oplog_sha": "string"
}'

Butler_API_Entities_PatchStack model

{
  "branch_id": "string",
  "oplog_sha": "string",
  "uuid": "string",
  "title": "string",
  "description": "string",
  "status": "string",
  "version": "string",
  "created_at": "string",
  "stack_size": "string",
  "contributors": "string",
  "patches": "string"
}

Previous

Login

Next

Patches