Confluence
This document describes the REST API and resources provided by Confluence. 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. 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.
Operations
Export audit records
Get audit records
Create audit record
Get retention period
Set retention period
Get audit records for time period
Archive pages
Publish legacy draft
Publish shared draft
Update attachment data
Get URI to download attachment
Update attachment properties
Create attachment
Create or update attachment
Copy single page
Get macro body by macro ID and convert representation Asynchronously
Get macro body by macro ID and convert the representation synchronously
Get macro body by macro ID
Remove label from content using query parameter
Remove label from content
Add labels to content
Get watches for page
Get watches for space
Copy page hierarchy
Delete page tree
Check content permissions
Get restrictions by operation
Remove group from content restriction
Get content restriction status for group
Add group to content restriction
Get restrictions for operation
Remove user from content restriction
Get content restriction status for user
Add user to content restriction
Delete restrictions
Get restrictions
Add restrictions
Update restrictions
Gets available content states for content.
Removes the content state of a content and publishes a new version.
Get content state
Set the content state of a content and publishes a new version of the content.
Restore content version
Delete content version
Move a page to a new location relative to a target page
Search content by CQL
Get Custom Content States
Get asynchronous content body conversion task result in bulk
Create asynchronous content body conversion tasks in bulk
Get asynchronously converted content body from the id or the current status of the task.
Asynchronously convert content body
Delete user group
Get group
Get groups
Get group members
Search groups by partial query
Create new user group
Remove member from group using group id
Add member to group by groupId
Get label information
Get long-running tasks
Get long-running task
Find target entities related to a source entity
GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
Find relationship from source to target
Find source entities related to a target entity
Search content
Search users
Reset look and feel settings
Update look and feel settings
Get look and feel settings
Select look and feel settings
Get system info
Get themes
Get global theme
Create private space
Create space
Delete space
Remove label from a space
Get Space Labels
Add labels to a space
Add new custom content permission to space
Remove a space permission
Add new permission to space
Update space
Get space settings
Update space settings
Get content in space with given content state
Get space suggested content states
Get content state settings for space
Reset space theme
Get space theme
Set space theme
Get space watchers
Get blueprint templates
Remove template
Get content template
Get content templates
Create content template
Update content template
Get anonymous user
Get multiple users using ids
Get current user
Get user email addresses in batch
Get user email address
Get user
Get group memberships for user
Get user properties
Delete user property
Get user property
Create user property by key
Update user property
Remove content watcher
Get content watch status
Add content watcher
Remove label watcher
Get label watch status
Add label watcher
Remove space watch
Get space watch status
Add space watcher
Remove modules
Register modules