Atlassian Confluence Content API — Content

naftiko: 1.0.0-alpha2
info:
  label: Atlassian Confluence Content API — Content
  description: 'Atlassian Confluence Content API — Content. 37 operations. Lead operation: Atlassian Search Content by Cql.
    Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Content
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-content-content
    baseUri: ''
    description: Atlassian Confluence Content API — Content business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-content-search
      path: /wiki/rest/api/content/search
      operations:
      - name: searchcontentbycql
        method: GET
        description: Atlassian Search Content by Cql
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cql
          in: query
          type: string
          description: The CQL string that is used to find the requested content.
          required: true
        - name: cqlcontext
          in: query
          type: string
          description: The space, content, and content status to execute the search against.
        - name: cursor
          in: query
          type: string
          description: Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous
            search call.
        - name: limit
          in: query
          type: integer
          description: The maximum number of content objects to return per page.
    - name: wiki-rest-api-content-id
      path: /wiki/rest/api/content/{id}
      operations:
      - name: getcontentbyid
        method: GET
        description: Atlassian Get Content by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be returned. If you don't know the content ID,
          required: true
        - name: status
          in: query
          type: array
          description: Filter the results to a set of content based on their status.
        - name: version
          in: query
          type: integer
          description: The version number of the content to be returned.
        - name: embeddedContentRender
          in: query
          type: string
          description: The version of embedded content (e.g. attachments) to render.
        - name: trigger
          in: query
          type: string
          description: If set to `viewed`, the request will trigger a 'viewed' event for the content.
      - name: updatecontent
        method: PUT
        description: Atlassian Update Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be updated.
          required: true
        - name: status
          in: query
          type: string
          description: The updated status of the content. Use this parameter to change the
        - name: conflictPolicy
          in: query
          type: string
          description: The action that should be taken when conflicts are discovered.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecontent
        method: DELETE
        description: Atlassian Delete Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be deleted.
          required: true
        - name: status
          in: query
          type: string
          description: Set this to `trashed`, if the content's status is `trashed` and you want to purge it.
    - name: wiki-rest-api-content-id-child
      path: /wiki/rest/api/content/{id}/child
      operations:
      - name: getcontentchildren
        method: GET
        description: Atlassian Get Content Children
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its children.
          required: true
        - name: expand
          in: query
          type: array
          description: 'A multi-value parameter indicating which properties of the children to expand, where:'
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
    - name: wiki-rest-api-content-id-child-comment
      path: /wiki/rest/api/content/{id}/child/comment
      operations:
      - name: getcontentcomments
        method: GET
        description: Atlassian Get Content Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its comments.
          required: true
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
        - name: start
          in: query
          type: integer
          description: The starting index of the returned comments.
        - name: limit
          in: query
          type: integer
          description: The maximum number of comments to return per page. Note,
        - name: location
          in: query
          type: array
          description: The location of the comments in the page. Multiple locations can be specified.
        - name: depth
          in: query
          type: string
          description: Currently, this parameter is not used.
    - name: wiki-rest-api-content-id-child-type
      path: /wiki/rest/api/content/{id}/child/{type}
      operations:
      - name: getcontentchildrenbytype
        method: GET
        description: Atlassian Get Content Children by Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its children.
          required: true
        - name: type
          in: path
          type: string
          description: The type of children to return.
          required: true
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
        - name: start
          in: query
          type: integer
          description: The starting index of the returned content.
        - name: limit
          in: query
          type: integer
          description: The maximum number of content to return per page. Note,
    - name: wiki-rest-api-content-id-descendant
      path: /wiki/rest/api/content/{id}/descendant
      operations:
      - name: getcontentdescendants
        method: GET
        description: Atlassian Get Content Descendants
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its descendants.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the children to
    - name: wiki-rest-api-content-id-history
      path: /wiki/rest/api/content/{id}/history
      operations:
      - name: getcontenthistory
        method: GET
        description: Atlassian Get Content History
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its history.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content history to expand.
    - name: wiki-rest-api-content-id-label
      path: /wiki/rest/api/content/{id}/label
      operations:
      - name: getlabelsforcontent
        method: GET
        description: Atlassian Get Labels for Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its labels.
          required: true
        - name: prefix
          in: query
          type: string
          description: Filters the results to labels with the specified prefix. If this parameter
        - name: start
          in: query
          type: integer
          description: The starting index of the returned labels.
        - name: limit
          in: query
          type: integer
          description: The maximum number of labels to return per page. Note,
      - name: addlabelstocontent
        method: POST
        description: Atlassian Add Labels to Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that will have labels added to it.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removelabelfromcontentusingqueryparameter
        method: DELETE
        description: Atlassian Remove Label From Content Using Query Parameter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the label will be removed from.
          required: true
        - name: name
          in: query
          type: string
          description: The name of the label to be removed.
          required: true
    - name: wiki-rest-api-content-id-label-label
      path: /wiki/rest/api/content/{id}/label/{label}
      operations:
      - name: removelabelfromcontent
        method: DELETE
        description: Atlassian Remove Label From Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the label will be removed from.
          required: true
        - name: label
          in: path
          type: string
          description: The name of the label to be removed.
          required: true
    - name: wiki-rest-api-content-id-permission-check
      path: /wiki/rest/api/content/{id}/permission/check
      operations:
      - name: checkcontentpermissions
        method: POST
        description: Atlassian Check Content Permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to check permissions against.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wiki-rest-api-content-id-property
      path: /wiki/rest/api/content/{id}/property
      operations:
      - name: getcontentproperties
        method: GET
        description: Atlassian Get Content Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its properties.
          required: true
        - name: key
          in: query
          type: array
          description: The key of the content property.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to
        - name: start
          in: query
          type: integer
          description: The starting index of the returned properties.
        - name: limit
          in: query
          type: integer
          description: The maximum number of properties to return per page.
      - name: createcontentproperty
        method: POST
        description: Atlassian Create Content Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to add the property to.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wiki-rest-api-content-id-property-key
      path: /wiki/rest/api/content/{id}/property/{key}
      operations:
      - name: getcontentproperty
        method: GET
        description: Atlassian Get Content Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for the property.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the content property.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to
        - name: status
          in: query
          type: array
          description: Filter the results to a set of content based on their status. If set to `any`,
      - name: updatecontentproperty
        method: PUT
        description: Atlassian Update Content Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the property belongs to.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the property.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: createcontentpropertyforkey
        method: POST
        description: Atlassian Create Content Property for Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to add the property to.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the content property. Required.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecontentproperty
        method: DELETE
        description: Atlassian Delete Content Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the property belongs to.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the property.
          required: true
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-byGroupId-groupId
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
      operations:
      - name: getcontentrestrictionstatusforgroup
        method: GET
        description: Atlassian Get Content Restriction Status for Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupId
          in: path
          type: string
          description: The id of the group to be queried for whether the content restriction
          required: true
      - name: addgrouptocontentrestriction
        method: PUT
        description: Atlassian Add Group to Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupId
          in: path
          type: string
          description: The groupId of the group to add to the content restriction.
          required: true
      - name: removegroupfromcontentrestriction
        method: DELETE
        description: Atlassian Remove Group From Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupId
          in: path
          type: string
          description: The id of the group to remove from the content restriction.
          required: true
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-group-groupName
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}
      operations:
      - name: getcontentrestrictionstatusforgroup
        method: GET
        description: Atlassian Get Content Restriction Status for Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupName
          in: path
          type: string
          description: The name of the group to be queried for whether the content restriction
          required: true
      - name: addgrouptocontentrestriction
        method: PUT
        description: Atlassian Add Group to Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupName
          in: path
          type: string
          description: The name of the group to add to the content restriction.
          required: true
      - name: removegroupfromcontentrestriction
        method: DELETE
        description: Atlassian Remove Group From Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupName
          in: path
          type: string
          description: The name of the group to remove from the content restriction.
          required: true
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-user
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
      operations:
      - name: getcontentrestrictionstatusforuser
        method: GET
        description: Atlassian Get Content Restriction Status for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that is restricted.
          required: true
      - name: addusertocontentrestriction
        method: PUT
        description: Atlassian Add User to Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
      - name: removeuserfromcontentrestriction
        method: DELETE
        description: Atlassian Remove User From Content Restriction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
    - name: wiki-rest-api-content-id-state
      path: /wiki/rest/api/content/{id}/state
      operations:
      - name: getcontentstate
        method: GET
        description: Atlassian Get Content State
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the content whose content state is of interest.
          required: true
        - name: status
          in: query
          type: string
          description: Set status to one of [current,draft,archived]. Default value is current.
      - name: setthecontentstateofcontentandpublishesnewversionofthecontent
        method: PUT
        description: Atlassian Set the Content State of Content and Publishes New Version of the Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The Id of the content whose content state is to be set.
          required: true
        - name: status
          in: query
          type: string
          description: Status of content onto which state will be placed. If draft, then draft state will change.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removesthecontentstateofcontentandpublishesnewversion
        method: DELETE
        description: Atlassian Removes the Content State of Content and Publishes New Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The Id of the content whose content state is to be set.
          required: true
        - name: status
          in: query
          type: string
          description: status of content state from which to delete state. Can be draft or archived
    - name: wiki-rest-api-content-id-state-available
      path: /wiki/rest/api/content/{id}/state/available
      operations:
      - name: getsavailablecontentstatesforcontent
        method: GET
        description: Atlassian Gets Available Content States for Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: id of content to get available states for
          required: true
    - name: wiki-rest-api-content-id-version
      path: /wiki/rest/api/content/{id}/version
      operations:
      - name: getcontentversions
        method: GET
        description: Atlassian Get Content Versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its versions.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned versions.
        - name: limit
          in: query
          type: integer
          description: The maximum number of versions to return per page.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to expand. By default, the `content`
      - name: restorecontentversion
        method: POST
        description: Atlassian Restore Content Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content for which the history will be restored.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to expand. By default, the `content`
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wiki-rest-api-content-id-version-versionNumber
      path: /wiki/rest/api/content/{id}/version/{versionNumber}
      operations:
      - name: getcontentversion
        method: GET
        description: Atlassian Get Content Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its version.
          required: true
        - name: versionNumber
          in: path
          type: integer
          description: The number of the version to be retrieved.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to expand. By default, the `content`
      - name: deletecontentversion
        method: DELETE
        description: Atlassian Delete Content Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the version will be deleted from.
          required: true
        - name: versionNumber
          in: path
          type: integer
          description: The number of the version to be deleted. The version number starts
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-content-content-rest
    port: 8080
    description: REST adapter for Atlassian Confluence Content API — Content. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/content/search
      name: wiki-rest-api-content-search
      description: REST surface for wiki-rest-api-content-search.
      operations:
      - method: GET
        name: searchcontentbycql
        description: Atlassian Search Content by Cql
        call: confluence-content-content.searchcontentbycql
        with:
          cql: rest.cql
          cqlcontext: rest.cqlcontext
          cursor: rest.cursor
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}
      name: wiki-rest-api-content-id
      description: REST surface for wiki-rest-api-content-id.
      operations:
      - method: GET
        name: getcontentbyid
        description: Atlassian Get Content by Id
        call: confluence-content-content.getcontentbyid
        with:
          id: rest.id
          status: rest.status
          version: rest.version
          embeddedContentRender: rest.embeddedContentRender
          trigger: rest.trigger
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecontent
        description: Atlassian Update Content
        call: confluence-content-content.updatecontent
        with:
          id: rest.id
          status: rest.status
          conflictPolicy: rest.conflictPolicy
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontent
        description: Atlassian Delete Content
        call: confluence-content-content.deletecontent
        with:
          id: rest.id
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child
      name: wiki-rest-api-content-id-child
      description: REST surface for wiki-rest-api-content-id-child.
      operations:
      - method: GET
        name: getcontentchildren
        description: Atlassian Get Content Children
        call: confluence-content-content.getcontentchildren
        with:
          id: rest.id
          expand: rest.expand
          parentVersion: rest.par

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/capabilities/confluence-content-content.yaml