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 Comment API

Create, retrieve, update, and delete comments on pages and blog posts

Confluence Comment API is one of 66 APIs that Confluence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Comment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, code examples, a getting-started guide, and a changelog.

This API exposes 8 operations across 6 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

8 operations 6 paths 14 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://your-domain.atlassian.net/wiki/rest/api
Authentication
HTTP Basic, OAuth 2.0, HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Confluence Comment API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuth2) using the authorizationCode flow, exposing 9 scopes. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic authentication using email and API token. Provide your Atlassian account email as the username and an API token as the password.
  • oAuth2 — OAuth 2.0 (3LO) for Confluence Cloud apps.
  • bearerAuth — Personal Access Token or OAuth 2.0 Bearer token.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Comment 8

Create, retrieve, update, and delete comments on pages and blog posts

GET
/pages/{id}/footer-comments
Get Footer Comments for Page
getFooterComments 4 params → 200401404
GET
/pages/{id}/inline-comments
Get Inline Comments for Page
getInlineComments 4 params → 200401404
POST
/footer-comments
Create Footer Comment
createFooterComment body → 200400401404
POST
/inline-comments
Create Inline Comment
createInlineComment body → 200400401404
GET
/comments/{id}
Get Comment by Id
getCommentById 3 params → 200401404
PUT
/comments/{id}
Update Comment
updateComment 1 param body → 200400401404
DELETE
/comments/{id}
Delete Comment
deleteComment 1 param → 204401404
GET
/comments/{id}/children
Get Child Comments
getChildComments 4 params → 200401404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Comment (13 properties), Version (5 properties), InlineCommentCreateRequest (4 properties), CommentCreateRequest (4 properties). Each schema is shown below with its type and property counts.

Version
object
Version information for content.
5 properties
Body
object
The body content in various representations.
3 properties
CommentUpdateRequest
object
2 properties 2 required
Comment
object
Represents a comment on a Confluence page or blog post.
13 properties
InlineCommentProperties
object
Properties specific to inline comments.
2 properties
BodyRepresentation
object
2 properties
InlineCommentCreateRequest
object
4 properties 2 required
CommentLinks
object
1 property
CommentCreateRequest
object
4 properties 1 required
BodyWrite
object
2 properties 2 required
CommentBulk
object
A paginated list of comments.
2 properties
Error
object
Error response from the Confluence API.
3 properties
PaginationLinks
object
Pagination links for cursor-based pagination.
2 properties
VersionWrite
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluence-comment-api-openapi.yml Raw ↑

Other APIs Confluence publishes across the network.

Confluence Content Properties API
Confluence Search API
Confluence Content API
Confluence Space API
Confluence Content Labels API
Confluence Analytics API
Confluence Audit API
Confluence Template API
Confluence Group API
Confluence Users API
Confluence Content States API
Confluence Content Restrictions API
Where this information came from

This is an independent, third-party profile of Confluence Comment API, 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.