GitButler Logo
API Reference

Projects

GET
/projects/{repo_id}

Get Projects Repo Id

Return one project

Path Parameters

repo_id
Required
string

Repository ID

Status codeDescription
200Return one project
401Unauthorized
404Not found
/projects/{repo_id}

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

Butler_API_Entities_Project model

{
  "name": "string",
  "description": "string",
  "repository_id": "string",
  "code_repository_id": "string",
  "created_at": "string",
  "updated_at": "string"
}

DELETE
/projects/{repo_id}

Delete Projects Repo Id

Delete a project

Path Parameters

repo_id
Required
string

Repository ID

Status codeDescription
204Delete a project
401Unauthorized
404Not found
/projects/{repo_id}

curl -X DELETE "https://app.gitbutler.com/api/projects/string"
PUT
/projects/{repo_id}

Put Projects Repo Id

Update a project

Request Body (Optional)

namestring

Project name

descriptionstring

Project description

Path Parameters

repo_id
Required
integer

Format: "int32"
Status codeDescription
200Update a project
401Unauthorized
404Not found
/projects/{repo_id}

curl -X PUT "https://app.gitbutler.com/api/projects/0" \
  -d '{
  "name": "string",
  "description": "string"
}'

Butler_API_Entities_Project model

{
  "name": "string",
  "description": "string",
  "repository_id": "string",
  "code_repository_id": "string",
  "created_at": "string",
  "updated_at": "string"
}

GET
/projects

Get Projects

Return all projects

Status codeDescription
200Return all projects
401Unauthorized
404Not found
/projects
curl -X GET "https://app.gitbutler.com/api/projects"

Butler_API_Entities_Project model

{
  "name": "string",
  "description": "string",
  "repository_id": "string",
  "code_repository_id": "string",
  "created_at": "string",
  "updated_at": "string"
}

POST
/projects

Post Projects

Create a project

Request Body

name
Required
string

Project name

descriptionstring

Project description

directorystring

Project directory name

Status codeDescription
200Create a project
401Unauthorized
404Not found
/projects

curl -X POST "https://app.gitbutler.com/api/projects" \
  -d '{
  "name": "string",
  "description": "string",
  "directory": "string"
}'

Butler_API_Entities_Project model

{
  "name": "string",
  "description": "string",
  "repository_id": "string",
  "code_repository_id": "string",
  "created_at": "string",
  "updated_at": "string"
}

Previous

Patches

Next

Releases