GitButler Logo
API Reference

Projects

Operations about projects

GET
/projects/{repo_id}

Get Projects Repo Id

Return one project

/projects/{repo_id}

Path Parameters

repo_id
Required
string

Repository ID

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

Return one project

{
  "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

/projects/{repo_id}

Path Parameters

repo_id
Required
string

Repository ID

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

Delete a project

PUT
/projects/{repo_id}

Put Projects Repo Id

Update a project

/projects/{repo_id}

Request Body

application/jsonOptional

namestring

Project name

descriptionstring

Project description

Path Parameters

repo_id
Required
integer

Format: "int32"
curl -X PUT "https://app.gitbutler.com/api/projects/0" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string"
  }'

Update a project

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

GET
/projects

Get Projects

Return all projects

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

Return all projects

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

POST
/projects

Post Projects

Create a project

/projects

Request Body

application/jsonRequired

name
Required
string

Project name

descriptionstring

Project description

directorystring

Project directory name

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

Create a project

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

Previous

Patches

Next

Releases