Rate this page:
|Applicable||Confluence Server 5.5 and later |
Confluence Data Center 5.6 and later
The Confluence Server REST API is for admins who want to script interactions with Confluence Server and Data Center and developers who want to integrate with or build on top of the Confluence platform.
Using Cloud? Find out about the Confluence Cloud REST API.
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: GET, PUT, POST and DELETE. The REST API is based on open standards, so you can use any web development language to access the API.
For some examples of what you can do with the REST API, see Confluence REST API Examples.
Confluence's REST API provides a way to paginate your calls to limit the amount of data you are fetching. Read more about this in Pagination in the REST API.
Confluence's REST API also provides a way to fetch more data in a single call through REST API Expansions. Read more about this in Expansions in the REST API.
Confluence's REST API provides an advanced search that lets you use structured queries to search for content within Confluence. Your search results will take the same form as the Content model returned by the Content REST API.
Content and Space Properties are JSON key-value storages that you can access through the REST API. This is a great way, for example, to store metadata about a piece (or pieces) of content. Read more about Content Properties.
Accessing Confluence using the REST API involves the same authentication and permissions checks that are required when accessing Confluence in your browser. If you don't log in, you are accessing Confluence anonymously. If you log in but don't have permission to view a particular page or space for example, you will not be able to view it using the Confluence REST API either.
For personal use and scripts, you can use basic authentication with either a username and password, or by creating a personal access token (available from Confluence Data Center and Server 7.9).
Read the Atlassian REST API Policy for information on compatibility, versioning and deprecation.
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.
Rate this page: