Last updated Jun 21, 2024

REST API development

This page introduces you to using and developing REST APIs for Atlassian applications.

REST and Atlassian Plugins

Atlassian applications expose REST APIs that developers can use to access services of the Atlassian platform remotely. The REST APIs are presented by the platform components as well as any plugins that have implemented REST services.

The REST APIs provide an alternative to the Java APIs used by in-process plugins. The REST APIs provide greater change-tolerance than in-process APIs. Before starting a plugin project, it's a good idea to start by looking at the REST APIs, even if you are developing a plugin intended to operate in-process with the host application. Of course, it's also the best option for developing remote applications that access Atlassian platform services. JIRA Studio is one example of such an application.

Getting Started

To develop your own clients that use the Atlassian REST APIS, see the application-specific REST API documentation listed below. Also, the best place to get acquainted with the REST API available for use to a client application is by inspecting the target platform. Atlassian provides a tool for doing just that, the REST Application Browser (RAB). For information about the RAB, see Using the REST API Browser.

To create REST APIs in plugins you create for an Atlassian application, learn about the Atlassian REST plugin module and have a look at the tutorial, Developing a REST Service Plugin.

Application-Specific REST API Documentation

Bamboo REST APIs Confluence REST APIs Crowd REST APIs FishEye/Crucible REST APIs Jira REST APIs

API Development

REST plugin module type

Use the REST module type to create plugin points in Atlassian applications, by exposing services and data entities as REST APIs.


Plugin Tutorial - Writing REST Services Using the FishEye REST API to Write a Gadget to Monitor Recent Changes


Answers from the community Mailing lists at Feature requests and bug reports Atlassian developer blog

Rate this page: