openapi: 3.1.0 info: title: Confluence Cloud REST API v2 description: >- Next generation REST API for Confluence Cloud providing access to pages, spaces, comments, blog posts, attachments, labels, and other content management operations. This API offers improved performance, consistent pagination, and new features compared to the v1 API. version: 2.0.0 contact: name: Atlassian url: https://developer.atlassian.com/cloud/confluence/ email: ecosystem@atlassian.com license: name: Atlassian Developer Terms url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ termsOfService: https://www.atlassian.com/legal/cloud-terms-of-service x-logo: url: https://www.atlassian.com/dam/jcr:5d1374c2-276f-4bca-9ce4-b3f5e2dd5d6c/confluence-icon-gradient-blue.svg servers: - url: https://{domain}.atlassian.net/wiki/api/v2 description: Confluence Cloud variables: domain: default: your-domain description: Your Atlassian Cloud site domain security: - basicAuth: [] - oAuth2: [] - bearerAuth: [] tags: - name: Page description: Create, retrieve, update, and delete pages externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/ - name: Space description: Retrieve and manage Confluence spaces externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/ - name: Comment description: Create, retrieve, update, and delete comments on pages and blog posts externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment/ - name: Blog Post description: Create, retrieve, update, and delete blog posts externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post/ - name: Attachment description: Manage file attachments on content externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment/ - name: Label description: Manage labels on content externalDocs: url: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label/ paths: /pages: get: operationId: getPages summary: Get Pages description: >- Returns all pages. The number of results is limited by the limit parameter and additional results can be retrieved via the next cursor. Results can be filtered by space, status, title, and body format. tags: - Page parameters: - $ref: '#/components/parameters/PageIdParam' - $ref: '#/components/parameters/SpaceIdFilter' - $ref: '#/components/parameters/StatusFilter' - $ref: '#/components/parameters/TitleFilter' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/SortParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the requested pages are returned. content: application/json: schema: $ref: '#/components/schemas/PageBulk' examples: Getpages200Example: summary: Default getPages 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' _links: next: example_value base: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createPage summary: Create Page description: >- Creates a page in the space. Pages can be created as a child of another page by specifying the parentId. Pages are created in the current status (draft or current). tags: - Page requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PageCreateRequest' examples: CreatepageRequestExample: summary: Default createPage request x-microcks-default: true value: spaceId: '500123' status: current title: Example Title parentId: '500123' body: representation: storage value: example_value responses: '200': description: Returned if the page was created successfully. content: application/json: schema: $ref: '#/components/schemas/Page' examples: Createpage200Example: summary: Default createPage 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} properties: results: - {} operations: results: - {} likes: results: - {} versions: results: - {} _links: webui: example_value editui: example_value tinyui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}: get: operationId: getPageById summary: Get Page by Id description: >- Returns a specific page. The response includes the page body in the requested format, version information, and links. tags: - Page parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/GetDraftParam' - $ref: '#/components/parameters/VersionParam' responses: '200': description: Returned if the requested page is returned. content: application/json: schema: $ref: '#/components/schemas/Page' examples: Getpagebyid200Example: summary: Default getPageById 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} properties: results: - {} operations: results: - {} likes: results: - {} versions: results: - {} _links: webui: example_value editui: example_value tinyui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updatePage summary: Update Page description: >- Updates a page by id. The request body must include the current version number, the new title, the space id, the status, and the body in the specified representation. tags: - Page parameters: - $ref: '#/components/parameters/ContentIdPath' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PageUpdateRequest' examples: UpdatepageRequestExample: summary: Default updatePage request x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' body: representation: storage value: example_value version: number: 10 message: example_value responses: '200': description: Returned if the page was updated successfully. content: application/json: schema: $ref: '#/components/schemas/Page' examples: Updatepage200Example: summary: Default updatePage 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} properties: results: - {} operations: results: - {} likes: results: - {} versions: results: - {} _links: webui: example_value editui: example_value tinyui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deletePage summary: Delete Page description: >- Deletes a page by id. By default pages are moved to trash. To purge a page permanently, set the purge parameter to true. tags: - Page parameters: - $ref: '#/components/parameters/ContentIdPath' - name: purge in: query description: If true, the page is permanently deleted instead of moved to trash. schema: type: boolean default: false example: true responses: '204': description: Returned if the page was deleted successfully. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}/children: get: operationId: getChildPages summary: Get Child Pages description: Returns the child pages of a specific page, ordered by position in the page tree. tags: - Page parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/SortParam' responses: '200': description: Returned if the child pages are returned. content: application/json: schema: $ref: '#/components/schemas/PageBulk' examples: Getchildpages200Example: summary: Default getChildPages 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' _links: next: example_value base: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}/labels: get: operationId: getPageLabels summary: Get Labels for Page description: Returns the labels associated with a specific page. tags: - Label parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/LabelPrefixParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the labels are returned. content: application/json: schema: $ref: '#/components/schemas/LabelArray' examples: Getpagelabels200Example: summary: Default getPageLabels 200 response x-microcks-default: true value: results: - id: abc123 name: Example Title prefix: example_value _links: next: example_value base: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /spaces: get: operationId: getSpaces summary: Get Spaces description: >- Returns all spaces. The results can be filtered by space type, status, and labels. Pagination is cursor-based. tags: - Space parameters: - name: ids in: query description: Filter by space IDs. Multiple IDs can be specified as comma-separated values. schema: type: array items: type: integer format: int64 example: [] - name: keys in: query description: Filter by space keys. Multiple keys can be specified as comma-separated values. schema: type: array items: type: string example: [] - name: type in: query description: Filter by space type. schema: type: string enum: - global - personal example: global - name: status in: query description: Filter by space status. schema: type: string enum: - current - archived example: current - name: labels in: query description: Filter by space labels. Multiple labels can be specified. schema: type: array items: type: string example: [] - $ref: '#/components/parameters/SortParam' - $ref: '#/components/parameters/DescriptionFormatParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the requested spaces are returned. content: application/json: schema: $ref: '#/components/schemas/SpaceBulk' examples: Getspaces200Example: summary: Default getSpaces 200 response x-microcks-default: true value: results: - id: abc123 key: example_value name: Example Title type: global status: current authorId: '500123' createdAt: '2026-01-15T10:30:00Z' homepageId: '500123' _links: next: example_value base: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /spaces/{id}: get: operationId: getSpaceById summary: Get Space by Id description: Returns a specific space by its id. tags: - Space parameters: - name: id in: path required: true description: The ID of the space. schema: type: integer format: int64 example: abc123 - $ref: '#/components/parameters/DescriptionFormatParam' responses: '200': description: Returned if the requested space is returned. content: application/json: schema: $ref: '#/components/schemas/Space' examples: Getspacebyid200Example: summary: Default getSpaceById 200 response x-microcks-default: true value: id: abc123 key: example_value name: Example Title type: global status: current authorId: '500123' createdAt: '2026-01-15T10:30:00Z' homepageId: '500123' description: {} icon: path: example_value apiDownloadLink: example_value labels: results: - {} properties: results: - {} operations: results: - {} permissions: results: - {} _links: webui: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /spaces/{id}/pages: get: operationId: getPagesInSpace summary: Get Pages in Space description: Returns all pages in a specific space. Supports filtering by status and depth. tags: - Page - Space parameters: - name: id in: path required: true description: The ID of the space. schema: type: integer format: int64 example: abc123 - name: depth in: query description: Filter by depth in the page tree. Use root to get only top-level pages. schema: type: string enum: - all - root example: all - $ref: '#/components/parameters/StatusFilter' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/SortParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the pages in the space are returned. content: application/json: schema: $ref: '#/components/schemas/PageBulk' examples: Getpagesinspace200Example: summary: Default getPagesInSpace 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title spaceId: '500123' parentId: '500123' parentType: page position: 10 authorId: '500123' ownerId: '500123' lastOwnerId: '500123' createdAt: '2026-01-15T10:30:00Z' _links: next: example_value base: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}/footer-comments: get: operationId: getFooterComments summary: Get Footer Comments for Page description: Returns the footer comments of a specific page. tags: - Comment parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the footer comments are returned. content: application/json: schema: $ref: '#/components/schemas/CommentBulk' examples: Getfootercomments200Example: summary: Default getFooterComments 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' resolutionStatus: open _links: next: example_value base: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}/inline-comments: get: operationId: getInlineComments summary: Get Inline Comments for Page description: Returns the inline comments of a specific page. tags: - Comment parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the inline comments are returned. content: application/json: schema: $ref: '#/components/schemas/CommentBulk' examples: Getinlinecomments200Example: summary: Default getInlineComments 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' resolutionStatus: open _links: next: example_value base: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /footer-comments: post: operationId: createFooterComment summary: Create Footer Comment description: Creates a footer comment on a page or blog post. tags: - Comment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CommentCreateRequest' examples: CreatefootercommentRequestExample: summary: Default createFooterComment request x-microcks-default: true value: blogPostId: '500123' pageId: '500123' parentCommentId: '500123' body: representation: storage value: example_value responses: '200': description: Returned if the comment was created successfully. content: application/json: schema: $ref: '#/components/schemas/Comment' examples: Createfootercomment200Example: summary: Default createFooterComment 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} resolutionStatus: open properties: textSelection: example_value textSelectionMatchCount: 10 _links: webui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /inline-comments: post: operationId: createInlineComment summary: Create Inline Comment description: Creates an inline comment on a page or blog post. Inline comments are anchored to a specific text selection. tags: - Comment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InlineCommentCreateRequest' examples: CreateinlinecommentRequestExample: summary: Default createInlineComment request x-microcks-default: true value: blogPostId: '500123' pageId: '500123' body: representation: storage value: example_value inlineCommentProperties: textSelection: example_value textSelectionMatchCount: 10 responses: '200': description: Returned if the inline comment was created successfully. content: application/json: schema: $ref: '#/components/schemas/Comment' examples: Createinlinecomment200Example: summary: Default createInlineComment 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} resolutionStatus: open properties: textSelection: example_value textSelectionMatchCount: 10 _links: webui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /comments/{id}: get: operationId: getCommentById summary: Get Comment by Id description: Returns a specific comment by id. tags: - Comment parameters: - name: id in: path required: true description: The ID of the comment. schema: type: integer format: int64 example: abc123 - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/VersionParam' responses: '200': description: Returned if the comment is returned. content: application/json: schema: $ref: '#/components/schemas/Comment' examples: Getcommentbyid200Example: summary: Default getCommentById 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} resolutionStatus: open properties: textSelection: example_value textSelectionMatchCount: 10 _links: webui: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updateComment summary: Update Comment description: Updates a comment by id. The version number must be incremented. tags: - Comment parameters: - name: id in: path required: true description: The ID of the comment. schema: type: integer format: int64 example: abc123 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CommentUpdateRequest' examples: UpdatecommentRequestExample: summary: Default updateComment request x-microcks-default: true value: body: representation: storage value: example_value version: number: 10 message: example_value responses: '200': description: Returned if the comment was updated successfully. content: application/json: schema: $ref: '#/components/schemas/Comment' examples: Updatecomment200Example: summary: Default updateComment 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} resolutionStatus: open properties: textSelection: example_value textSelectionMatchCount: 10 _links: webui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteComment summary: Delete Comment description: Deletes a comment by id. tags: - Comment parameters: - name: id in: path required: true description: The ID of the comment. schema: type: integer format: int64 example: abc123 responses: '204': description: Returned if the comment was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /comments/{id}/children: get: operationId: getChildComments summary: Get Child Comments description: Returns the child (reply) comments of a specific comment. tags: - Comment parameters: - name: id in: path required: true description: The ID of the parent comment. schema: type: integer format: int64 example: abc123 - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the child comments are returned. content: application/json: schema: $ref: '#/components/schemas/CommentBulk' examples: Getchildcomments200Example: summary: Default getChildComments 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title blogPostId: '500123' pageId: '500123' parentCommentId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' resolutionStatus: open _links: next: example_value base: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /blogposts: get: operationId: getBlogPosts summary: Get Blog Posts description: Returns all blog posts. Results can be filtered by space, status, and title. tags: - Blog Post parameters: - $ref: '#/components/parameters/SpaceIdFilter' - $ref: '#/components/parameters/StatusFilter' - $ref: '#/components/parameters/TitleFilter' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/SortParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the blog posts are returned. content: application/json: schema: $ref: '#/components/schemas/BlogPostBulk' examples: Getblogposts200Example: summary: Default getBlogPosts 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title spaceId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' _links: next: example_value base: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createBlogPost summary: Create Blog Post description: Creates a blog post in the specified space. tags: - Blog Post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BlogPostCreateRequest' examples: CreateblogpostRequestExample: summary: Default createBlogPost request x-microcks-default: true value: spaceId: '500123' status: current title: Example Title body: representation: storage value: example_value responses: '200': description: Returned if the blog post was created successfully. content: application/json: schema: $ref: '#/components/schemas/BlogPost' examples: Createblogpost200Example: summary: Default createBlogPost 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} _links: webui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /blogposts/{id}: get: operationId: getBlogPostById summary: Get Blog Post by Id description: Returns a specific blog post by id. tags: - Blog Post parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/BodyFormatParam' - $ref: '#/components/parameters/VersionParam' responses: '200': description: Returned if the blog post is returned. content: application/json: schema: $ref: '#/components/schemas/BlogPost' examples: Getblogpostbyid200Example: summary: Default getBlogPostById 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} _links: webui: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updateBlogPost summary: Update Blog Post description: Updates a blog post by id. tags: - Blog Post parameters: - $ref: '#/components/parameters/ContentIdPath' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BlogPostUpdateRequest' examples: UpdateblogpostRequestExample: summary: Default updateBlogPost request x-microcks-default: true value: id: abc123 status: current title: Example Title body: representation: storage value: example_value version: number: 10 message: example_value responses: '200': description: Returned if the blog post was updated successfully. content: application/json: schema: $ref: '#/components/schemas/BlogPost' examples: Updateblogpost200Example: summary: Default updateBlogPost 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title spaceId: '500123' authorId: '500123' createdAt: '2026-01-15T10:30:00Z' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' body: {} labels: results: - {} _links: webui: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteBlogPost summary: Delete Blog Post description: Deletes a blog post by id. tags: - Blog Post parameters: - $ref: '#/components/parameters/ContentIdPath' responses: '204': description: Returned if the blog post was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /attachments/{id}: get: operationId: getAttachmentById summary: Get Attachment by Id description: Returns a specific attachment by id. tags: - Attachment parameters: - $ref: '#/components/parameters/ContentIdPath' responses: '200': description: Returned if the attachment is returned. content: application/json: schema: $ref: '#/components/schemas/Attachment' examples: Getattachmentbyid200Example: summary: Default getAttachmentById 200 response x-microcks-default: true value: id: abc123 status: current title: Example Title mediaType: example_value mediaTypeDescription: example_value comment: example_value fileSize: 10 webuiLink: example_value downloadLink: example_value pageId: '500123' blogPostId: '500123' version: createdAt: '2026-01-15T10:30:00Z' message: example_value number: 10 minorEdit: true authorId: '500123' _links: webui: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteAttachment summary: Delete Attachment description: Deletes an attachment by id. tags: - Attachment parameters: - $ref: '#/components/parameters/ContentIdPath' responses: '204': description: Returned if the attachment was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /pages/{id}/attachments: get: operationId: getPageAttachments summary: Get Attachments for Page description: Returns the attachments of a specific page. tags: - Attachment parameters: - $ref: '#/components/parameters/ContentIdPath' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Returned if the attachments are returned. content: application/json: schema: $ref: '#/components/schemas/AttachmentBulk' examples: Getpageattachments200Example: summary: Default getPageAttachments 200 response x-microcks-default: true value: results: - id: abc123 status: current title: Example Title mediaType: example_value mediaTypeDescription: example_value comment: example_value fileSize: 10 webuiLink: example_value downloadLink: example_value pageId: '500123' blogPostId: '500123' _links: next: example_value base: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /labels/{id}: get: operationId: getLabelById summary: Get Label by Id description: Returns a specific label by id. tags: - Label parameters: - name: id in: path required: true description: The ID of the label. schema: type: integer format: int64 example: abc123 responses: '200': description: Returned if the label is returned. content: application/json: schema: $ref: '#/components/schemas/Label' examples: Getlabelbyid200Example: summary: Default getLabelById 200 response x-microcks-default: true value: id: abc123 name: Example Title prefix: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: basicAuth: type: http scheme: basic description: >- Basic authentication using email and API token. Provide your Atlassian account email as the username and an API token as the password. oAuth2: type: oauth2 description: OAuth 2.0 (3LO) for Confluence Cloud apps. flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize tokenUrl: https://auth.atlassian.com/oauth/token scopes: read:confluence-content.all: Read Confluence content read:confluence-content.summary: Read Confluence content summaries write:confluence-content: Create and update Confluence content read:confluence-space.summary: Read Confluence space summaries write:confluence-space: Create and update Confluence spaces read:confluence-user: Read Confluence user information read:confluence-groups: Read Confluence groups write:confluence-file: Upload attachments to Confluence delete:confluence-content: Delete Confluence content bearerAuth: type: http scheme: bearer description: Personal Access Token or OAuth 2.0 Bearer token. parameters: ContentIdPath: name: id in: path required: true description: The ID of the content. schema: type: integer format: int64 PageIdParam: name: id in: query description: Filter by page IDs. Multiple IDs can be specified as comma-separated values. schema: type: array items: type: integer format: int64 SpaceIdFilter: name: space-id in: query description: Filter by space ID. Multiple IDs can be specified. schema: type: array items: type: integer format: int64 StatusFilter: name: status in: query description: Filter by content status. schema: type: string enum: - current - archived - draft - trashed TitleFilter: name: title in: query description: Filter by content title. Supports exact match. schema: type: string BodyFormatParam: name: body-format in: query description: The representation format for the content body. schema: type: string enum: - storage - atlas_doc_format - view - export_view - anonymous_export_view - editor DescriptionFormatParam: name: description-format in: query description: The format of the space description in the response. schema: type: string enum: - plain - view SortParam: name: sort in: query description: >- Sort order for results. Prefix with - for descending order. Supported fields include id, title, created-date, and modified-date. schema: type: string enum: - id - -id - title - -title - created-date - -created-date - modified-date - -modified-date CursorParam: name: cursor in: query description: >- Used for pagination. The cursor value is returned in the response _links.next when there are more results. schema: type: string LimitParam: name: limit in: query description: Maximum number of results to return. schema: type: integer format: int32 minimum: 1 maximum: 250 default: 25 GetDraftParam: name: get-draft in: query description: If true, returns the draft version of the page. schema: type: boolean default: false VersionParam: name: version in: query description: The version number of the content to retrieve. schema: type: integer format: int32 LabelPrefixParam: name: prefix in: query description: Filter labels by prefix (global, my, team). schema: type: string enum: - global - my - team schemas: Page: type: object description: Represents a Confluence page. properties: id: type: string description: The unique identifier of the page. example: abc123 status: type: string description: The current status of the page. enum: - current - draft - archived - trashed example: current title: type: string description: The title of the page. example: Example Title spaceId: type: string description: The ID of the space this page belongs to. example: '500123' parentId: type: string description: The ID of the parent page, if the page is nested. example: '500123' parentType: type: string description: The type of the parent (page or space). enum: - page - space example: page position: type: integer description: The position of this page in the page tree relative to siblings. example: 10 authorId: type: string description: The Atlassian account ID of the page author. example: '500123' ownerId: type: string description: The Atlassian account ID of the page owner. example: '500123' lastOwnerId: type: string description: The Atlassian account ID of the previous owner. example: '500123' createdAt: type: string format: date-time description: The ISO 8601 timestamp when the page was created. example: '2026-01-15T10:30:00Z' version: $ref: '#/components/schemas/Version' body: $ref: '#/components/schemas/Body' labels: $ref: '#/components/schemas/LabelArray' properties: $ref: '#/components/schemas/ContentPropertyArray' operations: $ref: '#/components/schemas/OperationArray' likes: $ref: '#/components/schemas/LikeArray' versions: $ref: '#/components/schemas/VersionArray' _links: $ref: '#/components/schemas/PageLinks' PageBulk: type: object description: A paginated list of pages. properties: results: type: array items: $ref: '#/components/schemas/Page' example: [] _links: $ref: '#/components/schemas/PaginationLinks' PageCreateRequest: type: object required: - spaceId - status - title - body properties: spaceId: type: string description: The ID of the space to create the page in. example: '500123' status: type: string description: The status of the page. enum: - current - draft example: current title: type: string description: The title of the page. example: Example Title parentId: type: string description: The ID of the parent page. If omitted, the page will be a root-level page. example: '500123' body: $ref: '#/components/schemas/BodyWrite' PageUpdateRequest: type: object required: - id - status - title - body - version properties: id: type: string description: The ID of the page being updated. example: abc123 status: type: string description: The status of the page. enum: - current - draft - archived example: current title: type: string description: The new title of the page. example: Example Title spaceId: type: string description: The ID of the space the page belongs to. example: '500123' parentId: type: string description: The ID of the new parent page. example: '500123' body: $ref: '#/components/schemas/BodyWrite' version: $ref: '#/components/schemas/VersionWrite' Space: type: object description: Represents a Confluence space. properties: id: type: string description: The unique identifier of the space. example: abc123 key: type: string description: The key of the space, used in URLs. example: example_value name: type: string description: The name of the space. example: Example Title type: type: string description: The type of space. enum: - global - personal example: global status: type: string description: The status of the space. enum: - current - archived example: current authorId: type: string description: The Atlassian account ID of the space creator. example: '500123' createdAt: type: string format: date-time description: The ISO 8601 timestamp when the space was created. example: '2026-01-15T10:30:00Z' homepageId: type: string description: The ID of the space homepage. example: '500123' description: $ref: '#/components/schemas/SpaceDescription' icon: $ref: '#/components/schemas/SpaceIcon' labels: $ref: '#/components/schemas/LabelArray' properties: $ref: '#/components/schemas/SpacePropertyArray' operations: $ref: '#/components/schemas/OperationArray' permissions: $ref: '#/components/schemas/SpacePermissionArray' _links: $ref: '#/components/schemas/SpaceLinks' SpaceBulk: type: object description: A paginated list of spaces. properties: results: type: array items: $ref: '#/components/schemas/Space' example: [] _links: $ref: '#/components/schemas/PaginationLinks' Comment: type: object description: Represents a comment on a Confluence page or blog post. properties: id: type: string description: The unique identifier of the comment. example: abc123 status: type: string description: The current status of the comment. enum: - current - draft - trashed example: current title: type: string description: The title of the comment (typically auto-generated). example: Example Title blogPostId: type: string description: The ID of the blog post the comment is on, if applicable. example: '500123' pageId: type: string description: The ID of the page the comment is on, if applicable. example: '500123' parentCommentId: type: string description: The ID of the parent comment, if this is a reply. example: '500123' authorId: type: string description: The Atlassian account ID of the comment author. example: '500123' createdAt: type: string format: date-time description: The ISO 8601 timestamp when the comment was created. example: '2026-01-15T10:30:00Z' version: $ref: '#/components/schemas/Version' body: $ref: '#/components/schemas/Body' resolutionStatus: type: string description: Resolution status for inline comments. enum: - open - resolved - reopened example: open properties: $ref: '#/components/schemas/InlineCommentProperties' _links: $ref: '#/components/schemas/CommentLinks' CommentBulk: type: object description: A paginated list of comments. properties: results: type: array items: $ref: '#/components/schemas/Comment' example: [] _links: $ref: '#/components/schemas/PaginationLinks' CommentCreateRequest: type: object required: - body properties: blogPostId: type: string description: The ID of the blog post to comment on. example: '500123' pageId: type: string description: The ID of the page to comment on. example: '500123' parentCommentId: type: string description: The ID of the parent comment for replies. example: '500123' body: $ref: '#/components/schemas/BodyWrite' InlineCommentCreateRequest: type: object required: - body - inlineCommentProperties properties: blogPostId: type: string description: The ID of the blog post to add an inline comment on. example: '500123' pageId: type: string description: The ID of the page to add an inline comment on. example: '500123' body: $ref: '#/components/schemas/BodyWrite' inlineCommentProperties: $ref: '#/components/schemas/InlineCommentProperties' CommentUpdateRequest: type: object required: - body - version properties: body: $ref: '#/components/schemas/BodyWrite' version: $ref: '#/components/schemas/VersionWrite' BlogPost: type: object description: Represents a Confluence blog post. properties: id: type: string description: The unique identifier of the blog post. example: abc123 status: type: string description: The current status of the blog post. enum: - current - draft - trashed example: current title: type: string description: The title of the blog post. example: Example Title spaceId: type: string description: The ID of the space this blog post belongs to. example: '500123' authorId: type: string description: The Atlassian account ID of the blog post author. example: '500123' createdAt: type: string format: date-time description: The ISO 8601 timestamp when the blog post was created. example: '2026-01-15T10:30:00Z' version: $ref: '#/components/schemas/Version' body: $ref: '#/components/schemas/Body' labels: $ref: '#/components/schemas/LabelArray' _links: $ref: '#/components/schemas/ContentLinks' BlogPostBulk: type: object description: A paginated list of blog posts. properties: results: type: array items: $ref: '#/components/schemas/BlogPost' example: [] _links: $ref: '#/components/schemas/PaginationLinks' BlogPostCreateRequest: type: object required: - spaceId - status - title - body properties: spaceId: type: string description: The ID of the space to create the blog post in. example: '500123' status: type: string description: The status of the blog post. enum: - current - draft example: current title: type: string description: The title of the blog post. example: Example Title body: $ref: '#/components/schemas/BodyWrite' BlogPostUpdateRequest: type: object required: - id - status - title - body - version properties: id: type: string description: The ID of the blog post being updated. example: abc123 status: type: string description: The status of the blog post. enum: - current - draft example: current title: type: string description: The new title of the blog post. example: Example Title body: $ref: '#/components/schemas/BodyWrite' version: $ref: '#/components/schemas/VersionWrite' Attachment: type: object description: Represents a file attachment on Confluence content. properties: id: type: string description: The unique identifier of the attachment. example: abc123 status: type: string description: The status of the attachment. enum: - current - trashed example: current title: type: string description: The filename of the attachment. example: Example Title mediaType: type: string description: The MIME type of the attachment. example: example_value mediaTypeDescription: type: string description: Human-readable description of the media type. example: example_value comment: type: string description: Comment associated with the attachment upload. example: example_value fileSize: type: integer format: int64 description: File size in bytes. example: 10 webuiLink: type: string description: The web UI link for viewing the attachment. example: example_value downloadLink: type: string description: The download link for the attachment. example: example_value pageId: type: string description: The ID of the page this attachment belongs to. example: '500123' blogPostId: type: string description: The ID of the blog post this attachment belongs to. example: '500123' version: $ref: '#/components/schemas/Version' _links: $ref: '#/components/schemas/ContentLinks' AttachmentBulk: type: object description: A paginated list of attachments. properties: results: type: array items: $ref: '#/components/schemas/Attachment' example: [] _links: $ref: '#/components/schemas/PaginationLinks' Label: type: object description: Represents a label applied to Confluence content. properties: id: type: string description: The unique identifier of the label. example: abc123 name: type: string description: The name of the label. example: Example Title prefix: type: string description: The prefix of the label (global, my, team). example: example_value LabelArray: type: object description: A list of labels. properties: results: type: array items: $ref: '#/components/schemas/Label' example: [] _links: $ref: '#/components/schemas/PaginationLinks' Version: type: object description: Version information for content. properties: createdAt: type: string format: date-time description: The ISO 8601 timestamp of this version. example: '2026-01-15T10:30:00Z' message: type: string description: The message associated with this version. example: example_value number: type: integer description: The version number. example: 10 minorEdit: type: boolean description: Whether this was a minor edit. example: true authorId: type: string description: The Atlassian account ID of the version author. example: '500123' VersionWrite: type: object required: - number properties: number: type: integer description: The new version number. Must be incremented by 1. example: 10 message: type: string description: An optional message associated with this version. example: example_value VersionArray: type: object properties: results: type: array items: $ref: '#/components/schemas/Version' example: [] _links: $ref: '#/components/schemas/PaginationLinks' Body: type: object description: The body content in various representations. properties: storage: $ref: '#/components/schemas/BodyRepresentation' atlas_doc_format: $ref: '#/components/schemas/BodyRepresentation' view: $ref: '#/components/schemas/BodyRepresentation' BodyWrite: type: object required: - representation - value properties: representation: type: string description: The representation format of the body content. enum: - storage - atlas_doc_format - wiki - editor example: storage value: type: string description: The body content in the specified representation. example: example_value BodyRepresentation: type: object properties: representation: type: string description: The name of the representation format. example: example_value value: type: string description: The body content in this representation. example: example_value InlineCommentProperties: type: object description: Properties specific to inline comments. properties: textSelection: type: string description: The selected text that this inline comment is anchored to. example: example_value textSelectionMatchCount: type: integer description: The match index of the text selection, if the same text appears multiple times. example: 10 ContentPropertyArray: type: object properties: results: type: array items: $ref: '#/components/schemas/ContentProperty' example: [] ContentProperty: type: object properties: id: type: string example: abc123 key: type: string example: example_value value: example: example_value version: $ref: '#/components/schemas/Version' OperationArray: type: object properties: results: type: array items: $ref: '#/components/schemas/Operation' example: [] Operation: type: object properties: operation: type: string description: The operation type. enum: - create - read - update - delete - administer example: create targetType: type: string description: The target type for the operation. example: example_value LikeArray: type: object properties: results: type: array items: $ref: '#/components/schemas/Like' example: [] Like: type: object properties: accountId: type: string description: The Atlassian account ID of the user who liked the content. example: '500123' SpaceDescription: type: object properties: plain: $ref: '#/components/schemas/BodyRepresentation' view: $ref: '#/components/schemas/BodyRepresentation' SpaceIcon: type: object properties: path: type: string description: The relative path to the space icon. example: example_value apiDownloadLink: type: string description: The API download link for the space icon. example: example_value SpacePropertyArray: type: object properties: results: type: array items: $ref: '#/components/schemas/ContentProperty' example: [] SpacePermissionArray: type: object properties: results: type: array items: $ref: '#/components/schemas/SpacePermission' example: [] SpacePermission: type: object properties: id: type: string example: abc123 principal: type: object properties: type: type: string enum: - user - group - role id: type: string example: example_value operation: $ref: '#/components/schemas/Operation' PageLinks: type: object properties: webui: type: string description: Web UI link for the page. example: example_value editui: type: string description: Edit UI link for the page. example: example_value tinyui: type: string description: Shortened link for the page. example: example_value SpaceLinks: type: object properties: webui: type: string description: Web UI link for the space. example: example_value CommentLinks: type: object properties: webui: type: string description: Web UI link for the comment. example: example_value ContentLinks: type: object properties: webui: type: string description: Web UI link for the content. example: example_value PaginationLinks: type: object description: Pagination links for cursor-based pagination. properties: next: type: string description: URL for the next page of results. Contains the cursor parameter. example: example_value base: type: string description: The base URL of the Confluence instance. example: example_value Error: type: object description: Error response from the Confluence API. properties: statusCode: type: integer description: The HTTP status code. example: 10 data: type: object properties: authorized: type: boolean valid: type: boolean errors: type: array items: type: object properties: message: type: object properties: key: type: string args: type: array items: type: string translation: type: string successful: type: boolean description: Details about the error. example: example_value message: type: string description: A human-readable error message. example: example_value responses: BadRequest: description: Returned if the request is malformed or contains invalid parameters. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Returned if the authentication credentials are missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Returned if the requested resource is not found. content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: Returned if there is a version conflict during an update. content: application/json: schema: $ref: '#/components/schemas/Error' externalDocs: description: Confluence Cloud REST API v2 Documentation url: https://developer.atlassian.com/cloud/confluence/rest/v2/intro/