Confluence
Collaborative knowledge management
Overview
- Version: 2.0.0
- Base URL:
https://api.atlassian.com - Category: Productivity
- Tools Available: 193
- Rate Limit: 10 requests per second per app
- Documentation: https://developer.atlassian.com/cloud/confluence/rest/v2
Quick Start
from ocp_agent import OCPAgent
agent = OCPAgent()
# Register with authentication
await agent.register_api(
'confluence',
headers={'Authorization': 'Bearer your_token_here'}
)
# List available tools
tools = agent.list_tools('confluence')
print(f"Available: {len(tools)} tools")Authentication
Type: Bearer
Create an Atlassian API token at https://id.atlassian.com/manage-profile/security/api-tokens
See the Authentication Guide for general setup instructions.
Available Tools
This API provides 193 tools across various resource types.
attachments
POST
createAttachmentProperty
DELETE
deleteAttachment
DELETE
deleteAttachmentPropertyById
GET
getAttachmentById
GET
getAttachmentComments
GET
getAttachmentContentProperties
GET
getAttachmentContentPropertiesById
GET
getAttachmentLabels
GET
getAttachmentOperations
GET
getAttachments
GET
getAttachmentVersionDetails
GET
getAttachmentVersions
PUT
updateAttachmentPropertyById
blogposts
POST
createBlogPost
POST
createBlogpostProperty
DELETE
deleteBlogPost
DELETE
deleteBlogpostPropertyById
GET
getBlogpostAttachments
GET
getBlogPostById
GET
getBlogPostClassificationLevel
GET
getBlogpostContentProperties
GET
getBlogpostContentPropertiesById
GET
getBlogPostFooterComments
GET
getBlogPostInlineComments
GET
getBlogPostLabels
GET
getBlogPostLikeCount
GET
getBlogPostLikeUsers
GET
getBlogPostOperations
GET
getBlogPosts
GET
getBlogPostVersionDetails
GET
getBlogPostVersions
GET
getCustomContentByTypeInBlogPost
POST
postBlogPostClassificationLevel
POST
postRedactBlog
PUT
putBlogPostClassificationLevel
PUT
updateBlogPost
PUT
updateBlogpostPropertyById
custom-content
POST
createCustomContent
POST
createCustomContentProperty
DELETE
deleteCustomContent
DELETE
deleteCustomContentPropertyById
GET
getChildCustomContent
GET
getCustomContentAttachments
GET
getCustomContentById
GET
getCustomContentByType
GET
getCustomContentComments
GET
getCustomContentContentProperties
GET
getCustomContentContentPropertiesById
GET
getCustomContentLabels
GET
getCustomContentOperations
GET
getCustomContentVersionDetails
GET
getCustomContentVersions
PUT
updateCustomContent
PUT
updateCustomContentPropertyById
labels
pages
POST
createPage
POST
createPageProperty
DELETE
deletePage
DELETE
deletePagePropertyById
GET
getChildPages
GET
getCustomContentByTypeInPage
GET
getPageAncestors
GET
getPageAttachments
GET
getPageById
GET
getPageClassificationLevel
GET
getPageContentProperties
GET
getPageContentPropertiesById
GET
getPageDescendants
GET
getPageDirectChildren
GET
getPageFooterComments
GET
getPageInlineComments
GET
getPageLabels
GET
getPageLikeCount
GET
getPageLikeUsers
GET
getPageOperations
GET
getPages
GET
getPageVersionDetails
GET
getPageVersions
POST
postPageClassificationLevel
POST
postRedactPage
PUT
putPageClassificationLevel
PUT
updatePage
PUT
updatePagePropertyById
PUT
updatePageTitle
whiteboards
POST
createWhiteboard
POST
createWhiteboardProperty
DELETE
deleteWhiteboard
DELETE
deleteWhiteboardPropertyById
GET
getWhiteboardAncestors
GET
getWhiteboardById
GET
getWhiteboardClassificationLevel
GET
getWhiteboardContentProperties
GET
getWhiteboardContentPropertiesById
GET
getWhiteboardDescendants
GET
getWhiteboardDirectChildren
GET
getWhiteboardOperations
POST
postWhiteboardClassificationLevel
PUT
putWhiteboardClassificationLevel
PUT
updateWhiteboardPropertyById
databases
POST
createDatabase
POST
createDatabaseProperty
DELETE
deleteDatabase
DELETE
deleteDatabasePropertyById
GET
getDatabaseAncestors
GET
getDatabaseById
GET
getDatabaseClassificationLevel
GET
getDatabaseContentProperties
GET
getDatabaseContentPropertiesById
GET
getDatabaseDescendants
GET
getDatabaseDirectChildren
GET
getDatabaseOperations
POST
postDatabaseClassificationLevel
PUT
putDatabaseClassificationLevel
PUT
updateDatabasePropertyById
embeds
POST
createSmartLink
POST
createSmartLinkProperty
DELETE
deleteSmartLink
DELETE
deleteSmartLinkPropertyById
GET
getSmartLinkAncestors
GET
getSmartLinkById
GET
getSmartLinkContentProperties
GET
getSmartLinkContentPropertiesById
GET
getSmartLinkDescendants
GET
getSmartLinkDirectChildren
GET
getSmartLinkOperations
PUT
updateSmartLinkPropertyById
folders
POST
createFolder
POST
createFolderProperty
DELETE
deleteFolder
DELETE
deleteFolderPropertyById
GET
getFolderAncestors
GET
getFolderById
GET
getFolderContentProperties
GET
getFolderContentPropertiesById
GET
getFolderDescendants
GET
getFolderDirectChildren
GET
getFolderOperations
PUT
updateFolderPropertyById
spaces
POST
createSpace
POST
createSpaceProperty
DELETE
deleteSpaceDefaultClassificationLevel
DELETE
deleteSpacePropertyById
GET
getBlogPostsInSpace
GET
getCustomContentByTypeInSpace
GET
getPagesInSpace
GET
getSpaceById
GET
getSpaceContentLabels
GET
getSpaceDefaultClassificationLevel
GET
getSpaceLabels
GET
getSpaceOperations
GET
getSpacePermissionsAssignments
GET
getSpaceProperties
GET
getSpacePropertyById
GET
getSpaceRoleAssignments
GET
getSpaces
PUT
putSpaceDefaultClassificationLevel
POST
setSpaceRoleAssignments
PUT
updateSpacePropertyById
footer-comments
POST
createFooterComment
DELETE
deleteFooterComment
GET
getFooterCommentById
GET
getFooterCommentChildren
GET
getFooterCommentOperations
GET
getFooterComments
GET
getFooterCommentVersionDetails
GET
getFooterCommentVersions
GET
getFooterLikeCount
GET
getFooterLikeUsers
PUT
updateFooterComment
inline-comments
POST
createInlineComment
DELETE
deleteInlineComment
GET
getInlineCommentById
GET
getInlineCommentChildren
GET
getInlineCommentOperations
GET
getInlineComments
GET
getInlineCommentVersionDetails
GET
getInlineCommentVersions
GET
getInlineLikeCount
GET
getInlineLikeUsers
PUT
updateInlineComment
comments
POST
createCommentProperty
DELETE
deleteCommentPropertyById
GET
getCommentContentProperties
GET
getCommentContentPropertiesById
PUT
updateCommentPropertyById
tasks
user
Usage Example
from ocp_agent import OCPAgent
# Initialize agent
agent = OCPAgent()
# Register the Confluence
api = await agent.register_api('confluence')
# List available tools
tools = agent.list_tools('confluence')
print(f"Available tools: {len(tools)}")
# Use a tool (example)
# result = await agent.call_tool('tool_name', parameters)