Audit
Policies
Branch-utils
Git
Sync
Required-builds
Build-status
Comment-likes
Jira
Mirroring
Branch-permissions
Access-tokens
Insights
Ssh
Api

Rate this page:

About

The Bitbucket Data Center and Server REST API enables you to interact with Bitbucket programmatically. This page documents the REST resources available in Bitbucket, including the HTTP response codes and example requests and responses.

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

Intro

This is the reference document for the Bitbucket Data Center REST API. The REST API is for developers who want to:

  • integrate &product_name; with other applications;
  • create scripts that interact with Bitbucket Data Center or
  • develop plugins that enhance the Bitbucket Data Center UI, using REST to interact with the backend.

You can read more about developing Bitbucket Data Center plugins in the Developer Documentation

Getting started

Because the REST API is based on open standards, you can use any web development language or command line tool capable of generating an HTTP request to access the API.

If you're already working with the Atlassian SDK, the REST API Browser is a great tool for exploring and experimenting with the &product_name; REST API.

Structure of the REST URIs

Bitbucket Data Center's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Bitbucket Data Center REST API uses JSON as its communication format, and the standard HTTP(S) methods like GET, PUT, POST and DELETE. URIs for Bitbucket Data Center's REST API resource have the following structure: