REST APIs

The Bitbucket Server REST API is split up into multiple modules, each provided by a separate bundled plugin.

General information about using the REST APIs can be found at Using the REST API and Authenticating with the REST API.

Core

The Core REST API provides REST resources for core functionality such as server administration, projects, repositories, pull requests and user management.

Audit

The Audit REST API provides REST resources for querying the subset of audit events which are stored against a project or repository. Full audit logs are only available via the audit log file.

Branches

The Branch REST API provides REST resources for managing repository branches and branch models.

Builds

The Build REST API provides REST resources for updating and querying build information.

See this how-to guide for more details.

Code Insights

The Code Insights REST API provides REST resources for creating reports and annotating a pull request diff.

See this how-to guide for more details or this tutorial for an example.

Comment Likes

The Comment Likes REST API provides REST resources for adding, removing and querying comment likes.

Default Reviewers

The Default Reviewers REST API provides REST resources for managing repository default reviewer configurations.

Git

The Git REST API provides remote APIs supporting selected git-specific operations in Bitbucket, already available through Java API. Currently supporting management of repository tags.

Jira

The Jira REST API provides REST resources for querying Jira issues indexed against commits.

Personal Access Tokens

The Personal Access Tokens REST API provides REST resources for creating, deleting, and retrieving personal access tokens, as well as modifying existing token names and permissions.

GPG key

The GPG key REST API provides REST resources for various GPG key operations.

Ref Restriction

The Ref Restriction REST API provides REST resources for managing repository ref restrictions.

Repository Ref Synchronization

The Repository Ref Synchronization REST API provides REST resources for managing ref synchronization for a repository.

Rolling Upgrades

The Rolling Upgrades REST API provides REST resources for running a rolling upgrade. For an in-depth walk-through on how to perform a rolling upgrade with this REST API, check out our guide on upgrading a Bitbucket cluster through the API without downtime

SSH

The SSH REST API provides REST resources for managing user SSH keys.