Confluence REST API

Note: The new REST API is available for Confluence Cloud and from Confluence 5.5.

The Confluence REST API is provided for developers who want to integrate with or build on top of the Confluence platform and administrators who want to script interactions with the Confluence server

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 JSON. 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.

Read the Atlassian REST API Policy for information on compatibility, versioning and deprecation. 

REST API Documentation

For the documentation for the REST API see - Confluence REST API documentation.

REST API Browser

The Atlassian REST API Browser is a tool for discovering the REST APIs available in Atlassian applications, including Confluence. This is available as part of the Atlassian SDK or can be downloaded from the Atlassian Marketplace for local installations..

See Using the REST API Browser.

Examples

For some examples of what you can do with the REST API see - Confluence REST API Examples.

Deprecated APIs

The following APIs will be deprecated with the release of Confluence 5.5.  REST is the recommended and supported remote API for Confluence 5.5 and later. This is where Atlassian will focus its attention from this point onwards, adding functionality and fixing bugs.  We recommend plugin developers use the REST API where possible.

Confluence Remote API Status
REST (Prototype) Deprecated since Confluence 5.5. This means that we will not add new features or fix bugs related to the Prototype REST API (v1 and v2) for Confluence 5.5 or later
XML-RPC and SOAP Deprecated since Confluence 5.5. This means that we will not add new features or fix bugs related to the XML-RPC and SOAP API for Confluence 5.5 or later
JSON-RPC Deprecated since Confluence 5.5. This means that we will not add new features or fix bugs related to the JSON-RPC API for Confluence 5.5 or later
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport