How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluence Cloud REST API v2

The recommended Confluence Cloud REST surface. 218 cursor-paginated operations under /wiki/api/v2 covering pages, blog posts, spaces, attachments, comments, labels, versions, tasks, custom content, databases, folders, whiteboards, smart links, space roles and permissions, classification levels and content properties.

Confluence Cloud REST API v2 is one of 4 APIs that Atlassian Confluence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pages, Spaces, Attachments, Comments, and Labels. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a getting-started guide.

This API exposes 218 operations across 151 paths, organized into 30 resource areas, and defines 142 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, https://{your-domain}/wiki/api/v2.

218 operations 151 paths 142 schemas 24 DELETE134 GET36 POST24 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://{your-domain}/wiki/api/v2
Authentication
HTTP Basic, OAuth 2.0
Terms of Service
Resource Areas
30

Authentication & Security 2

Confluence Cloud REST API v2 declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 27 scopes.

  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.

Paths & Operations 218

Across 151 paths, the API surfaces 218 operations — 24 DELETE, 134 GET, 36 POST, 24 PUT. They span 30 resource areas, including Admin Key, Attachment, Label, Operation, Content Properties, Version, Comment, Blog Post, and 22 more. Each is listed below with its method, path, parameters, and response codes.

Admin Key 3

The [Admin Key feature](https://support.atlassian.com/confluence-cloud/docs/bypass-access-restrictions-on-a-page-with-admin-key/) is only offered with Confluence Cloud Premium and…

GET
/admin-key
Get Admin Key
getAdminKey → 200401404
POST
/admin-key
Enable Admin Key
enableAdminKey body → 200400401404
DELETE
/admin-key
Disable Admin Key
disableAdminKey → 204401404
Attachment 8
GET
/attachments
Get attachments
getAttachments 6 params → 200400401
GET
/attachments/{id}
Get attachment by id
getAttachmentById 8 params → 200400401404
DELETE
/attachments/{id}
Delete attachment
deleteAttachment 2 params → 204400401404
GET
/blogposts/{id}/attachments
Get attachments for blog post
getBlogpostAttachments 7 params → 200400401404
GET
/custom-content/{id}/attachments
Get attachments for custom content
getCustomContentAttachments 7 params → 200400401404
GET
/labels/{id}/attachments
Get attachments for label
getLabelAttachments 4 params → 200400401404
GET
/pages/{id}/attachments
Get attachments for page
getPageAttachments 7 params → 200400401404
GET
/attachments/{id}/thumbnail/download
Download attachment thumbnail by id
getAttachmentThumbnailById 4 params → 302400401404
Label 7
GET
/attachments/{id}/labels
Get labels for attachment
getAttachmentLabels 5 params → 200400401404
GET
/blogposts/{id}/labels
Get labels for blog post
getBlogPostLabels 5 params → 200400401404
GET
/custom-content/{id}/labels
Get labels for custom content
getCustomContentLabels 5 params → 200400401404
GET
/labels
Get labels
getLabels 5 params → 200400401
GET
/pages/{id}/labels
Get labels for page
getPageLabels 5 params → 200400401404
GET
/spaces/{id}/labels
Get labels for space
getSpaceLabels 5 params → 200400401404
GET
/spaces/{id}/content/labels
Get labels for space content
getSpaceContentLabels 5 params → 200400401404
Operation 11
GET
/attachments/{id}/operations
Get permitted operations for attachment
getAttachmentOperations 1 param → 200400401404
GET
/blogposts/{id}/operations
Get permitted operations for blog post
getBlogPostOperations 1 param → 200400401404
GET
/custom-content/{id}/operations
Get permitted operations for custom content
getCustomContentOperations 1 param → 200400401404
GET
/pages/{id}/operations
Get permitted operations for page
getPageOperations 1 param → 200400401404
GET
/whiteboards/{id}/operations
Get permitted operations for a whiteboard
getWhiteboardOperations 1 param → 200400401404
GET
/databases/{id}/operations
Get permitted operations for a database
getDatabaseOperations 1 param → 200400401404
GET
/embeds/{id}/operations
Get permitted operations for a Smart Link in the content tree
getSmartLinkOperations 1 param → 200400401404
GET
/folders/{id}/operations
Get permitted operations for a folder
getFolderOperations 1 param → 200400401404
GET
/spaces/{id}/operations
Get permitted operations for space
getSpaceOperations 1 param → 200400401404
GET
/footer-comments/{id}/operations
Get permitted operations for footer comment
getFooterCommentOperations 1 param → 200400401404
GET
/inline-comments/{id}/operations
Get permitted operations for inline comment
getInlineCommentOperations 1 param → 200400401404
Content Properties 45
GET
/attachments/{attachment-id}/properties
Get content properties for attachment
getAttachmentContentProperties 5 params → 200400401404
POST
/attachments/{attachment-id}/properties
Create content property for attachment
createAttachmentProperty 1 param body → 200400401404
GET
/attachments/{attachment-id}/properties/{property-id}
Get content property for attachment by id
getAttachmentContentPropertiesById 2 params → 200400401404
PUT
/attachments/{attachment-id}/properties/{property-id}
Update content property for attachment by id
updateAttachmentPropertyById 2 params body → 200400401404
DELETE
/attachments/{attachment-id}/properties/{property-id}
Delete content property for attachment by id
deleteAttachmentPropertyById 2 params → 204400401404
GET
/blogposts/{blogpost-id}/properties
Get content properties for blog post
getBlogpostContentProperties 5 params → 200400401404
POST
/blogposts/{blogpost-id}/properties
Create content property for blog post
createBlogpostProperty 1 param body → 200400401404
GET
/blogposts/{blogpost-id}/properties/{property-id}
Get content property for blog post by id
getBlogpostContentPropertiesById 2 params → 200400401404
PUT
/blogposts/{blogpost-id}/properties/{property-id}
Update content property for blog post by id
updateBlogpostPropertyById 2 params body → 200400401404
DELETE
/blogposts/{blogpost-id}/properties/{property-id}
Delete content property for blogpost by id
deleteBlogpostPropertyById 2 params → 204400401404
GET
/custom-content/{custom-content-id}/properties
Get content properties for custom content
getCustomContentContentProperties 5 params → 200400401404
POST
/custom-content/{custom-content-id}/properties
Create content property for custom content
createCustomContentProperty 1 param body → 200400401404
GET
/custom-content/{custom-content-id}/properties/{property-id}
Get content property for custom content by id
getCustomContentContentPropertiesById 2 params → 200400401404
PUT
/custom-content/{custom-content-id}/properties/{property-id}
Update content property for custom content by id
updateCustomContentPropertyById 2 params body → 200400401404
DELETE
/custom-content/{custom-content-id}/properties/{property-id}
Delete content property for custom content by id
deleteCustomContentPropertyById 2 params → 204400401404
GET
/pages/{page-id}/properties
Get content properties for page
getPageContentProperties 5 params → 200400401404
POST
/pages/{page-id}/properties
Create content property for page
createPageProperty 1 param body → 200400401404
GET
/pages/{page-id}/properties/{property-id}
Get content property for page by id
getPageContentPropertiesById 2 params → 200400401404
PUT
/pages/{page-id}/properties/{property-id}
Update content property for page by id
updatePagePropertyById 2 params body → 200400401404
DELETE
/pages/{page-id}/properties/{property-id}
Delete content property for page by id
deletePagePropertyById 2 params → 204400401404
GET
/whiteboards/{id}/properties
Get content properties for whiteboard
getWhiteboardContentProperties 5 params → 200400401404
POST
/whiteboards/{id}/properties
Create content property for whiteboard
createWhiteboardProperty 1 param body → 200400401404
GET
/whiteboards/{whiteboard-id}/properties/{property-id}
Get content property for whiteboard by id
getWhiteboardContentPropertiesById 2 params → 200400401404
PUT
/whiteboards/{whiteboard-id}/properties/{property-id}
Update content property for whiteboard by id
updateWhiteboardPropertyById 2 params body → 200400401404
DELETE
/whiteboards/{whiteboard-id}/properties/{property-id}
Delete content property for whiteboard by id
deleteWhiteboardPropertyById 2 params → 204400401404
GET
/databases/{id}/properties
Get content properties for database
getDatabaseContentProperties 5 params → 200400401404
POST
/databases/{id}/properties
Create content property for database
createDatabaseProperty 1 param body → 200400401404
GET
/databases/{database-id}/properties/{property-id}
Get content property for database by id
getDatabaseContentPropertiesById 2 params → 200400401404
PUT
/databases/{database-id}/properties/{property-id}
Update content property for database by id
updateDatabasePropertyById 2 params body → 200400401404
DELETE
/databases/{database-id}/properties/{property-id}
Delete content property for database by id
deleteDatabasePropertyById 2 params → 204400401404
GET
/embeds/{id}/properties
Get content properties for Smart Link in the content tree
getSmartLinkContentProperties 5 params → 200400401404
POST
/embeds/{id}/properties
Create content property for Smart Link in the content tree
createSmartLinkProperty 1 param body → 200400401404
GET
/embeds/{embed-id}/properties/{property-id}
Get content property for Smart Link in the content tree by id
getSmartLinkContentPropertiesById 2 params → 200400401404
PUT
/embeds/{embed-id}/properties/{property-id}
Update content property for Smart Link in the content tree by id
updateSmartLinkPropertyById 2 params body → 200400401404
DELETE
/embeds/{embed-id}/properties/{property-id}
Delete content property for Smart Link in the content tree by id
deleteSmartLinkPropertyById 2 params → 204400401404
GET
/folders/{id}/properties
Get content properties for folder
getFolderContentProperties 5 params → 200400401404
POST
/folders/{id}/properties
Create content property for folder
createFolderProperty 1 param body → 200400401404
GET
/folders/{folder-id}/properties/{property-id}
Get content property for folder by id
getFolderContentPropertiesById 2 params → 200400401404
PUT
/folders/{folder-id}/properties/{property-id}
Update content property for folder by id
updateFolderPropertyById 2 params body → 200400401404
DELETE
/folders/{folder-id}/properties/{property-id}
Delete content property for folder by id
deleteFolderPropertyById 2 params → 204400401404
GET
/comments/{comment-id}/properties
Get content properties for comment
getCommentContentProperties 5 params → 200400401404
POST
/comments/{comment-id}/properties
Create content property for comment
createCommentProperty 1 param body → 200400401404
GET
/comments/{comment-id}/properties/{property-id}
Get content property for comment by id
getCommentContentPropertiesById 2 params → 200400401404
PUT
/comments/{comment-id}/properties/{property-id}
Update content property for comment by id
updateCommentPropertyById 2 params body → 200400401404
DELETE
/comments/{comment-id}/properties/{property-id}
Delete content property for comment by id
deleteCommentPropertyById 2 params → 204400401404
Version 12
GET
/attachments/{id}/versions
Get attachment versions
getAttachmentVersions 4 params → 200400401404
GET
/attachments/{attachment-id}/versions/{version-number}
Get version details for attachment version
getAttachmentVersionDetails 2 params → 200400401404
GET
/blogposts/{id}/versions
Get blog post versions
getBlogPostVersions 5 params → 200400401404
GET
/blogposts/{blogpost-id}/versions/{version-number}
Get version details for blog post version
getBlogPostVersionDetails 2 params → 200400401404
GET
/pages/{id}/versions
Get page versions
getPageVersions 5 params → 200400401404
GET
/pages/{page-id}/versions/{version-number}
Get version details for page version
getPageVersionDetails 2 params → 200400401404
GET
/custom-content/{custom-content-id}/versions
Get custom content versions
getCustomContentVersions 5 params → 200400401404
GET
/custom-content/{custom-content-id}/versions/{version-number}
Get version details for custom content version
getCustomContentVersionDetails 2 params → 200400401404
GET
/footer-comments/{id}/versions
Get footer comment versions
getFooterCommentVersions 5 params → 200400401404
GET
/footer-comments/{id}/versions/{version-number}
Get version details for footer comment version
getFooterCommentVersionDetails 2 params → 200400401404
GET
/inline-comments/{id}/versions
Get inline comment versions
getInlineCommentVersions 5 params → 200400401404
GET
/inline-comments/{id}/versions/{version-number}
Get version details for inline comment version
getInlineCommentVersionDetails 2 params → 200400401404
Comment 18
GET
/attachments/{id}/footer-comments
Get attachment comments
getAttachmentComments 6 params → 200400401404
GET
/custom-content/{id}/footer-comments
Get custom content comments
getCustomContentComments 5 params → 200400401404
GET
/pages/{id}/footer-comments
Get footer comments for page
getPageFooterComments 6 params → 200400401404
GET
/pages/{id}/inline-comments
Get inline comments for page
getPageInlineComments 7 params → 200400401404
GET
/blogposts/{id}/footer-comments
Get footer comments for blog post
getBlogPostFooterComments 6 params → 200400401404
GET
/blogposts/{id}/inline-comments
Get inline comments for blog post
getBlogPostInlineComments 7 params → 200400401404
GET
/footer-comments
Get footer comments
getFooterComments 4 params → 200400401
POST
/footer-comments
Create footer comment
createFooterComment body → 201400401404
GET
/footer-comments/{comment-id}
Get footer comment by id
getFooterCommentById 8 params → 200400401404
PUT
/footer-comments/{comment-id}
Update footer comment
updateFooterComment 1 param body → 200400401404
DELETE
/footer-comments/{comment-id}
Delete footer comment
deleteFooterComment 1 param → 204400401404
GET
/footer-comments/{id}/children
Get children footer comments
getFooterCommentChildren 5 params → 200400401404
GET
/inline-comments
Get inline comments
getInlineComments 4 params → 200400401
POST
/inline-comments
Create inline comment
createInlineComment body → 201400401404
GET
/inline-comments/{comment-id}
Get inline comment by id
getInlineCommentById 8 params → 200400401404
PUT
/inline-comments/{comment-id}
Update inline comment
updateInlineComment 1 param body → 200400401404
DELETE
/inline-comments/{comment-id}
Delete inline comment
deleteInlineComment 1 param → 204400401404
GET
/inline-comments/{id}/children
Get children inline comments
getInlineCommentChildren 5 params → 200400401404
Blog Post 7
GET
/blogposts
Get blog posts
getBlogPosts 8 params → 200400401
POST
/blogposts
Create blog post
createBlogPost 1 param body → 200400401404413
GET
/blogposts/{id}
Get blog post by id
getBlogPostById 14 params → 200400401404
PUT
/blogposts/{id}
Update blog post
updateBlogPost 1 param body → 200400401404
DELETE
/blogposts/{id}
Delete blog post
deleteBlogPost 3 params → 204400401404
GET
/labels/{id}/blogposts
Get blog posts for label
getLabelBlogPosts 6 params → 200400401404
GET
/spaces/{id}/blogposts
Get blog posts in space
getBlogPostsInSpace 7 params → 200400401404
Custom Content 8
GET
/blogposts/{id}/custom-content
Get custom content by type in blog post
getCustomContentByTypeInBlogPost 6 params → 200400401404
GET
/custom-content
Get custom content by type
getCustomContentByType 7 params → 200400401404
POST
/custom-content
Create custom content
createCustomContent body → 201400401404
GET
/custom-content/{id}
Get custom content by id
getCustomContentById 9 params → 200400401404
PUT
/custom-content/{id}
Update custom content
updateCustomContent 1 param body → 200400401404
DELETE
/custom-content/{id}
Delete custom content
deleteCustomContent 2 params → 204400401404
GET
/pages/{id}/custom-content
Get custom content by type in page
getCustomContentByTypeInPage 6 params → 200400401404
GET
/spaces/{id}/custom-content
Get custom content by type in space
getCustomContentByTypeInSpace 5 params → 200400401404
Like 8
GET
/blogposts/{id}/likes/count
Get like count for blog post
getBlogPostLikeCount 1 param → 200400401404
GET
/blogposts/{id}/likes/users
Get account IDs of likes for blog post
getBlogPostLikeUsers 3 params → 200400401404
GET
/pages/{id}/likes/count
Get like count for page
getPageLikeCount 1 param → 200400401404
GET
/pages/{id}/likes/users
Get account IDs of likes for page
getPageLikeUsers 3 params → 200400401404
GET
/footer-comments/{id}/likes/count
Get like count for footer comment
getFooterLikeCount 1 param → 200400401404
GET
/footer-comments/{id}/likes/users
Get account IDs of likes for footer comment
getFooterLikeUsers 3 params → 200400401404
GET
/inline-comments/{id}/likes/count
Get like count for inline comment
getInlineLikeCount 1 param → 200400401404
GET
/inline-comments/{id}/likes/users
Get account IDs of likes for inline comment
getInlineLikeUsers 3 params → 200400401404
Content 1
POST
/content/convert-ids-to-types
Convert content ids to content types
convertContentIdsToContentTypes body → 200400401
Page 8
GET
/labels/{id}/pages
Get pages for label
getLabelPages 6 params → 200400401404
GET
/pages
Get pages
getPages 9 params → 200400401
POST
/pages
Create page
createPage 3 params body → 200400401404413
GET
/pages/{id}
Get page by id
getPageById 15 params → 200400401404
PUT
/pages/{id}
Update page
updatePage 1 param body → 200400401404
DELETE
/pages/{id}
Delete page
deletePage 3 params → 204400401404
PUT
/pages/{id}/title
Update page title
updatePageTitle 1 param body → 200400401404
GET
/spaces/{id}/pages
Get pages in space
getPagesInSpace 8 params → 200400401404
Redactions 2
POST
/pages/{id}/redact
Redact Content in a Confluence Page
postRedactPage 1 param body → 202400
POST
/blogposts/{id}/redact
Redact Content in a Confluence Blog Post
postRedactBlog 1 param body → 202400
Whiteboard 3
POST
/whiteboards
Create whiteboard
createWhiteboard 1 param body → 200400401404413
GET
/whiteboards/{id}
Get whiteboard by id
getWhiteboardById 5 params → 200400401404
DELETE
/whiteboards/{id}
Delete whiteboard
deleteWhiteboard 1 param → 204400401404
Children 7
GET
/whiteboards/{id}/direct-children
Get direct children of a whiteboard
getWhiteboardDirectChildren 4 params → 200400401
GET
/databases/{id}/direct-children
Get direct children of a database
getDatabaseDirectChildren 4 params → 200400401404
GET
/embeds/{id}/direct-children
Get direct children of a Smart Link
getSmartLinkDirectChildren 4 params → 200400401404
GET
/folders/{id}/direct-children
Get direct children of a folder
getFolderDirectChildren 4 params → 200400401404
GET
/pages/{id}/childrendeprecated
Get child pages
getChildPages 4 params → 200400401
GET
/custom-content/{id}/children
Get child custom content
getChildCustomContent 4 params → 200400401
GET
/pages/{id}/direct-children
Get direct children of a page
getPageDirectChildren 4 params → 200400401404
Descendants 5
GET
/whiteboards/{id}/descendants
Get descendants of a whiteboard
getWhiteboardDescendants 4 params → 200400401404
GET
/databases/{id}/descendants
Get descendants of a database
getDatabaseDescendants 4 params → 200400401404
GET
/embeds/{id}/descendants
Get descendants of a smart link
getSmartLinkDescendants 4 params → 200400401404
GET
/folders/{id}/descendants
Get descendants of folder
getFolderDescendants 4 params → 200400401404
GET
/pages/{id}/descendants
Get descendants of page
getPageDescendants 4 params → 200400401404
Ancestors 5
GET
/whiteboards/{id}/ancestors
Get all ancestors of whiteboard
getWhiteboardAncestors 2 params → 200400401404
GET
/databases/{id}/ancestors
Get all ancestors of database
getDatabaseAncestors 2 params → 200400401404
GET
/embeds/{id}/ancestors
Get all ancestors of Smart Link in content tree
getSmartLinkAncestors 2 params → 200400401404
GET
/folders/{id}/ancestors
Get all ancestors of folder
getFolderAncestors 2 params → 200400401404
GET
/pages/{id}/ancestors
Get all ancestors of page
getPageAncestors 2 params → 200400401404
Database 3
POST
/databases
Create database
createDatabase 1 param body → 200400401404413
GET
/databases/{id}
Get database by id
getDatabaseById 5 params → 200400401404
DELETE
/databases/{id}
Delete database
deleteDatabase 1 param → 204400401404
Smart Link 3
POST
/embeds
Create Smart Link in the content tree
createSmartLink body → 200400401404413
GET
/embeds/{id}
Get Smart Link in the content tree by id
getSmartLinkById 5 params → 200400401404
DELETE
/embeds/{id}
Delete Smart Link in the content tree
deleteSmartLink 1 param → 204400401404
Folder 3
POST
/folders
Create folder
createFolder body → 200400401404413
GET
/folders/{id}
Get folder by id
getFolderById 5 params → 200400401404
DELETE
/folders/{id}
Delete folder
deleteFolder 1 param → 204400401404
Space 3
GET
/spaces
Get spaces
getSpaces 12 params → 200400401
POST
/spaces
Create space
createSpace body → 201400401404413
GET
/spaces/{id}
Get space by id
getSpaceById 8 params → 200400401404
Space Properties 5
GET
/spaces/{space-id}/properties
Get space properties in space
getSpaceProperties 4 params → 200400401404
POST
/spaces/{space-id}/properties
Create space property in space
createSpaceProperty 1 param body → 201400401404
GET
/spaces/{space-id}/properties/{property-id}
Get space property by id
getSpacePropertyById 2 params → 200400401404
PUT
/spaces/{space-id}/properties/{property-id}
Update space property by id
updateSpacePropertyById 2 params body → 200400401404
DELETE
/spaces/{space-id}/properties/{property-id}
Delete space property by id
deleteSpacePropertyById 2 params → 204400401404
Space Permissions 2
GET
/spaces/{id}/permissions
Get space permissions assignments
getSpacePermissionsAssignments 3 params → 200400401404
GET
/space-permissions
Get available space permissions
getAvailableSpacePermissions 2 params → 200400401404
Space Permission Transition 5
GET
/space-permissions/transition/combinations
List unassigned space permission combinations
listSpacePermissionCombinations 2 params → 200400401404
POST
/space-permissions/transition/combinations
Generate space permission combinations
generateSpacePermissionCombinations → 202401404
POST
/space-permissions/transition/role-assignments
Bulk assign space permission roles
bulkAssignSpacePermissionRoles body → 202400401404
POST
/space-permissions/transition/access-removals
Bulk remove space permission access
bulkRemoveSpacePermissionAccess body → 202400401404
GET
/space-permissions/transition/tasks/{taskId}
Get space permission transition task status
getSpacePermissionTransitionTaskStatus 1 param → 200401404
Space Roles 8
GET
/space-roles
Get available space roles
getAvailableSpaceRoles 6 params → 200400401404
POST
/space-roles
Create a space role
createSpaceRole body → 201400401404
GET
/space-roles/{id}
Get space role by ID
getSpaceRolesById 1 param → 200400401404
PUT
/space-roles/{id}
Update a space role
updateSpaceRole 1 param body → 202400401404
DELETE
/space-roles/{id}
Delete a space role
deleteSpaceRole 1 param → 202400401404
GET
/space-role-mode
Get space role mode
getSpaceRoleMode → 200400401404
GET
/spaces/{id}/role-assignments
Get space role assignments
getSpaceRoleAssignments 7 params → 200400401404
POST
/spaces/{id}/role-assignments
Set space role assignments
setSpaceRoleAssignments 1 param body → 200400401404413
Task 3
GET
/tasks
Get tasks
getTasks 18 params → 200400401
GET
/tasks/{id}
Get task by id
getTaskById 2 params → 200400401404
PUT
/tasks/{id}
Update task
updateTask 2 params body → 200400401404
User 3
POST
/users-bulk
Create bulk user lookup using ids
createBulkUserLookup body → 200400404
POST
/user/access/check-access-by-email
Check site access for a list of emails
checkAccessByEmail body → 200400401404503
POST
/user/access/invite-by-email
Invite a list of emails to the site
inviteByEmail body → 200400401404503
Data Policies 2
GET
/data-policies/metadata
Get data policy metadata for the workspace
getDataPolicyMetadata → 200400401
GET
/data-policies/spaces
Get spaces with data policies
getDataPolicySpaces 5 params → 200400401
Classification Level 16
GET
/classification-levels
Get list of classification levels
getClassificationLevels → 200400401404
GET
/spaces/{id}/classification-level/default
Get space default classification level
getSpaceDefaultClassificationLevel 1 param → 200400401404
PUT
/spaces/{id}/classification-level/default
Update space default classification level
putSpaceDefaultClassificationLevel 1 param body → 204400401404
DELETE
/spaces/{id}/classification-level/default
Delete space default classification level
deleteSpaceDefaultClassificationLevel 1 param → 204400401404
GET
/pages/{id}/classification-level
Get page classification level
getPageClassificationLevel 2 params → 200400401404
PUT
/pages/{id}/classification-level
Update page classification level
putPageClassificationLevel 1 param body → 204400401404
POST
/pages/{id}/classification-level/reset
Reset page classification level
postPageClassificationLevel 1 param body → 204400401404
GET
/blogposts/{id}/classification-level
Get blog post classification level
getBlogPostClassificationLevel 2 params → 200400401404
PUT
/blogposts/{id}/classification-level
Update blog post classification level
putBlogPostClassificationLevel 1 param body → 204400401404
POST
/blogposts/{id}/classification-level/reset
Reset blog post classification level
postBlogPostClassificationLevel 1 param body → 204400401404
GET
/whiteboards/{id}/classification-level
Get whiteboard classification level
getWhiteboardClassificationLevel 1 param → 200400401404
PUT
/whiteboards/{id}/classification-level
Update whiteboard classification level
putWhiteboardClassificationLevel 1 param body → 204400401404
POST
/whiteboards/{id}/classification-level/reset
Reset whiteboard classification level
postWhiteboardClassificationLevel 1 param body → 204400401404
GET
/databases/{id}/classification-level
Get database classification level
getDatabaseClassificationLevel 1 param → 200400401404
PUT
/databases/{id}/classification-level
Update database classification level
putDatabaseClassificationLevel 1 param body → 204400401404
POST
/databases/{id}/classification-level/reset
Reset database classification level
postDatabaseClassificationLevel 1 param body → 204400401404
App Properties 4
GET
/app/properties
Get Forge app properties.
getForgeAppProperties 2 params → 200401403
GET
/app/properties/{propertyKey}
Get a Forge app property by key.
getForgeAppProperty 1 param → 200400401403404
PUT
/app/properties/{propertyKey}
Create or update a Forge app property.
putForgeAppProperty 1 param body → 200201400401403
DELETE
/app/properties/{propertyKey}
Deletes a Forge app property.
deleteForgeAppProperty 1 param → 204400401403

Schemas 142

The contract defines 142 schemas that model the data the API accepts and returns. The most detailed are AttachmentSingle (20 properties), PageSingle (20 properties), CustomContentSingle (17 properties), SpaceSingle (16 properties). Each schema is shown below with its type and property counts.

AdminKeyResponse
object
2 properties
AttachmentSingle
object
20 properties
AttachmentBulk
object
16 properties
BlogPostSingle
object
15 properties
BlogPostBulk
object
9 properties
TaskBodySingle
object
Contains fields for each representation type requested.
2 properties
BodySingle
object
Contains fields for each representation type requested.
3 properties
BodyBulk
object
Contains fields for each representation type requested.
2 properties
BodyType
object
2 properties
PrimaryBodyRepresentation
string
The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.
PrimaryBodyRepresentationSingle
string
The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.
CustomContentBodyRepresentation
string
The formats a custom content body can be represented as. A subset of BodyRepresentation.
CustomContentBodyRepresentationSingle
string
The formats a custom content body can be represented as. A subset of BodyRepresentation.
SpaceDescriptionBodyRepresentation
string
The formats a space description can be represented as. A subset of BodyRepresentation.
ContentIdToContentTypeResponse
object
1 property
ContentStatus
string
The status of the content.
BlogPostContentStatus
string
The status of the content.
OnlyArchivedAndCurrentContentStatus
string
The status of the content.
ContentProperty
object
4 properties
ContentPropertyCreateRequest
object
2 properties
ContentPropertyUpdateRequest
object
3 properties
CustomContentSingle
object
17 properties
CustomContentBulk
object
13 properties
CustomContentBodySingle
object
Contains fields for each representation type requested.
4 properties
CustomContentBodyBulk
object
Contains fields for each representation type requested.
3 properties
DetailedVersion
object
9 properties
Label
object
3 properties
Like
object
1 property
Operation
object
2 properties
PermittedOperationsResponse
object
The list of operations permitted on entity.
1 property
PageSingle
object
20 properties
PageBulk
object
15 properties
ParentContentType
string
Content type of the parent, or null if there is no parent.
PageBodyWrite
object
2 properties
PageNestedBodyWrite
object
Body of the page. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
BlogPostBodyWrite
object
2 properties
BlogPostNestedBodyWrite
object
Body of the blog post. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
CommentBodyWrite
object
2 properties
CommentNestedBodyWrite
object
Body of the comment. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
CustomContentBodyWrite
object
2 properties
CustomContentNestedBodyWrite
object
Body of the custom content. Only one body format should be specified as the property for this object, e.g. storage.
3 properties
ChildPage
object
5 properties
ChildCustomContent
object
5 properties
ChildrenResponse
object
6 properties
DescendantsResponse
object
7 properties
WhiteboardSingle
object
13 properties
DatabaseSingle
object
13 properties
SmartLinkSingle
object
14 properties
FolderSingle
object
13 properties
Ancestor
object
2 properties
AncestorType
string
The type of ancestor.
Redaction
object
1 property
RedactionPointer
object
4 properties 1 required
RedactionResponse
object
Response containing details of all redactions that were applied to the content. Each redaction includes a unique ID for restoration, except that code block red…
2 properties
RedactionSectionResponse
object
1 property
RedactionPointerResponse
object
5 properties
SpaceSingle
object
16 properties
SpaceBulk
object
13 properties
SpaceDescription
object
Contains fields for each representation type requested.
2 properties
SpaceIcon
object
The icon of the space
2 properties
SpacePermission
object
4 properties
SpacePermissionAssignment
object
3 properties
SpaceRole
object
5 properties
UpdateSpaceRoleResponse
object
5 properties
DeleteSpaceRoleResponse
object
1 property
BulkTransitionTaskResponse
object
3 properties 3 required
BulkTransitionTaskStatusResponse
object
3 properties 2 required
BulkAssignRolesRequest
object
2 properties 2 required
BulkRemoveAccessRequest
object
2 properties 2 required
BulkTransitionRoleAssignment
object
2 properties 2 required
BulkTransitionPrincipalTypeAssignment
object
3 properties 2 required
BulkTransitionSpaceSelection
object
2 properties 1 required
BulkTransitionSpaceTarget
object
2 properties 2 required
ListSpacePermissionCombinationsResponse
object
3 properties 1 required
BulkTransitionCombinationEntry
object
5 properties 5 required
BulkTransitionDecodedPermission
object
2 properties 2 required
SpaceRoleAssignment
object
2 properties
Principal
object
The principal of the role assignment.
2 properties
PrincipalType
string
The principal type.
RoleType
string
The role type.
SpaceProperty
object
6 properties
SpacePropertyCreateRequest
object
2 properties
SpacePropertyUpdateRequest
object
3 properties
SpaceType
string
The type of space.
SpaceStatus
string
The status of the space.
Task
object
14 properties
AccountType
string
The account type of the user.
AccountStatus
string
The account status of the user.
Icon
object
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
2 properties 2 required
User
object
10 properties
Version
object
5 properties
AttachmentVersion
object
6 properties
BlogPostVersion
object
6 properties
PageVersion
object
6 properties
CustomContentVersion
object
6 properties
CommentVersion
object
6 properties
VersionedEntity
object
3 properties
AttachmentSortOrder
string
The sort fields for attachments. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example,…
BlogPostSortOrder
string
The sort fields for blog posts. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example,…
CommentSortOrder
string
The sort fields for comments. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fi…
ContentPropertySortOrder
string
The sort fields for content properties. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For e…
ContentSortOrder
string
The sort fields for hierarchical content types. The default sort direction is ascending. To sort in descending order, append a - character before the sort fiel…
LabelSortOrder
string
The sort fields for labels. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fiel…
ChildPageSortOrder
string
The sort fields for child pages. The default sort direction is ascending by child-position. To sort in descending order, append a - character before the sort f…
ChildCustomContentSortOrder
string
The sort fields for child custom content. The default sort direction is ascending by id. To sort in descending order, append a - character before the sort fiel…
CustomContentSortOrder
string
The sort fields for custom content. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For examp…
PageSortOrder
string
The sort fields for pages. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, field…
SpaceSortOrder
string
The sort fields for spaces. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fiel…
VersionSortOrder
string
The sort fields for versions. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fi…
InlineCommentResolutionStatus
string
Inline comment resolution status
InlineCommentProperties
object
2 properties
PageCommentModel
object
7 properties
PageInlineCommentModel
object
9 properties
BlogPostCommentModel
object
7 properties
BlogPostInlineCommentModel
object
9 properties
ChildrenCommentModel
object
7 properties
InlineCommentChildrenModel
object
9 properties
AttachmentCommentModel
object
7 properties
CustomContentCommentModel
object
7 properties
FooterCommentModel
object
15 properties
InlineCommentModel
object
16 properties
CreateFooterCommentModel
object
6 properties
CreateInlineCommentModel
object
5 properties
UpdateFooterCommentModel
object
2 properties
UpdateInlineCommentModel
object
3 properties
AbstractPageLinks
object
3 properties
AttachmentLinks
object
2 properties
CustomContentLinks
object
1 property
CommentLinks
object
1 property
DatabaseLinks
object
1 property
FolderLinks
object
1 property
SmartLinkLinks
object
1 property
SpaceLinks
object
1 property
WhiteboardLinks
object
2 properties
DataPolicyMetadata
object
Details about data policies.
1 property
DataPolicySpace
object
7 properties
OptionalFieldMeta
object
2 properties
OptionalFieldLinks
object
1 property
MultiEntityLinks
object
2 properties
ClassificationLevel
object
A unit of [data classification](https://support.atlassian.com/security-and-access-policies/docs/what-is-data-classification/) defined by an organiation. A clas…
7 properties
ClassificationLevelColor
string
ClassificationLevelStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-confluence-rest-v2-openapi.json Raw ↑

Other APIs Atlassian Confluence publishes across the network.

Confluence Cloud REST API v1
Confluence Cloud GraphQL API
Atlassian Rovo MCP Server (Confluence tools)
Where this information came from

This is an independent, third-party profile of Confluence Cloud REST API v2, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.