API WebHook

The GitBucket api/webhook is designed for compatibility with GitHub's implementation.

The API endpoints are reachable under: http(s)://yourgitbucket/api/v3

GitBucket does not fully implement the GitHub API/webhook and respects only a subset of parameters. If you find some behavior different from GitHub, it can be a GitBucket bug or a feature not yet implemented :).

Authentication

[x] [personal OAUTH token in header](https://developer.github.com/v3/#oauth2-token-sent-in-a-header)
- The tokens can be created via the UI, by going into the "Account Settings" menu and selecting the "Applications" tab.
[x] [Basic Authentication](https://developer.github.com/v3/#basic-authentication) (since v4.3)
[x] [OAuth2 Token (sent as a parameter)](https://developer.github.com/v3/#oauth2-token-sent-as-a-parameter) (since v4.31.0)
[ ] [<del>OAuth2 Key/Secret</del>](https://developer.github.com/v3/#oauth2-keysecret) not supported yet.

API

Root Endpoint
- List endpoints (since v4.3, Only rate-limit endpoint explained)
Issues
- List issues for a repository (since v4.9)
- Get a single issue (since v4.8)
- Create an issue (since v4.9)
- Comments
  - List comments on an issue
  - Create A Comment
- Labels
  - List all labels for this repository (since v3.11)
  - Get a single label (since v3.11)
  - Create a label (since v3.11)
  - Update a label (since v3.11)
  - Delete a label (since v3.11)
  - List labels on an issue (since v4.30)
  - Add labels to an issue (since v4.30)
  - Remove a label from an issue (since v4.30)
  - Replace all labels for an issue (since v4.30)
  - Remove all labels from an issue (since v4.30)
Pull Requests
- List pull requests
- Get a single pull request
- Create a pull request (since v4.30)
- List commits on a pull request
- Get if a pull request has been merged (since v4.30)
Repositories
- List your repositories
- List user repositories
- List organization repositories
- Get
- Create
- Enabling and disabling branch protection (since v3.11)
- Status
- Branches
  - List all branches for this repository (since v4.3)
  - Get branch (since v4.30)
- Commits
  - Get a single commit (since v4.17)
- Contents
  - List all contents of a file or directory in this repository (since v4.3)
  - Create a file (since v4.31)
  - Update a file (since v4.31)
- Reference
  - Get a reference (since v4.3)
- Collaborators
  - List collaborators (since v4.3)
  - Add user as a collaborator (since v4.30)
  - Remove user as a collaborator (since v4.30)
Users
- Get a single user
- Get the authenticated user
- Update the authenticated user (since v4.30)
- Get all users (since v4.30)
- List repositories for this user (since v4.3)
- Create a new user (since v4.30)
- Suspend a user (since v4.30)
- Unsuspend a user (v4.30)
Groups
- List your groups (since v4.30)
- List all groups (since v4.30)
- Get a single group (since v4.3)
- List repositories for this group (since v4.3)
- Create a new group (since v4.31.0)

Example

With a default local installation, having created a token for the root user, calling

curl -H "Authorization: token 6b690aa9e528c54835619b2cb717f61035e9a013" http://localhost:8080/api/v3/user

answers

{"login":"root","email":"root@localhost","type":"User","site_admin":true,"created_at":"2016-04-01T13:27:12Z","url":"http://localhost:8080/api/v3/users/root","html_url":"http://localhost:8080/root"}

Authentication

API

Example

WebHook Events