Atlassian Content API

openapi: 3.1.0
info:
  title: Atlassian Admin Account Content API
  description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products.
  version: 1.0.0
  contact:
    name: Atlassian Developer
    url: https://developer.atlassian.com/cloud/admin/
  license:
    name: Atlassian Developer Terms
    url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  x-logo:
    url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png
servers:
- url: https://api.atlassian.com
  description: Atlassian Cloud API
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Content
paths:
  /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri:
    get:
      tags:
      - Content
      summary: Atlassian Get Cache Content Uri
      description: This API operation retrieves a temporary content URI for accessing a specific pipeline cache in a Bitbucket repository. By providing the workspace ID, repository slug, and cache UUID as path parameters, you can obtain a pre-signed URL that allows direct access to download the cached content. This is useful for retrieving build artifacts, dependencies, or other cached data that was stored during previous pipeline executions, enabling faster build times by reusing previously downloaded or generated files. The returned URI is typically time-limited and provides secure, temporary access to the cache content without requiring additional authentication once generated.
      operationId: getCacheContentUri
      parameters:
      - name: workspace
        description: The account.
        required: true
        in: path
        schema:
          type: string
      - name: repo_slug
        description: The repository.
        required: true
        in: path
        schema:
          type: string
      - name: cache_uuid
        description: The UUID of the cache.
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: The cache content uri.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipeline_cache_content_uri'
              examples:
                pipeline-cache-content-uri:
                  $ref: '#/components/examples/pipeline-cache-content-uri'
        '404':
          description: The workspace, repository or cache_uuid with given UUID was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:pipeline:bitbucket
      security:
      - oauth2:
        - pipeline
      - basic: []
      - api_key: []
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/search:
    get:
      tags:
      - Content
      summary: Atlassian Search Content by Cql
      description: This API operation allows you to search for Confluence content using the Confluence Query Language (CQL), providing a powerful and flexible way to retrieve pages, blog posts, attachments, and other content types based on specific criteria. By sending a GET request to the /wiki/rest/api/content/search endpoint with a CQL query string parameter, you can filter content by various attributes such as type, space, creator, creation date, labels, title text, or any combination of these conditions. The operation returns a paginated list of content objects matching your search criteria, including metadata like content IDs, titles, types, and links, making it useful for building custom dashboards, reports, or integrations that need to locate and retrieve specific Confluence content programmatically.
      operationId: searchContentByCql
      parameters:
      - name: cql
        in: query
        description: The CQL string that is used to find the requested content.
        required: true
        schema:
          type: string
      - name: cqlcontext
        in: query
        description: 'The space, content, and content status to execute the search against.

          Specify this as an object with the following properties:


          - `spaceKey` Key of the space to search against. Optional.

          - `contentId` ID of the content to search against. Optional. Must

          be in the space spacified by `spaceKey`.

          - `contentStatuses` Content statuses to search against. Optional.'
        schema:
          type: string
      - $ref: '#/components/parameters/contentExpand'
      - name: cursor
        in: query
        description: Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.
        schema:
          type: string
      - name: limit
        in: query
        description: 'The maximum number of content objects to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Returned if the requested list of content is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentArray'
        '400':
          description: Returned if the CQL is invalid or missing.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - search:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - search:confluence
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}:
    get:
      tags:
      - Content
      summary: Atlassian Get Content by Id
      deprecated: true
      description: The Get Content By Id operation retrieves a single piece of content from Atlassian Confluence using its unique identifier. This REST API endpoint accepts the content ID as a path parameter and returns detailed information about the specified content, including its type (page, blog post, comment, etc.), title, body, version information, space details, metadata, and associated properties. The response can be customized using query parameters to expand specific fields, limit the body representation format, or filter the returned data. This operation requires appropriate read permissions for the content being accessed and is commonly used to fetch complete content details for display, editing, or integration purposes in both native Confluence applications and third-party tools that need to programmatically access wiki content.
      operationId: getContentById
      parameters:
      - name: id
        in: path
        description: 'The ID of the content to be returned. If you don''t know the content ID,

          use [Get content](#api-content-get) and filter the results.'
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: 'Filter the results to a set of content based on their status.

          If set to `any`, content with any status is returned. Note, the

          `historical` status is currently not supported.'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          default:
          - current
          enum:
          - current
          - trashed
          - deleted
          - historical
          - draft
          - any
      - name: version
        in: query
        description: The version number of the content to be returned.
        schema:
          type: integer
          format: int32
      - name: embeddedContentRender
        in: query
        description: 'The version of embedded content (e.g. attachments) to render.


          - <code>current</code> renders the latest version of the embedded content.

          - <code>version-at-save</code> renders the version of the embedded content

          at the time of save.'
        schema:
          type: string
          default: current
          enum:
          - current
          - version-at-save
      - $ref: '#/components/parameters/contentExpandWithSubExpandLimit'
      - name: trigger
        in: query
        description: 'If set to `viewed`, the request will trigger a ''viewed'' event for the content.

          When this event is triggered, the page/blogpost will appear on the ''Recently visited''

          tab of the user''s Confluence dashboard.'
        schema:
          type: string
          enum:
          - viewed
      responses:
        '200':
          description: Returned if the requested content is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '400':
          description: 'Returned if;

            - The content id is invalid.

            - The sub-expansions limit exceeds.'
          content: {}
        '401':
          description: Returned if the authentication credentials are incorrect or missing from the request.
          content: {}
        '403':
          description: Returned if the calling user can not view the content.
          content: {}
        '404':
          description: 'Returned if;


            - There is no content with the given ID.

            - The requesting user does not have permission to view the content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-content.summary
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-content.summary
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Content
      summary: Atlassian Update Content
      deprecated: true
      description: This API operation updates an existing piece of content in Atlassian Confluence by sending a PUT request to the specified content ID endpoint. It allows you to modify various aspects of content such as the title, body, version number, and metadata of pages, blog posts, or other content types within your Confluence instance. The operation requires you to provide the complete updated content object in the request body, including mandatory fields like version information to ensure proper conflict handling and version tracking. You must have appropriate permissions to edit the content, and the version number must be incremented from the current version to successfully complete the update. This operation is commonly used for programmatically editing wiki pages, updating documentation, or integrating Confluence content management into automated workflows.
      operationId: updateContent
      parameters:
      - name: id
        in: path
        description: The ID of the content to be updated.
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: 'The updated status of the content. Use this parameter to change the

          status of a piece of content without passing the entire request body.'
        schema:
          type: string
          default: current
          enum:
          - current
          - trashed
          - deleted
          - historical
          - draft
      - name: conflictPolicy
        in: query
        description: 'The action that should be taken when conflicts are discovered.

          Only used when publishing a draft page.'
        schema:
          type: string
          default: abort
          enum:
          - abort
      requestBody:
        description: The updated content.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentUpdate'
        required: true
      responses:
        '200':
          description: Returned if the content is updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '400':
          description: 'Returned if;


            - The request body is missing required parameters (version, type, title).

            - The type property has been set incorrectly.'
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '403':
          description: Returned if the calling user can not update the content with specified id.
          content: {}
        '404':
          description: 'Returned if a draft with current content cannot be found when setting the status

            parameter to draft and the content status is current.'
          content: {}
        '409':
          description: 'Returned if;


            - The page is a draft (draft pages cannot be updated).

            - The version property has not been set correctly for the content

            type.'
          content: {}
        '501':
          description: 'Indicates that the server does not support the functionality needed to serve the request.

            For example,


            - trying to publish edit draft and passing content status as historical.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-content
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-content
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
        - write:content:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-codegen-request-body-name: content
      x-atlassian-connect-scope: WRITE
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Content
      summary: Atlassian Delete Content
      deprecated: true
      description: Deletes a piece of content from Confluence by specifying its unique identifier in the URL path. When executed, this operation permanently removes the content item, which can include pages, blog posts, comments, or attachments, from the Confluence space. The deletion is typically irreversible through the API, though Confluence may retain the content in trash for a limited time depending on instance configuration. This endpoint requires appropriate permissions, as users must have delete rights for the specific content being removed. The operation accepts the content ID as a path parameter and may support additional query parameters to control deletion behavior, such as whether to purge the content immediately or move it to trash.
      operationId: deleteContent
      parameters:
      - name: id
        in: path
        description: The ID of the content to be deleted.
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: Set this to `trashed`, if the content's status is `trashed` and you want to purge it.
        schema:
          type: string
      responses:
        '204':
          description: Returned if the content is successfully trashed or purged.
          content: {}
        '400':
          description: Returned if the content id is invalid.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '403':
          description: Returned if the calling user can not delete the content with specified id.
          content: {}
        '404':
          description: 'Returned if;


            - There is no content with the given ID.

            - The requesting user does not have permission to trash or purge the

            content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - write:confluence-content
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - write:confluence-content
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - delete:content:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: DELETE
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}/child:
    get:
      tags:
      - Content
      summary: Atlassian Get Content Children
      deprecated: true
      description: This API operation retrieves the direct children of a specified Confluence content item by its ID. When called with a GET request to the endpoint, it returns a paginated list of child pages, comments, or attachments depending on the parent content type. The operation supports query parameters to filter results by child content type, expand additional properties, set pagination limits, and sort the returned children. This is commonly used to navigate the content hierarchy in Confluence, such as retrieving all sub-pages under a parent page or fetching comments associated with a blog post.
      operationId: getContentChildren
      parameters:
      - name: id
        in: path
        description: The ID of the content to be queried for its children.
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: 'A multi-value parameter indicating which properties of the children to expand, where:


          - `attachment` returns all attachments for the content.

          - `comments` returns all comments for the content.

          - `page` returns all child pages of the content.

          - Custom content types that are provided by apps are also supported.'
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: parentVersion
        in: query
        description: 'The version of the parent content to retrieve children for.

          Currently, this only works for the latest version.'
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: Returned if the requested content children are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentChildren'
        '404':
          description: 'Returned if;


            - There is no content with the given ID.

            - The calling user does not have permission to view the content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-content.summary
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-content.summary
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}/child/comment:
    get:
      tags:
      - Content
      summary: Atlassian Get Content Comments
      deprecated: true
      description: This API operation retrieves all comments that are children of a specific piece of content in Atlassian Confluence. By making a GET request to the endpoint with a content ID, you can fetch a paginated list of comments associated with that content, which may include inline comments, page comments, or footer comments. The response typically includes comment metadata such as the comment body, author information, creation date, modification history, and version details. This endpoint is useful for applications that need to display, analyze, or process user feedback and discussions related to Confluence pages, blog posts, or other content types. Optional query parameters can be used to expand specific fields, limit the number of results, or control pagination through the comment collection.
      operationId: getContentComments
      parameters:
      - name: id
        in: path
        description: The ID of the content to be queried for its comments.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/contentExpand'
      - name: parentVersion
        in: query
        description: 'The version of the parent content to retrieve children for.

          Currently, this only works for the latest version.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: start
        in: query
        description: The starting index of the returned comments.
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'The maximum number of comments to return per page. Note,

          this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 25
      - name: location
        in: query
        description: 'The location of the comments in the page. Multiple locations can be specified.

          If no location is specified, comments from all locations are returned.'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          enum:
          - inline
          - footer
          - resolved
      - name: depth
        in: query
        description: 'Currently, this parameter is not used.

          Comments are returned at the root level only.'
        schema:
          type: string
      responses:
        '200':
          description: Returned if the requested comments are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentArray'
        '404':
          description: 'Returned if;


            - There is no parent content with the given ID.

            - The calling user does not have permission to view the parent content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-content.summary
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-content.summary
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}/child/{type}:
    get:
      tags:
      - Content
      summary: Atlassian Get Content Children by Type
      deprecated: true
      description: This API operation retrieves child content of a specific type for a given Confluence page or content item. By specifying the parent content ID and the desired child type (such as page, comment, or attachment) in the URL path, the endpoint returns a paginated list of all child elements matching that type. This is useful for navigating content hierarchies, accessing page comments, retrieving attachments, or discovering child pages within a Confluence space structure. The response includes metadata about each child item along with pagination parameters for handling large result sets.
      operationId: getContentChildrenByType
      parameters:
      - name: id
        in: path
        description: The ID of the content to be queried for its children.
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: The type of children to return.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/contentExpand'
      - name: parentVersion
        in: query
        description: 'The version of the parent content to retrieve children for.

          Currently, this only works for the latest version.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: start
        in: query
        description: The starting index of the returned content.
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'The maximum number of content to return per page. Note,

          this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Returned if the requested content is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentArray'
        '400':
          description: 'Returned if the parent type and desired child content type are not compatible.

            Eg: Cannot find `page` children of a `blogpost`.'
          content: {}
        '404':
          description: 'Returned if:


            - There is no content with the given ID.

            - The calling user does not have permission to view the content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-content.summary
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-content.summary
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}/descendant:
    get:
      tags:
      - Content
      summary: Atlassian Get Content Descendants
      description: This API operation retrieves all descendants of a specified Confluence content item by its ID. Descendants include all child pages, nested subpages, comments, and attachments that exist below the specified content in the content hierarchy tree. The endpoint returns a paginated list of content objects that are hierarchically related to the parent content, allowing developers to traverse and map the complete content structure beneath a given page or blog post. This is particularly useful for operations that need to work with entire content trees, such as exporting documentation sections, analyzing content relationships, or performing bulk operations on related pages.
      operationId: getContentDescendants
      parameters:
      - name: id
        in: path
        description: The ID of the content to be queried for its descendants.
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: 'A multi-value parameter indicating which properties of the children to

          expand, where:


          - `attachment` returns all attachments for the content.

          - `comments` returns all comments for the content.

          - `page` returns all child pages of the content.'
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - attachment
            - comment
            - page
      responses:
        '200':
          description: Returned if the requested descendants are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentChildren'
        '404':
          description: 'Returned if;


            - There is no content with the given ID.

            - The calling user does not have permission to view the content.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:confluence-content.summary
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:confluence-content.summary
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wiki/rest/api/content/{id}/history:
    get:
      tags:
      - Content
      summary: Atlassian Get Content History
      deprecated: true
      description: This operation retrieves the version history and other historical metadata for a specific piece of Confluence content identified by its unique ID. When called, it returns information about who created and last modified the content, timestamps for these actions, version numbers, and potentially contributor details. This is useful for tracking changes, auditing content modifications, understanding content evolution over time, and displaying version information to users. The endpoint follows RESTful conventions and requires appropriate authentication and permissions to access the content's historical data.
      operationId: getContentHistory
      parameters:
      - name: id
        in: path
        description: The ID of the content to be queried for its history.
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: 'A multi-value parameter indicating which properties of the content history to expand.

          Maximum sub-expansions allowed is `8`.


          - `lastUpdated` returns information about the most recent update of the content,

          including who updated it and when it was updated.

          - `previousVersion` returns information about the update prior to the current content

          update. For this method, it contains the same information as `lastUpdated`.

          - `contributors` returns all of the users who have contributed to the content.

          - `nextVersion` This parameter is not used for this method

# --- truncated at 32 KB (271 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-content-api-openapi.yml