Patches

GET

/patch_stack/{uuid}/patch/{change_id}/section/{section_code}

Get Patch Stack Uuid Patch Change Id Section Section Code

Return section for a patch

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

`section_code`
Required
string

Patch Section Code

Status code	Description
`200`	Return section for a patch
`401`	Unauthorized
`404`	Not found

curl -X GET "https://app.gitbutler.com/api/patch_stack/string/patch/string/section/string"

Butler_API_Entities_PatchSection model

{
  "id": "string",
  "section_type": "string",
  "identifier": "string",
  "title": "string",
  "version": "string",
  "type": "string",
  "code": "string",
  "data": "string",
  "position": "string"
}

PATCH

/patch_stack/{uuid}/patch/{change_id}/section/{section_code}

Patch Patch Stack Uuid Patch Change Id Section Section Code

Update section for a patch

Request Body (Optional)

`text`string

Section markdown text

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

`section_code`
Required
string

Patch Section Code

Status code	Description
`200`	Update section for a patch
`401`	Unauthorized
`404`	Not found

curl -X PATCH "https://app.gitbutler.com/api/patch_stack/string/patch/string/section/string" \
  -d '{
  "text": "string"
}'

Butler_API_Entities_PatchSection model

{
  "id": "string",
  "section_type": "string",
  "identifier": "string",
  "title": "string",
  "version": "string",
  "type": "string",
  "code": "string",
  "data": "string",
  "position": "string"
}

DELETE

/patch_stack/{uuid}/patch/{change_id}/section/{section_code}

Delete Patch Stack Uuid Patch Change Id Section Section Code

Delete section for a patch

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

`section_code`
Required
string

Patch Section Code

Status code	Description
`204`	Delete section for a patch
`401`	Unauthorized
`404`	Not found

curl -X DELETE "https://app.gitbutler.com/api/patch_stack/string/patch/string/section/string"

POST

/patch_stack/{uuid}/patch/{change_id}/section

Post Patch Stack Uuid Patch Change Id Section

Create new section for a patch

Request Body

`type`
Required
string

Section type

Value in: "text"

`text`string

Section markdown text

`position`integer

Where to insert the section

Format: "int32"

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

Status code	Description
`200`	Create new section for a patch
`401`	Unauthorized
`404`	Not found

curl -X POST "https://app.gitbutler.com/api/patch_stack/string/patch/string/section" \
  -d '{
  "type": "text",
  "text": "string",
  "position": 0
}'

Butler_API_Entities_PatchSection model

{
  "id": "string",
  "section_type": "string",
  "identifier": "string",
  "title": "string",
  "version": "string",
  "type": "string",
  "code": "string",
  "data": "string",
  "position": "string"
}

GET

/patch_stack/{uuid}/patch/{change_id}

Get Patch Stack Uuid Patch Change Id

Return sections for a patch

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

Status code	Description
`200`	Return sections for a patch
`401`	Unauthorized
`404`	Not found

curl -X GET "https://app.gitbutler.com/api/patch_stack/string/patch/string"

Butler_API_Entities_PatchWithFiles model

{
  "change_id": "string",
  "commit_sha": "string",
  "title": "string",
  "description": "string",
  "position": "string",
  "version": "string",
  "created_at": "string",
  "contributors": "string",
  "statistics": "string",
  "sections": "string"
}

PATCH

/patch_stack/{uuid}/patch/{change_id}

Patch Patch Stack Uuid Patch Change Id

Update patch in a patch stack

Request Body (Optional)

`section_order`array<string>

Order of sections in a patch stack (array of file paths and section codes)

Path Parameters

`uuid`
Required
string

Patch Stack UUID

`change_id`
Required
string

Patch Change ID

Status code	Description
`200`	Update patch in a patch stack
`401`	Unauthorized
`404`	Not found

curl -X PATCH "https://app.gitbutler.com/api/patch_stack/string/patch/string" \
  -d '{
  "section_order": [
    "string"
  ]
}'

Butler_API_Entities_PatchWithFiles model

{
  "change_id": "string",
  "commit_sha": "string",
  "title": "string",
  "description": "string",
  "position": "string",
  "version": "string",
  "created_at": "string",
  "contributors": "string",
  "statistics": "string",
  "sections": "string"
}

Patches

uuidRequiredstring

change_idRequiredstring

section_codeRequiredstring

Path

Response

Typescript

textstring

uuidRequiredstring

change_idRequiredstring

section_codeRequiredstring

Path

Body

Response

Typescript

uuidRequiredstring

change_idRequiredstring

section_codeRequiredstring

Path

typeRequiredstring

textstring

positioninteger

uuidRequiredstring

change_idRequiredstring

Path

Body

Response

Typescript

uuidRequiredstring

change_idRequiredstring

Path

Response

Typescript

section_orderarray<string>

uuidRequiredstring

change_idRequiredstring

Path

Body

Response

Typescript

`uuid`
Required
string

`change_id`
Required
string

`section_code`
Required
string

`text`string

`uuid`
Required
string

`change_id`
Required
string

`section_code`
Required
string

`uuid`
Required
string

`change_id`
Required
string

`section_code`
Required
string

`type`
Required
string

`text`string

`position`integer

`uuid`
Required
string

`change_id`
Required
string

`uuid`
Required
string

`change_id`
Required
string

`section_order`array<string>

`uuid`
Required
string

`change_id`
Required
string