App Access for Confluence Cloud REST APIs
Terms used in this document
Term | Definition |
|---|---|
Ancestor | The content directly above a piece for content, such as the “parent” page in the left navigation content tree or a “parent” comment that a “child” comment has replied to. |
Annonymous user | A user who is not logged in to Confluence. By default, these users have no access to spaces or content. But an admin can grant permissions to anonymous users. |
API | A application programming interface allows an app to access Confluence and read, write, or delete information. |
Attachment | A file, such as an image or a document, that has been uploaded to Confluence. |
Audit logs | A list of changes made to the Confluence site, including data on who made the change and when. Creating and viewing audit logs requires the Confluence global admin permission. |
Binary data | The file data contained in an attachment such as an image. |
Blog post | A piece of content posted in a space’s blog. |
Body text | The text and styling contained within a piece of content. |
Child content | Any content contained or displayed within another piece of content.
|
Comment, footer | Comments left at the bottom of a page. |
Comment, inline | Comments left at a specific location within the page’s body. |
Confluence Query Language (CQL) | A method of searching Confluence that allows multiple parameters and search strings. |
Content | A collective term for the pages, blog posts, inline comments, footer comments, attachments, and custom content inside a Confluence space. |
Content state | Content can have three states:
|
Custom content | The specialized content created and controlled by an app to add new functionality to Confluence. Examples include a macro attachment or a form. |
Dynamic modules | A feature available to app developers that lets them run specific code in Confluence. |
Group | A set of users that can be granted permissions collectively. |
ID | A set of characters that Condluecne uses to identify a unique piece of content, a label, a user, or a group. |
Inline tasks | See tasks. |
Label | User-generated tags used for searching and filtering content. |
Long-running task | Operations that Confluence performs in the background while the user does other things. A common example is moving multiple pages from one space to another. |
Macro body | The text or other content inside a macro. For example, the Expand macro contains text that is only shown when the user clicks on it. |
Operations | Actions that a user or API can have permission to take on a piece of content or a space. Examples include create, read, copy, move, delete and many others. |
Page | A piece of content in a Confluence space identified by an ID. All pages are contained inside a space. A page can contain text, styling, attachments, restrictions, and macros. |
Parent | The related content “above“ a piece of content in navigation. Parents are used to organize related content.
|
Permissions | There are three levels of permissions:
|
Personally Identifiable Information (PII) | Information about a specific person. A user’s name, email address, profile picture and other PIII can be contained in their Confluence account. Users can set privacy for their account to block access to PII. Admins can also configure privacy settings on behalf of users to block access to PII. |
Prefix | An filtering option added to labels.
|
Properties | Data about pages, blog post, and spaces that can be accessed by APIs. This should not include a user’s personal data or sensitive configuration data. |
Privacy settings | A user’s privacy settings can restrict API access to personally identifiable information such as their name, email address, and profile picture. Admins can set privacy settings on behalf of users to globally restrict access to this information. |
Purge | Users with the delete permission can move a page or other piece of content to the trash. A space admin can go one step further and permanently delete, or purge, content from Confluence. |
Relationship | A relationship can exist between users, spaces, and content. The “favorite” relationship exists by default between a user and a piece of content. Users and apps can create new relationships with custom names. |
Restrictions | A setting applied to a page or blog post to prevent users or groups from viewing it even if they have view permission for the space. |
Space | Confluene’s way or organizing content into meaningful categories, identified by an ID. Spaces can have permissions that allow or block users or groups, and a user can be an admin of a specific space. |
Task | An action item assigned to a user. Also called inline tasks for V1 APIs. |
User | A user of Confluence is identified by an ID. Users can have permissions to access specific spaces. Users can belong to groups. |
User property | Information for a specific user that’s stored inside an app. Only the app itself can access its user properties. They are not available to other apps or other users. |
Blocked when app access rule applies
These APIs are blocked when the admin turns on the app access rule. Apps using these APIs will no longer be able to access the content or perform the actions listed below.
Version 1 APIs with the DEPRECATED tag have been replaced by one or more corresponding Version 2 APIs. Some older apps may still use the V1 API while newer apps will use another, newer version.
Analytics APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get views | Returns the total number of views for a piece of content by specifying its ID. This includes pages, blog posts, comments, attachments, and custom content. | |
Get viewers | Returns the total number of distinct viewers who have viewed a piece of content. |
Ancestors API (version 2)
Name | Description | API docs link |
|---|---|---|
Get all ancestors of page | Returns all “parent page” ancestors of a specific page in top-to-bottom order. A page’s ancestors are its parent page and the parent page’s parents. This API returns the page ID of the parents going all the way up in the content tree. |
Attachment APIs (version 2)
An attachment is a file, such as an image or a document, that a user has uploaded to Confluence. Attachments are available for pages, blog posts, labels, and custom content.
Name | Description | API docs link |
|---|---|---|
Get attachments | Returns all attachments for a piece of content. | |
Get attachment by id | Returns a specified attachment. | |
Delete attachment | Deletes an attachment. | |
Get attachments for blog post | Returns all attachments for a specified blog post. | |
Get attachments for custom content | Returns all attachments for a specified piece of custom content. | |
Get attachments for label | Returns all attachments of a specified label. | |
Get attachments for page | Returns all attachments for a specified page. |
Blog post APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get blog posts | Returns all blog posts. | |
Create blog post | Creates a new blog post in a specified space. | |
Get blog post by id | Returns a specified blog post. | |
Update blog post | Updates a specified blog post. | |
Delete blog post | Deletes a specified blog post. | |
Get blog posts for label | Returns all blog posts with a specific label. | |
Get blog posts in space | Returns all blog posts in a specified space. |
Children APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get child pages | Returns all child pages for a specified page. | |
Get child custom content | Returns all child custom content items for a specific piece of custom content. Custom content is created and controlled by apps to add new functionality to Confluence. For more details, see: Custom Content |
Comment APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get footer comments for page | Returns the first-level comments (also known as parent comments) displayed at the bottom of a specific page without returning any of the replies (child comments). | |
Get inline comments for page | Returns the parent inline comments (comments left as a specific location on the page) of a specific page without returning any of the replies. | |
Get footer comments for blog post | Returns the parent footer comments from a specific blog post without replies. | |
Get inline comments for blog post | Returns the parent inline comments from a specific blog post without replies. | |
Get footer comments | Returns all comments at the bottom of a specific page, including all parent comments and replies. | |
Create footer comment | Creates a new comment at the bottom of a specified page. | |
Get footer comment by id | Returns a specific comment by specifying its ID. | |
Update footer comment | Updates the body text of a specific comment by its ID. | |
Delete footer comment | Deletes a specified comment by its ID. | |
Get child footer comments | Returns the child comments of a specific comment by its id. | |
Get inline comments | Returns all inline comments from a specific page. | |
Create inline comment | Creates a new inline comment at a specified location on a specified page. | |
Get inline comment by id | Returns a specific inline comment by its ID. | |
Update inline comment | Updates the body text of a specific inline comment by its ID. | |
Delete inline comment | Deletes a specified inline comment by its ID. | |
Get child inline comments | Returns the child inline comments of a specific comment by its id. |
Content APIs (Version 1)
Name | Description | API docs link |
|---|---|---|
Get all content from Confluence DEPRECATED | Returns all content from a Confluence instance. | |
Create new content DEPRECATED | Creates new content or publishes a previously created draft. | |
Archive pages | Initiates a task to move pages to the archive. An ID is returned to allow monitoring of the ongoing archive task. | |
Publish shared draft | Publishes a shared draft of a page. | |
Publish legacy draft | Publishes a draft using the legacy draft method. To be replaced by the shared draft method. | |
Search content by CQL | Returns a search request initiated using the Confluence Query Language (CQL). | |
Get content by ID DEPRECATED | Returns a specific piece of content by sending its ID. This can include both the attributes of the content and its body text and attachments. It can also return child content. | |
Update content DEPRECATED | Updates a specific piece of content by changing the title, body, status, parent page, or additional properties. | |
Delete content DEPRECATED | Moves a piece of content such as a page, blogpost, or attachment, to the space's trash. Or, if it's already in the trash, it will purge the content, meaning that it will be deleted permanently. Comments are purged directly, without moving to the trash first. A space admin cannot recover purged content. | |
Get content history DEPRECATED | Returns the most recent update for a piece of content. | Returns the most recent update for a piece of content. |
Content APIs (Version 2)
Name | Description | API docs link |
|---|---|---|
Convert content ids to content types | Converts a list of content ids into their associated content types. |
Content - attachments APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get attachments DEPRECATED | Returns all attachments for a piece of content. | |
Create or update attachment | Add a new attachment to a piece of content or update an existing attachment with a new version. | |
Create attachment | Adds a new attachment to a piece of content. | |
Update attachment properties | Update an attachment with new strings, objects, containers, or other properties. | |
Update attachment data | Updates the data for an attachment, such as a string of text or a binary file. | |
Get URI to download attachment | Returns the web address of an attachment. |
Content - body APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Convert content body | Converts a specific piece of content's body text to a new format. This can be used to access stored content to display it in view or edit mode. One example use is that apps may use this API to convert custom app content to a format that works with the PDF export function. | |
Asynchronously convert content body | Converts a specific content's body to a new format asynchronously. Returns an async ID that can be used to retrieve the results for five minutes. |
Content - children and descendants APIs (version 1)
Child content (also known as descendants) refers to content contained in another piece of content:
For pages, this includes pages below it in the content tree, comments, and attachments.
For blog posts, it includes comments and attachments.
For attachments, it includes comments.
For comments, it includes attachments.
Name | Description | API docs link |
|---|---|---|
Get content children DEPRECATED | Returns a list of all child content of a specific piece of content. | |
Move a page to a new location relative to a target page | Moves a page to a different position in the content tree. You can specify a new parent or a new order relative to another child page. | |
Get content children by type | Returns all children of a piece of content, allowing you to specify only child pages, comments, or attachments. | |
Get content descendants | Returns a list of all "child content" of a specific piece of content, including content at all levels. | |
Get content descendants by type | Returns all child content of a piece of content, including content at all levels. Allows you to specify only child pages, child comments, child attachments, or child custom content. | |
Copy page hierarchy | Copies a page and every piece of content below it in the hierarchy to a new parent page.
| |
Copy single page | Copies a page to a new space or parent page, allow allowing the copy to replace an existing page. |
Content - comments APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get comments DEPRECATED | Returns all comments on a piece of content. |
Content - labels APIs (version 1)
Labels are user-generated tags that are helpful for searching for and filtering content.
Name | Description | API docs link |
|---|---|---|
Get labels for content DEPRECATED | Returns all labels for a piece of content. Labels can include the prefix (used for filtering), name, id, and a label string. | |
Add labels to content | Adds labels to a piece of content without removing existing labels. Labels include the prefix, name, or any additional attributes. | |
Remove label from content using query parameter | Remove a label from a piece of content by querying the name of the label. | |
Remove label from content | Remove a label from a piece of content by specifying its ID and the label you want to remove. |
Content - macro body APIs (version 1)
Macro bodies are the text and other content contained inside a macro. For example, the Expand macro can contain text that is only shown when the user clicks on it.
Name | Description | API docs link |
|---|---|---|
Get macro body by macro ID | Returns the body of a macro. The macro body also includes the Returns the body of a macro. The macro body also includes the title and any additional parameters. | |
Get macro body by macro ID and convert the representation synchronously | Returns the body of a macro and allows you to convert it to a specified format immediately. The macro body also includes the title and any additional parameters. | GET Get macro body by macro ID and convert the representation synchronously |
Get macro body by macro ID and convert representation asynchronously | Returns the body of a macro and allows you to convert it to a specified format that is available for five minutes using a provided async ID. The macro body also includes the title and any additional parameters. | GET Get macro body by macro ID and convert representation Ansynchronously |
Content - permissions APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Check content permissions | Returns the permissions that a specified user or group has on a specific piece of content. Confluence admins can check permissions for another user or for a group of users by specifying an ID. But a typical user can only check their own permissions. |
Content - properties APIs (version 1)
Properties are data about pages, blog post, and spaces that can be accessed by APIs. This should not include a user’s personal data or sensitive configuration data.
Name | Description | API docs link |
|---|---|---|
Get content properties DEPRECATED | Returns all properties of a piece of content. | |
Create content property DEPRECATED | Adds a new property to a piece of content. | |
Get content property DEPRECATED | Returns a specific property for a specific piece of content. | |
Update content property DEPRECATED | Updates a specific property for a specific piece of content or creates that property if it didn't already exist in the content. | |
Create content property for key DEPRECATED | Adds a new property to a piece of content, specifying the content key in the path of the request URL. | |
Delete content property DEPRECATED | Deletes a specific property for a specific piece of content. |
Content - properties APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get content properties for attachment | Returns all content properties for a specified attachment. | |
Create content property for attachment | Creates a new content property for a specified attachment. | |
Get content property for attachment by id | Returns a specific content property by its ID for a specific attachment. | |
Update content property for attachment by id | Updates a specific content property by its ID for a specific attachment. | |
Delete content property for attachment by id | Deletes a specific content property by its ID for a specific attachment. | |
Get content properties for blog post | Returns all content properties for a specified blog post. | |
Create content property for blog post | Creates a new content property for a specified blog post. | |
Get content property for blog post by id | Returns a specific content property by its ID for a specific blog post. | |
Update content property for blog post by id | Updates a specific content property by its ID for a specific blog post. | |
Delete content property for blogpost by id | Deletes a specific content property by its ID for a specific blog post. | |
Get content properties for custom content | Returns all content properties for a specified piece of custom content. | |
Create content property for custom content | Creates a new content property for a specified piece of custom content. | |
Get content property for custom content by id | Returns a specific content property by its ID for a specific piece of custom content. | |
Update content property for custom content by id | Updates a specific content property by its ID for a specific piece of custom content. | |
Delete content property for custom content by id | Deletes a specific content property by its ID for a specific piece of custom content. | |
Get content properties for page | Returns all content properties for a specified page. | |
Create content property for page | Creates a new content property for a specified page. | |
Get content property for page by id | Returns a specific content property by its ID for a specific page. | |
Update content property for page by id | Updates a specific content property by its ID for a specific page. | |
Delete content property for page by id | Deletes a specific content property by its ID for a specific page. | |
Get content properties for comment | Returns all content properties for a specified comment. | |
Create content property for comment | Creates a new content property for a specified comment. | |
Get content property for comment by id | Returns a specific content property by its ID for a specific comment. | |
Update content property for comment by id | Updates a specific content property by its ID for a specific comment. | |
Delete content property for comment by id | Deletes a specific content property by its ID for a specific comment. |
Content - restrictions APIs (version 1)
By default, pages and blog posts are open for viewing, editing, and deletion by any user or group that has those permissions for that specific space. Restrictions are rules applied to pages or blog posts that block view, edit, or delete access even for users who have access to a space.
Name | Description | API docs link |
|---|---|---|
Get restrictions for content | Returns the restrictions on a specific piece of content. | |
Update restrictions | Updates restrictions for a piece of content by removing the current restrictions and replacing them with the ones specified in the request. | |
Add restrictions for content | Adds new restrictions to a specific piece of content without replacing the current restrictions. | |
Delete restrictions for content | Removes all read and update restrictions from a specific piece of content. | |
Get restrictions by operation | Returns restrictions on a piece of content with the results organized by operation (read and update). | |
Get restrictions for operation | Returns the restrictions on a specific piece of content for a specific operation (read or update). | |
Get content restriction status for group DEPRECATED | Returns the restriction on a specified piece of content for a specified group. Note that this request relates to the permissions of the content itself, but not inherited permissions from spaces, accounts, or product access. | |
Add group to content restriction DEPRECATED | Adds or updates permission for a specific group to a piece of content. | |
Remove group from content restriction DEPRECATED | Deletes a group from a content restriction. | |
Get content restriction status for group | Returns whether a specific group has permissions on a specific piece of content. Note that this request relates to the permissions of the content itself, but not inherited permissions from spaces, accounts, or product access. | |
Add group to content restriction | Adds a group to a restriction (read or update) for a specific piece of content. | |
Remove group from content restriction | Removes a restriction (read or update) for a group from a specific piece of content. | |
Get content restriction status for user | Returns whether or not a content restriction applies to a specific user on a specific piece of content. Note that this request relates to the permissions of the content itself, but not inherited permissions from spaces, accounts, or product access. | |
Add user to content restriction | Grants read or update permission to a user for a specific piece of content. | |
Remove user from content restriction | Removes a user's read or update restriction from a specific piece of content. |
Content - states APIs (version 1)
Content can have three states:
Current: The live page or blog post, viewable in Confluence.
Draft: An autosaved or unpublished draft that is only viewable in Confluence by the user who created it or shared with collaborators.
Archived: A page or blog post that has been moved to the archive.
Name | Description | API docs link |
|---|---|---|
Get content state | Returns the current state of a specific piece of content or a specific draft of that content. | |
Set the content state of content and publish a new version of the content. | Sets the current state of a specific piece of content and creates a new version of the content with the new state. | PUT Set the content state of a content and publishes a new version of the content |
Removes the content state of content and publish a new version. | Removes the current state of a specific piece of content and creates a new version of the content with the new state. | DEL Removes the content state of a content and publishes a new version |
Get available content states for content. | Returns all available states that a specific piece of content can currently be set to. | |
Bulk set content state of content | Begin a process of setting the content state of draft or published versions of multiple pieces of content. | |
Get Custom Content States | Returns all custom content states created by a specific user. | |
Bulk remove content states from content | Begin a process of removing the content state of draft or published versions of multiple pieces of content. | |
Get update on long running task for setting of content state | Returns the current status of a running bulk action to change content states. | GET Get update on long running task for setting of content state |
Get content in space with a given content state | Returns pages in a space with a specific content state. |
Content - versions (version 1)
Name | Description | API docs link |
|---|---|---|
Get content versions DEPRECATED | Returns all versions for a specific piece of content in descending order, including specified attributes and the text body of each version. | |
Restore content version | Sets an older version of a piece of content to be the current version by creating a new version with the content from the older version. | |
Get content version DEPRECATED | Returns a specific version of a specific piece of content. | |
Delete content version | Deletes an old version of a specific piece of content. |
Content - watches APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get watches for page | Returns a list of watches for a page. | |
Get content watch status | Returns whether or not a specific user or the current user is watching a specific piece of content. | |
Add content watcher | Adds either a specified user or the current user as a watcher to a specific piece of content. | |
Remove content watcher | Removes either a specified user or the current user as a watcher from a specific piece of content. |
Custom content APIs (version 2)
Custom content is the specialized content created and controlled by an app to add new functionality to Confluence. Examples include a macro attachment or a form.
Name | Description | API docs link |
|---|---|---|
Get custom content by type in blog post | Returns all custom content of a specific type from a blog post. | |
Get custom content by type | Returns all custom content of a specific type, filtering by custom content ID or space ID. | |
Create custom content | Creates a new piece of custom content in a specific space, page, blogpost, or another piece of custom content. | |
Get custom content by id | Returns a specific piece of custom content by its ID. | |
Update custom content | Updates a specific piece of custom content by its ID. | |
Delete custom content | Deletes a piece of custom content by its ID. | |
Get custom content by type in page | Returns all custom content for a specified type on a specified page. | |
Get custom content by type in space | Returns all custom content for a specified type on a specified space. |
Experimental APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Delete page tree | Moves a page and all of its descendants (pages underneath it in the leftside navigation tree) to the space’s trash. |
Inline task APIs (version 1)
Tasks are action items that can be assigned to a user.
Name | Description | API docs link |
|---|---|---|
Get inline tasks based on search parameters DEPRECATED | Returns inline tasks based on a search query that can include pages, assignees, creators, user who completed the task, dates, and current status. | |
Get inline task based on global ID DEPRECATED | Returns an inline task based on its task ID. | |
Update inline task given global ID | Changes the status of a specific task. |
Label APIs (version 1)
Labels are user-generated tags used for searching and filtering content.
Name | Description | API docs link |
|---|---|---|
Get label information | Returns information about a label and all content associated with the label. |
Label APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get labels for attachment | Returns all labels applied to a specified attachment. | |
Get labels for blog post | Returns all labels applied to a specified blog post. | |
Get labels for custom content | Returns all labels applied to a specified piece of custom content. | |
Get labels for page | Returns all labels applied to a specified page. | |
Get labels for space | Returns all labels for a specified space | |
Get labels for space content | Returns all labels applied to content in a space |
Like APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get like count for blog post | Returns a count of all likes on a blog post. | |
Get account IDs of likes for blog post | Returns the account ID of all users who liked a blog post. | |
Get like count for page | Returns a count of all likes on a page. | |
Get account IDs of likes for page | Returns the account ID of all users who liked a page. | |
Get like count for footer comment | Returns a count of all likes on a footer comment. | |
Get account IDs of likes for footer comment | Returns the account ID of all users who liked a footer comment. | |
Get like count for inline comment | Returns a count of all likes on an inline comment. | |
Get account IDs of likes for inline comment | Returns the account ID of all users who liked an inline comment. |
Operation APIs (version 2)
Operations are actions that a user or API is permitted to take on a specific piece of content or space. Examples include, but are not limited to, create, read, update, delete, copy, export, and purge.
Name | Description | API docs link |
|---|---|---|
Get permitted operations for attachment | Returns all permitted operations on a specified attachment. | |
Get permitted operations for blog post | Returns all permitted operations on a specified blog post. | |
Get permitted operations for custom content | Returns all permitted operations on a specified piece of custom content. | |
Get permitted operations for page | Returns all permitted operations on a specified page. | |
Get permitted operations for footer comment | Returns all permitted operations on a specified footer comment. | |
Get permitted operations for inline comment | Returns all permitted operations on a specified inline comment. |
Page APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get pages for label | Returns all pages that have a specified label applied. | |
Get pages | Returns all pages. Can be filtered by page IDs, spaces, current status, page title, and page body format. | |
Create page | Creates a new page in a specified space. | |
Get page by id | Returns a specific page by its ID. | |
Update page | Updates a page. | |
Delete page | Deletes a page. | |
Get pages in space | Returns all pages for a specified space. |
Relationship APIs (version 1)
A relationship can exist between users, spaces, and content. The “favorite” relationship exists by default between a user and a piece of content. Users and apps can create new relationships with custom names.
Name | Description | API docs link |
|---|---|---|
Find target entities related to a source entity | Returns all entities (users, content, or spaces) with a specific relationship to a specified source entity using search parameters. | |
Find relationship from source to target | Returns whether or not a specific type of relationship exists between two entities (users, content, or spaces). | |
Create relationship | Creates a relationship between two entities (users, content, or spaces). | |
Delete relationship | Removes a relationship between two entities (users, content, or spaces). | |
Find source entities related to a target entity | Returns all entities (users, content, or spaces) with a specific relationship to a specified target entity using search parameters. |
Search API (version 1)
Name | Description | API docs link |
|---|---|---|
Search for content with CQL | Searches for content using the Confluence Query Language (CQL). |
Space APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get spaces DEPRECATED | Returns all spaces and information about spaces on a site in ascending alphabetical order by space key. | |
Get content for space DEPRECATED | Returns all content in a space grouped by content type, then ordered by Content ID in ascending order. | |
Get content by type for space DEPRECATED | Returns all content of a specified type (page, blogpost, and custom content). | |
Delete space | Deletes a space as part of a long-running task and returns a unique identifier to monitor the task. | |
Get space DEPRECATED | Returns all information about a space, but none of the content. Include’s the space’s ID, name, description, and permissions, among other information. |
Task APIs (version 2)
Tasks are action items that can be assigned to a user.
Note: Version 1 APIs are listed above as Inilne task APIs.
Name | Description | API docs link |
|---|---|---|
Get tasks | Returns all tasks. Filtering is available by type of body format, current status, task ID, space ID, page ID, blog post ID, and various users who have interacted with the task (assignee, creator, etc.). | |
Get task by id | Returns a specified task by its ID. | |
Update task | Updates a specified task by its ID. |
Version APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get attachment versions | Returns the version information for a specific attachment. | |
Get version details for attachment version | Returns version details for a specified attachment and specified version. | |
Get blog post versions | Returns the version information for a specific blog post. | |
Get version details for blog post version | Returns version details for a specified blog post and specified version. | |
Get page versions | Returns the version information for a specific page. | |
Get version details for page version | Returns version details for a specified page and specified version. | |
Get custom content versions | Returns the version information for a specific piece of custom content. | |
Get version details for custom content version | Returns version details for a specified piece of custom content and specified version. | |
Get footer comment versions | Returns the version information for a specific footer comment. | |
Get version details for footer comment version | Returns version details for a specified footer comment and specified version. | |
Get inline comment versions | Returns the version information for a specific inline comment. | |
Get version details for inline comment version | Returns version details for a specified inline comment and specified version. |
Not blocked when an app access rule applies
These APIs are not blocked when the admin turns on an app access rule. This means that apps can still use these APIs to access Confluence spaces and content even when the admin has decided to block app access.
V1 APIs with the DEPRECATED tag have been replaced by one or more corresponding V2 APIs. Some older apps may still use the V1 API while newer apps will use another, newer version.
Copying custom macros
It will still be possible to copy a custom macro or copy the content from a custom macro once the app that has introduced the macro is added to a data security policy with an app access rule. However, the content within the macro will still be governed by the rules of the original space and page. The app will no longer have access to this content.
Users needing access to the content will need to go to the macro in its original location and copy the content separately.
Audit APIs (version 1)
A list of changes made to the Confluence site, including data on who made the change and when. This can include a user’s name, email address, and other personally identifiable information (PII).
Creating and viewing audit logs requires the Confluence global admin permission.
Name | Description | API docs link |
|---|---|---|
Get audit records by date | Returns all audit log records or records from a date range. | |
Create audit record | Adds a record to the audit log. | |
Export audit records to a file | Creates a comma-separated value (CSV) or compressed (ZIP) file with all audit log records. | |
Get retention period for audit log records | Returns the length of time between creation and deletion of records in the audit log. | |
Set retention period for audit log records | Changes the length of record retention from creation to deletion, up to maximum of one year. | |
Get audit records for a time period | Returns a set of records from the audit log starting from a time in the past to the current date. Results can be also be filtered by the record index, specific strings, and the total number of records returned. |
Content - body API (version 1)
Name | Description | API docs link |
|---|---|---|
Get asynchronously converted content body from the id or the current status of the task. | Returns the results of a content body conversion for a specific async ID. | GET Get asynchronously converted content body from the id or the current status of the task |
Content - states (version 1)
Name | Description | API docs link |
|---|---|---|
Get space suggested content states | Returns the content states that are suggested in a specific space. | |
Get content state settings for space | Returns whether a content states are allowed in a space, if customer or space content states are restricted, and a list of the space's allowed content states. |
Content – watches (version 1)
Watch APIs can return PII such as a user’s name and profile picture. A user’s privacy settings can block the return of PII.
Accessing data on a specific user requires the Confluence global administrator permission.
Name | Description | API docs link |
|---|---|---|
Get watches for space | Returns a list of watches for all pages in a space. | |
Get space watchers | Returns a list of watchers of a space. | |
Get label watch status | Returns whether or not a specified user or the current user is watching a specific label. | |
Add label watcher | Adds either a specified user or the current user as a watcher to a specific label. | |
Remove label watcher | Removes either a specified user or the current user as a watcher from a specific label. | |
Get space watch status | Returns whether or not a specific user or the current user is watching a space. | |
Add space watcher | Adds either a specified user or the current user as a watcher of a space. | |
Remove space watch | Removes either a specified user or the current user as a watcher of a space. |
Dynamic module APIs (version 1)
Dynamic modules allow an app to run specific code in Confluence.
Name | Description | API docs link |
|---|---|---|
Get modules | Returns all modules registered dynamically. (Used for Connect apps only.) | |
Register modules | Registers a list of modules. | |
Remove modules | Removes all modules or a specified list of modules from registration. |
Experimental APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get space labels | Returns a list of labels associated with a space. | |
Add labels to a space | Adds a label to a space. | |
Remove label from a space | Deletes a label from a space. |
Group APIs (version 1)
Group APIs can return PII such as a user’s name, email address, and profile picture. A user’s privacy settings can block the return of PII and an admin can set privacy policies for all users.
Name | Description | API docs link |
|---|---|---|
Get groups | Returns all user groups in ascending alphabetical order. | |
Create new user group | Creates a new user group. | |
Delete user group DEPRECATED | Deletes a user group by specifying its name. | |
Get group DEPRECATED | Returns information about a specific user group by its name. | |
Get group | Returns information about a specific user group by its ID. | |
Delete user group | Deletes a user group by specifying its ID. | |
Get group DEPRECATED | Returns a user group by specifying its name. | |
Get group members DEPRECATED | Returns the members of a group. | |
Get group members DEPRECATED | Returns the members of a group. | |
Search groups by partial query | Returns the members of a group filtered by a search string. | |
Add member to group by group ID | Adds a user to a group by specifying the group ID and user account ID. | |
Remove member from group using group ID | Removes a user from a group by specifying the group ID and user account ID. | |
Get group members | Returns the members of a group by specifying the group ID. | |
Add member to group DEPRECATED | Adds a user to a group by specifying the group name and the account ID. | |
Remove member from group DEPRECATED | Removes a user from a group by specifying the group name and the account ID. |
Labels APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get labels | Returns all labels |
Long-running task APIs (version 1)
Long-running tasks are operations that Confluence performs in the background while the user does other things. A common example is moving multiple pages from one space to another.
Name | Description | API docs link |
|---|---|---|
Get long-running tasks | Returns information about all active long-running tasks initiated by other APIs. | |
Get a specific long-running task | Returns information about a specified long-running task initiated by another API. |
Operation API (version 2)
Operations are actions that a user or API is permitted to take on a specific piece of content or space. Examples for spaces include, but are not limited to, creating a space, moving a space, or archiving a space.
Name | Description | API docs link |
|---|---|---|
Get permitted operations for space | Returns all permitted operations for a specified space. |
Search API (version 1)
Name | Description | API docs link |
|---|---|---|
Search users with CQL | Searches for users using the Confluence Query Language (CQL). |
Settings APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get look and feel settings | Returns the current settings values from the "Look and Feel" settings page for a specific space. | |
Select look and feel settings | Sets the "Look and Feel" settings for a space to either the default, custom settings, or the current theme's settings. | |
Update look and feel settings | Updates specific "Look and Feel" settings for a site or space by either updating current custom settings or creating new custom settings. | |
Reset look and feel settings | Sets the "Look and Feel" settings for a space or site to the default settings. | |
Set look and feel settings for a space DEPRECATED | Sets the "Look and Feel" settings for a space or site to use either custom settings or the default settings. | |
Get system info | Returns system information for the Confluence Cloud tenant. |
Space APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Create space | Creates a new space by specifying the space key, name, description, permissions, and additional options. | |
Create private space | Creates a new space that is only visible to the creator. This is the same as using the Create Space API with permissions set to only the current user. | |
Update space | Updates the name, description, home page, type, status, or additional properties of a space. |
Space APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Get spaces | Returns all space permissions for a specified space. | |
Get space by id | Returns information about a specified space by its ID. |
Space – permissions APIs (version 1)
Space permissions APIs require the user to have the space admin permission to run.
Name | Description | API docs link |
|---|---|---|
Add new permission to space | Adds a new permission to space for a user or a group. | |
Add new custom content permission to space | Adds new custom content permissions to a space. | |
Remove a space permission | Removes a space permission from a user or group. |
Space – permissions API (version 2)
Name | Description | API docs link |
|---|---|---|
Get space permissions | Returns all space permissions for a specified space. |
Space – properties (version 1)
Name | Description | API docs link |
|---|---|---|
Get space properties DEPRECATED | Returns all properties for a specific space. | |
Create space property DEPRECATED | Create a new space property. | |
Get space property DEPRECATED | Returns a specific property for a specific space. | |
Update space property DEPRECATED | Updates the value of a space's property. | |
Create space property for key DEPRECATED | Creates a new space property by passing the property key in the path parameters of the URL instead of in the request body. | |
Delete space property DEPRECATED | Deletes a space property. |
Space - properties (version 2)
Name | Description | API docs link |
|---|---|---|
Get space properties in space | Returns all properties set for a specified space. | |
Create space property in space | Creates a new space property. | |
Get space property by id | Returns a specified space property by its ID. | |
Update space property by id | Updates a specified space property by its ID. | |
Delete space property by id | Deletes a space property by its ID. |
Space – settings (version 1)
Name | Description | API docs link |
|---|---|---|
Get space settings | Returns the routeOverrideEnabled setting for a space. | |
Update space settings | Updates the routeOverrideEnabled setting for a space. |
Template APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Update content template | Updates a content template, including the name, type, body, description, labels, space (if it's a space template), and additional properties. | |
Create content template | Creates a new content template by specifying the name, type, body, description, labels, space (if it's a space template), and additional properties. | |
Get blueprint templates | Returns all templates provided by blueprints. | |
Get content templates | Returns all content templates for a site or space. | |
Get content template | Returns a specified content template by the template's ID. | |
Remove template | Deletes a template and, if applicable, replaces modified blueprint templates with the original default template. |
Themes APIs (version 1)
Name | Description | API docs link |
|---|---|---|
Get themes | Returns all admin-driven themes for a site or space, not including the default theme. | |
Get global theme | Returns the current globally assigned admin-driven themes for a site. | |
Get theme | Returns information about a specific admin-driven theme that has been added to the site. | |
Get space theme | Returns the current theme, if any, for a space. | |
Set space theme | Sets an admin-driven theme for a space (other than the default space). | |
Reset space theme | Sets a space's admin-driven theme to the globally set theme. |
User APIs (version 1)
User APIs may contain PII. The return of PII can be controlled by the user’s privacy settings.
Name | Description | API docs link |
|---|---|---|
Get user | Returns all information about a specified user. | |
Get anonymous user | Returns information about the profile picture and display name for anonymous users of a site. | |
Get current user | Returns all information about the currently logged-in user. | |
Get group memberships for user | Returns the group memberships of a specific user. | |
Get multiple users using ids | Returns all information from multiple users. | |
Get user email address | Returns a user's email address. | |
Get user email addresses in bulk | Returns multiple users' email addresses. |
User APIs (version 2)
Name | Description | API docs link |
|---|---|---|
Check site access for a list of emails | Accepts a list of email addresses and returns those that don't have site access. | |
Invite a list of emails to the site | Accepts a list of email addresses and sends site invitations to them. |
User – properties APIs (version 1)
User properties are information for a specific user that’s stored inside an app. Only the app itself can access its user properties. They are not available to other apps or other users.
Name | Description | API docs link |
|---|---|---|
Get user properties | Returns all properties of a specific user as a list of property keys. | |
Get user property | Returns the property from a specific key for a user. | |
Update user property | Updates a specified property value for a user. | |
Create user property by key | Creates a new property for a user using a key. | |
Delete user property | Deletes a property from a user. |