Rate this page:
This prototype REST API is deprecated since Confluence 5.5.
Confluence has a new REST API that is progressively replacing our existing APIs, including this prototype REST API. We recommend plugin developers use the new REST APIs where possible.
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.
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).
Most of the Confluence REST API is read only. Confluence's REST APIs allow you to retrieve the following information:
The following resources are available for updating content:
If you would like to know more about REST in general, start with the Dare Obasanjo's blog post, Explaining REST to Damien Katz.
Then jump right in and try our REST resources:
Below are some links to in-depth information on developing REST APIs and plugins:
You can browse and test your remote API using the REST Application Browser (RAB). The RAB is a page in the application's administrative console. For information on using the RAB, see the documentation for the REST API Browser.
Rate this page: