Page tree
Skip to end of metadata
Go to start of metadata

The Confluence REST APIs are a prototype only

Confluence’s REST APIs are evolving. Their functionality is currently limited to a subset of the existing Confluence API. We plan to improve the REST APIs in future releases. Please expect some API changes. If you decide to experiment with these APIs, we would welcome feedback – you can create an improvement request in the REST API component of our JIRA project.

For production-ready API development, please refer to the XML-RPC and SOAP APIs. You may also find the JSON-RPC plugin useful, which allows those APIs to be more easily accessed from web technologies such as Javascript/AJAX, or simple HTTP requests.

The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.

Introduction to Confluence's REST APIs

Confluence'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. By default, the response format is XML. If you wish, you can request JSON instead of XML. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

A typical use case would be to search Confluence for a page or pages that match a given search term, then retrieve the content of the page(s).

(info) The Confluence REST API is currently read only. You cannot yet use it to update information in Confluence.

Confluence's REST APIs allow you to retrieve the following information:

  • A list of spaces, including high-level information about each space.
  • Detailed information about a space.
  • Search results using the Confluence search with various parameters.
  • The content of pages, blogs and comments.
  • A list of attachments for a given page or blog post.
  • A given attachment, specified by attachment ID.
  • Information about the user's session.
  • Translated UI text (message bundles) for a given internationalisation key.

Getting Started

If you would like to know more about REST in general, start with the RESTwiki's guide to REST In Plain English.

Then jump right in and try our REST resources:

Advanced Topics

Below are some links to in-depth information on developing REST APIs and plugins:

  • Developing your own REST APIs for Confluence: Confluence uses the Atlassian REST API to implement the Confluence APIs. The REST plugin is bundled with Confluence. You can add your own REST APIs to Confluence by creating a Confluence plugin that includes the REST plugin module.
  • Understanding the principles behind the Atlassian REST API design: You may be interested in the guidelines followed by the Atlassian developers who are designing REST APIs for Atlassian applications, including the Confluence REST APIs.

Confluence Developer Documentation

  • No labels