Package io.github.primelib.confluence4j.rest.v1.api

Schnittstelle ConfluenceRESTV1Api

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public interface ConfluenceRESTV1Api

  • Methodendetails

    • addContentWatcher

      void addContentWatcher(@NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Add content watcher

      Adds a user as a watcher to a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      contentId - The ID of the content to add the watcher to. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • addCustomContentPermissions

      void addCustomContentPermissions(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpacePermissionCustomContent body)
      Add new custom content permission to space

      Adds new custom content permission to space. If the permission to be added is a group permission, the group can be identified by its group name or group id. Note: Only apps can access this REST resource and only make changes to the respective app permissions. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [read:space.permission:confluence, write:space.permission:confluence]

      Parameter:
      spaceKey - The key of the space to be queried for its content. (required)
      body - The permissions to be created. (required)

    • addGroupToContentRestriction

      @Deprecated void addGroupToContentRestriction(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupName)
      Veraltet.
      Add group to content restriction

      Deprecated, use [Add group to content restriction via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-put). Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupName - The name of the group to add to the content restriction. (required)

    • addGroupToContentRestrictionByGroupId

      void addGroupToContentRestrictionByGroupId(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      Add group to content restriction

      Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupId - The groupId of the group to add to the content restriction. (required)

    • addLabelWatcher

      void addLabelWatcher(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Add label watcher

      Adds a user as a watcher to a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection. (required)
      labelName - The name of the label to add the watcher to. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • addLabelsToContent

      LabelArray addLabelsToContent(@NotNull @NotNull String id, @NotNull @NotNull AddLabelsToContentRequest body)
      Add labels to content

      Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content ([Create content](#api-content-post)). - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing labels and replace them with the labels in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that will have labels added to it. (required)
      body - The labels to add to the content. (required)

    • addLabelsToSpace

      LabelArray addLabelsToSpace(@NotNull @NotNull String spaceKey, @NotNull @NotNull List<LabelCreate> labelCreate)
      Add labels to a space

      Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content ([Create content](#api-content-post)). - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing labels and replace them with the labels in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space to add labels to. (required)
      labelCreate - The labels to add to the content. (required)

    • addPermissionToSpace

      SpacePermissionV2 addPermissionToSpace(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpacePermissionRequest body)
      Add new permission to space

      Adds new permission to space. If the permission to be added is a group permission, the group can be identified by its group name or group id. Note: Apps cannot access this REST resource - including when utilizing user impersonation. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [read:space.permission:confluence, write:space.permission:confluence]

      Parameter:
      spaceKey - The key of the space to be queried for its content. (required)
      body - The permission to be created. (required)

    • addRestrictions

      ContentRestrictionArray addRestrictions(@NotNull @NotNull String id, @NotNull @NotNull ContentRestrictionAddOrUpdateArray body, @Nullable @Nullable List<String> expand)
      Add restrictions

      Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content to add restrictions to. (required)
      body - The restrictions to be added to the content. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to. (optional)

    • addSpaceWatcher

      void addSpaceWatcher(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Add space watcher

      Adds a user as a watcher to a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection. (required)
      spaceKey - The key of the space to add the watcher to. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • addUserToContentRestriction

      void addUserToContentRestriction(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Add user to content restriction

      Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • addUserToGroup

      @Deprecated void addUserToGroup(@NotNull @NotNull String name, @NotNull @NotNull AccountId body)
      Veraltet.
      Add member to group

      Adds a user as a member in a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      name - Name of the group whose membership is updated (required)
      body - AccountId of the user who needs to be added as member. (required)

    • addUserToGroupByGroupId

      void addUserToGroupByGroupId(@NotNull @NotNull String groupId, @NotNull @NotNull AccountId body)
      Add member to group by groupId

      Adds a user as a member in a group represented by its groupId **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      groupId - GroupId of the group whose membership is updated (required)
      body - AccountId of the user who needs to be added as member. (required)

    • archivePages

      LongTask archivePages(@Nullable @Nullable ArchivePagesRequest archivePagesRequest)
      Archive pages

      Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/&lt;taskId&gt; REST API to get the copy task status. Each content ID needs to resolve to page objects that are not already in an archived state. The content IDs need not belong to the same space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages in the corresponding space it belongs to. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      archivePagesRequest - The pages to be archived. (optional)

    • asyncConvertContentBodyRequest

      AsyncId asyncConvertContentBodyRequest(@NotNull @NotNull String to, @NotNull @NotNull ContentBodyCreate body, @Nullable @Nullable List<String> expand, @Nullable @Nullable String spaceKeyContext, @Nullable @Nullable String contentIdContext, @Nullable @Nullable Boolean allowCache, @Nullable @Nullable String embeddedContentRender)
      Asynchronously convert content body

      Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task. Supported conversions: - storage: export_view No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5 minutes at the result endpoint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      to - The name of the target format for the content body. (required)
      body - The content body to convert. (required)
      expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.superbatch.tags.css returns all common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.superbatch.tags.js returns all common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.tags.css returns common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.tags.js returns common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags (optional)
      spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space. (optional)
      contentIdContext - The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided. (optional)
      allowCache - If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions. (optional, defaults to false)
      embeddedContentRender - Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save. (optional, defaults to current)

    • asyncConvertContentBodyResponse

      AsyncContentBody asyncConvertContentBodyResponse(@NotNull @NotNull String id)
      Get asynchronously converted content body from the id or the current status of the task.

      Returns the asynchronous content body for the corresponding id if the task is complete or returns the status of the task. After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is made again, with allowCache query param set to false. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The asyncId of the macro task to get the converted body. (required)

    • bulkRemoveContentStates

      AsyncId bulkRemoveContentStates(@NotNull @NotNull String status, @Nullable @Nullable BulkRemoveContentStatesRequest bulkRemoveContentStatesRequest)
      Bulk remove content states from content

      Creates a long running task that Removes content state from draft or published versions of pages specified. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Content Edit Permission for a content to have its state removed via this endpoint. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      status - Set status to one of [current,draft]. (required)
      bulkRemoveContentStatesRequest - (optional)

    • bulkSetContentStates

      AsyncId bulkSetContentStates(@NotNull @NotNull String status, @NotNull @NotNull BulkContentStateSetInput bulkContentStateSetInput)
      Bulk set content state of many contents

      Creates a long running task that sets content state of draft or published versions of pages specified. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Content Edit Permission for a content to have its state set via this endpoint. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      status - Set status to one of [current,draft]. (required)
      bulkContentStateSetInput - The content state and ids to set it to. (required)

    • checkContentPermission

      PermissionCheckResponse checkContentPermission(@NotNull @NotNull String id, @NotNull @NotNull ContentPermissionRequest body)
      Check content permissions

      Check if a user or a group can perform an operation to the specified content. The operation to check must be provided. The user’s account ID or the ID of the group can be provided in the subject to check permissions against a specified user or group. The following permission checks are done to make sure that the user or group has the proper access: - site permissions - space permissions - content restrictions **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) if checking permission for self, otherwise 'Confluence Administrator' global permission is required. Authentication - Required Scopes: [read:confluence-content.permission]

      Parameter:
      id - The ID of the content to check permissions against. (required)
      body - The content permission request. (required)

    • convertContentBody

      ContentBody convertContentBody(@NotNull @NotNull String to, @NotNull @NotNull ContentBodyCreate body, @Nullable @Nullable String spaceKeyContext, @Nullable @Nullable String contentIdContext, @Nullable @Nullable String embeddedContentRender, @Nullable @Nullable List<String> expand)
      Convert content body

      Converts a content body from one format to another format. Supported conversions: - storage: view, export_view, styled_view, editor - editor: storage - view: none - export_view: none - styled_view: none **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      to - The name of the target format for the content body. (required)
      body - The content body to convert. (required)
      spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space. (optional)
      contentIdContext - The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided. (optional)
      embeddedContentRender - Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save. (optional, defaults to current)
      expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.superbatch.tags.css returns all common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.superbatch.tags.js returns all common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.tags.css returns common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.tags.js returns common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags (optional)

    • copyPage

      Content copyPage(@NotNull @NotNull String id, @NotNull @NotNull CopyPageRequest request, @Nullable @Nullable List<String> expand)
      Copy single page

      Copies a single page and its associated properties, permissions, attachments, and custom contents. The id path parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using the destination in the request body and can be one of the following types. - space: page will be copied to the specified space as a root page on the space - parent_page: page will be copied as a child of the specified parent page - existing_page: page will be copied and replace the specified page By default, the following objects are expanded: space, history, version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the space that the content will be copied in and permission to update the content if copying to an existing_page. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - (required)
      request - Request object from json post body (required)
      expand - A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)

    • copyPageHierarchy

      LongTask copyPageHierarchy(@NotNull @NotNull String id, @NotNull @NotNull CopyPageHierarchyRequest request)
      Copy page hierarchy

      Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles. Response example: &lt;pre&gt;&lt;code&gt; { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } &lt;/code&gt;&lt;/pre&gt; Use the /longtask/&lt;taskId&gt; REST API to get the copy task status. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - (required)
      request - Request object from json post body (required)

    • createAttachment

      ContentArray createAttachment(@NotNull @NotNull String id, @NotNull @NotNull File _file, @NotNull @NotNull File minorEdit, @Nullable @Nullable String status, @Nullable @Nullable File comment)
      Create attachment

      Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing attachment, use [Create or update attachments](#api-content-id-child-attachment-put). Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data. The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client libraries have classes that make it easier to implement multipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class provided by Apache HTTP Components. Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is text, the charset parameter for the "text/plain" Content-Type may be used to indicate the character encoding used in that part. In the case of this API endpoint, the comment body parameter should be sent with type=text/plain and charset=utf-8 values. This will force the charset to be UTF-8. Example: This curl command attaches a file ('example.txt') to a container (id='123') with a comment and minorEdits=true. ` bash curl -D- \\ -u admin:admin \\ -X POST \\ -H 'X-Atlassian-Token: nocheck' \\ -F 'file=@"example.txt"' \\ -F 'minorEdit="true"' \\ -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \\ http://myhost/rest/api/content/123/child/attachment ` **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-file]

      Parameter:
      id - The ID of the content to add the attachment to. (required)
      _file - The relative location and name of the attachment to be added to the content. (required)
      minorEdit - If minorEdits is set to 'true', no notification email or activity stream will be generated when the attachment is added to the content. (required)
      status - The status of the content that the attachment is being added to. (optional, defaults to current)
      comment - The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don't specify any comments. (optional)

    • createAuditRecord

      AuditRecord createAuditRecord(@NotNull @NotNull AuditRecordCreate body)
      Create audit record

      Creates a record in the audit log. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [read:audit-log:confluence, write:audit-log:confluence]

      Parameter:
      body - The record to be created in the audit log. (required)

    • createContent

      @Deprecated Content createContent(@NotNull @NotNull ContentCreate content, @Nullable @Nullable String status, @Nullable @Nullable List<String> expand)
      Veraltet.
      Create content

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Creates a new piece of content or publishes an existing draft. To publish a draft, add the id and status properties to the body of the request. Set the id to the ID of the draft and set the status to 'current'. When the request is sent, a new piece of content will be created and the metadata from the draft will be transferred into it. By default, the following objects are expanded: space, history, version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the space that the content will be created in, and permission to view the draft if publishing a draft. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      content - The new content to be created. Set the representation to the name of the body format type. For example, if you use storage for the body format, set 'representation=storage'. See [Confluence storage format](https://confluence.atlassian.com/x/AJkiLw). If you are not sure how to generate the different formats, you can create a page in the Confluence application, retrieve the content using [Get content](#api-content-get), and expand the desired content format, e.g. expand=body.storage. (required)
      status - Filter the returned content by status. (optional, defaults to current)
      expand - A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)

    • createContentProperty

      @Deprecated ContentProperty createContentProperty(@NotNull @NotNull String id, @NotNull @NotNull ContentPropertyCreate body)
      Veraltet.
      Create content property

      Creates a property for an existing piece of content. For more information about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). This is the same as [Create content property for key](#api-content-id-property-key-post) except that the key is specified in the request body instead of as a path parameter. Content properties can also be added when creating a new piece of content by including them in the metadata.properties of the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      id - The ID of the content to add the property to. (required)
      body - The content property to be created. (required)

    • createContentPropertyForKey

      @Deprecated ContentProperty createContentPropertyForKey(@NotNull @NotNull String id, @NotNull @NotNull String key, @NotNull @NotNull ContentPropertyCreateNoKey body)
      Veraltet.
      Create content property for key

      Creates a property for an existing piece of content. For more information about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). This is the same as [Create content property](#api-content-id-property-post) except that the key is specified as a path parameter instead of in the request body. Content properties can also be added when creating a new piece of content by including them in the metadata.properties of the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      id - The ID of the content to add the property to. (required)
      key - The key of the content property. Required. (required)
      body - The content property to be created. (required)

    • createContentTemplate

      ContentTemplate createContentTemplate(@NotNull @NotNull ContentTemplateCreate body)
      Create content template

      Creates a new content template. Note, blueprint templates cannot be created via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a space template or 'Confluence Administrator' global permission to create a global template. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      body - The content template to be created. The content body must be in 'storage' format. (required)

    • createGroup

      Group createGroup(@NotNull @NotNull GroupName body)
      Create new user group

      Creates a new user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      body - Name of the group that is to be created. (required)

    • createOrUpdateAttachments

      ContentArray createOrUpdateAttachments(@NotNull @NotNull String id, @NotNull @NotNull File _file, @NotNull @NotNull File minorEdit, @Nullable @Nullable String status, @Nullable @Nullable File comment)
      Create or update attachment

      Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is updated (i.e. a new version of the attachment is created). Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data. The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client libraries have classes that make it easier to implement multipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class provided by Apache HTTP Components. Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is text, the charset parameter for the "text/plain" Content-Type may be used to indicate the character encoding used in that part. In the case of this API endpoint, the comment body parameter should be sent with type=text/plain and charset=utf-8 values. This will force the charset to be UTF-8. Example: This curl command attaches a file ('example.txt') to a piece of content (id='123') with a comment and minorEdits=true. If the 'example.txt' file already exists, it will update it with a new version of the attachment. ` bash curl -D- \\ -u admin:admin \\ -X PUT \\ -H 'X-Atlassian-Token: nocheck' \\ -F 'file=@"example.txt"' \\ -F 'minorEdit="true"' \\ -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \\ http://myhost/rest/api/content/123/child/attachment ` **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-file]

      Parameter:
      id - The ID of the content to add the attachment to. (required)
      _file - The relative location and name of the attachment to be added to the content. (required)
      minorEdit - If minorEdits is set to 'true', no notification email or activity stream will be generated when the attachment is added to the content. (required)
      status - The status of the content that the attachment is being added to. This should always be set to 'current'. (optional, defaults to current)
      comment - The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don't specify any comments. (optional)

    • createPrivateSpace

      Space createPrivateSpace(@NotNull @NotNull SpaceCreate spacePrivateCreate)
      Create private space

      Creates a new space that is only visible to the creator. This method is the same as the [Create space](#api-space-post) method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spacePrivateCreate - The space to be created. (required)

    • createRelationship

      Relation createRelationship(@NotNull @NotNull String relationName, @NotNull @NotNull String sourceType, @NotNull @NotNull String sourceKey, @NotNull @NotNull String targetType, @NotNull @NotNull String targetKey, @Nullable @Nullable String sourceStatus, @Nullable @Nullable String targetStatus, @Nullable @Nullable Integer sourceVersion, @Nullable @Nullable Integer targetVersion)
      Create relationship

      Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by default, but you can use this method to create any type of relationship between two entities. For example, the following method creates a 'sibling' relationship between two pieces of content: GET /wiki/rest/api/relation/sibling/from/content/123/to/content/456 **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      relationName - The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship. You can also specify any other value for this parameter to create a custom relationship type. (required)
      sourceType - The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'. (required)
      sourceKey - - The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      targetType - The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'. (required)
      targetKey - - The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'. (optional)
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'. (optional)
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'. (optional)
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'. (optional)

    • createSpace

      Space createSpace(@NotNull @NotNull SpaceCreate body)
      Create space

      Creates a new space. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      body - The space to be created. (required)

    • createSpaceProperty

      @Deprecated SpaceProperty createSpaceProperty(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpacePropertyCreate body)
      Veraltet.
      Create space property

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Creates a new space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      spaceKey - The key of the space that the property will be created in. (required)
      body - The space property to be created. (required)

    • createSpacePropertyForKey

      @Deprecated SpaceProperty createSpacePropertyForKey(@NotNull @NotNull String spaceKey, @NotNull @NotNull String key, @NotNull @NotNull SpacePropertyCreateNoKey body)
      Veraltet.
      Create space property for key

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Creates a new space property. This is the same as POST /wiki/rest/api/space/{spaceKey}/property but the key for the property is passed as a path parameter, rather than in the request body. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      spaceKey - The key of the space that the property will be created in. (required)
      key - The key of the property to be created. (required)
      body - The space property to be created. (required)

    • createUserProperty

      void createUserProperty(@NotNull @NotNull String userId, @NotNull @NotNull String key, @NotNull @NotNull UserPropertyCreate body)
      Create user property by key

      Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level. Note: the number of properties which could be created per app in a tenant for each user might be restricted by fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:user.property:confluence]

      Parameter:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 (required)
      key - The key of the user property. (required)
      body - The user property to be created. (required)

    • deleteContent

      @Deprecated void deleteContent(@NotNull @NotNull String id, @Nullable @Nullable String status)
      Veraltet.
      Delete content

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and status: - If the content's type is page,blogpost, or attachment and its status is current, it will be trashed. - If the content's type is page,blogpost, or attachment and its status is trashed, the content will be purged from the trash and deleted permanently. Note, you must also set the status query parameter to trashed in your request. - If the content's type is comment, it will be deleted permanently without being trashed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the content is in. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content to be deleted. (required)
      status - Set this to trashed, if the content's status is trashed and you want to purge it. (optional)

    • deleteContentProperty

      @Deprecated void deleteContentProperty(@NotNull @NotNull String id, @NotNull @NotNull String key)
      Veraltet.
      Delete content property

      Deletes a content property. For more information about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      id - The ID of the content that the property belongs to. (required)
      key - The key of the property. (required)

    • deleteContentVersion

      void deleteContentVersion(@NotNull @NotNull String id, @NotNull @NotNull Integer versionNumber)
      Delete content version

      Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the version will be deleted from. (required)
      versionNumber - The number of the version to be deleted. The version number starts from 1 up to current version. (required)

    • deleteLabelFromSpace

      void deleteLabelFromSpace(@NotNull @NotNull String spaceKey, @NotNull @NotNull String name, @Nullable @Nullable String prefix)
      Remove label from a space Authentication - Required Scopes: [write:confluence-space]
      Parameter:
      spaceKey - The key of the space to remove a labels from. (required)
      name - The name of the label to remove (required)
      prefix - The prefix of the label to remove. If not provided defaults to global. (optional)

    • deletePageTree

      LongTask deletePageTree(@NotNull @NotNull String id)
      Delete page tree

      Moves a pagetree rooted at a page to the space's trash: - If the content's type is page and its status is current, it will be trashed including all its descendants. - For every other combination of content type and status, this API is not supported. This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously. Response example: &lt;pre&gt;&lt;code&gt; { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } &lt;/code&gt;&lt;/pre&gt; Use the /longtask/&amp;lt;taskId&amp;gt; REST API to get the copy task status. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the content is in. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content which forms root of the page tree, to be deleted. (required)

    • deleteRelationship

      void deleteRelationship(@NotNull @NotNull String relationName, @NotNull @NotNull String sourceType, @NotNull @NotNull String sourceKey, @NotNull @NotNull String targetType, @NotNull @NotNull String targetKey, @Nullable @Nullable String sourceStatus, @Nullable @Nullable String targetStatus, @Nullable @Nullable Integer sourceVersion, @Nullable @Nullable Integer targetVersion)
      Delete relationship

      Deletes a relationship between two entities (user, space, content). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite relationships. A space administrator can delete favourite relationships for any user. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      relationName - The name of the relationship. (required)
      sourceType - The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'. (required)
      sourceKey - - The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      targetType - The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'. (required)
      targetKey - - The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'. (optional)
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'. (optional)
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'. (optional)
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'. (optional)

    • deleteRestrictions

      ContentRestrictionArray deleteRestrictions(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      Delete restrictions

      Removes all restrictions (read and update) on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content to remove restrictions from. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to. (optional)

    • deleteSpace

      LongTask deleteSpace(@NotNull @NotNull String spaceKey)
      Delete space

      Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space to delete. (required)

    • deleteSpaceProperty

      @Deprecated void deleteSpaceProperty(@NotNull @NotNull String spaceKey, @NotNull @NotNull String key)
      Veraltet.
      Delete space property

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Deletes a space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      spaceKey - The key of the space that the property is in. (required)
      key - The key of the property to be deleted. (required)

    • deleteUserProperty

      void deleteUserProperty(@NotNull @NotNull String userId, @NotNull @NotNull String key)
      Delete user property

      Deletes a property for the given user. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:user.property:confluence]

      Parameter:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 (required)
      key - The key of the user property. (required)

    • downloadAttatchment

      void downloadAttatchment(@NotNull @NotNull String id, @NotNull @NotNull String attachmentId, @Nullable @Nullable Integer version)
      Get URI to download attachment

      Redirects the client to a URL that serves an attachment's binary data. Authentication - Required Scopes: [readonly:content.attachment:confluence]

      Parameter:
      id - The ID of the content that the attachment is attached to. (required)
      attachmentId - The ID of the attachment to download. (required)
      version - The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of the attachment. (optional)

    • exportAuditRecords

      File exportAuditRecords(@Nullable @Nullable String startDate, @Nullable @Nullable String endDate, @Nullable @Nullable String searchString, @Nullable @Nullable String format)
      Export audit records

      Exports audit records as a CSV file or ZIP file. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [read:audit-log:confluence]

      Parameter:
      startDate - Filters the exported results to the records on or after the startDate. The startDate must be specified as a [timestamp](https://www.unixtimestamp.com/). (optional)
      endDate - Filters the exported results to the records on or before the endDate. The endDate must be specified as a [timestamp](https://www.unixtimestamp.com/). (optional)
      searchString - Filters the exported results to records that have string property values matching the searchString. (optional)
      format - The format of the export file for the audit records. (optional, defaults to csv)

    • findSourcesForTarget

      RelationArray findSourcesForTarget(@NotNull @NotNull String relationName, @NotNull @NotNull String sourceType, @NotNull @NotNull String targetType, @NotNull @NotNull String targetKey, @Nullable @Nullable String sourceStatus, @Nullable @Nullable String targetStatus, @Nullable @Nullable Integer sourceVersion, @Nullable @Nullable Integer targetVersion, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Find source entities related to a target entity

      Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way. For example, the following method finds all users that have a 'collaborator' relationship to a piece of content with an ID of '1234': GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user Note, 'collaborator' is an example custom relationship type. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity and source entity. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      relationName - The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships. (required)
      sourceType - The source entity type of the relationship. (required)
      targetType - The target entity type of the relationship. (required)
      targetKey - The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType is 'space', then specify the space key. (required)
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'. (optional)
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'. (optional)
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'. (optional)
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'. (optional)
      expand - A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity. (optional)
      start - The starting index of the returned relationships. (optional, defaults to 0)
      limit - The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • findTargetFromSource

      RelationArray findTargetFromSource(@NotNull @NotNull String relationName, @NotNull @NotNull String sourceType, @NotNull @NotNull String sourceKey, @NotNull @NotNull String targetType, @Nullable @Nullable String sourceStatus, @Nullable @Nullable String targetStatus, @Nullable @Nullable Integer sourceVersion, @Nullable @Nullable Integer targetVersion, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Find target entities related to a source entity

      Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way. For example, the following method finds all content that the current user has an 'ignore' relationship with: GET /wiki/rest/api/relation/ignore/from/user/current/to/content Note, 'ignore' is an example custom relationship type. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity and source entity. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      relationName - The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships. (required)
      sourceType - The source entity type of the relationship. (required)
      sourceKey - The identifier for the source entity: - If sourceType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      targetType - The target entity type of the relationship. (required)
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'. (optional)
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'. (optional)
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'. (optional)
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'. (optional)
      expand - A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity. (optional)
      start - The starting index of the returned relationships. (optional, defaults to 0)
      limit - The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getAllLabelContent

      LabelDetails getAllLabelContent(@NotNull @NotNull String name, @Nullable @Nullable String type, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get label information

      Returns label information and a list of contents associated with the label. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only contents that the user is permitted to view is returned. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      name - Name of the label to query. (required)
      type - The type of contents that are to be returned. (optional)
      start - The starting offset for the results. (optional, defaults to 0)
      limit - The number of results to be returned. (optional, defaults to 200)

    • getAndAsyncConvertMacroBodyByMacroId

      AsyncId getAndAsyncConvertMacroBodyByMacroId(@NotNull @NotNull String id, @NotNull @NotNull Integer version, @NotNull @NotNull String macroId, @NotNull @NotNull String to, @Nullable @Nullable List<String> expand, @Nullable @Nullable Boolean allowCache, @Nullable @Nullable String spaceKeyContext, @Nullable @Nullable String embeddedContentRender)
      Get macro body by macro ID and convert representation Asynchronously

      Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The result will be available for 5 minutes after completion of the conversion. About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for it, unless an ID is specified (by an app). The macro ID will look similar to this: '884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only modified by Confluence if there are conflicting IDs. Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and transparently propagate out to all instances. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID for the content that contains the macro. (required)
      version - The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version. (required)
      macroId - The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'. (required)
      to - The content representation to return the macro in. Currently, the following conversions are allowed: - export_view - styled_view - view (required)
      expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.superbatch.tags.css returns all common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.superbatch.tags.js returns all common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.tags.css returns common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.tags.js returns common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags (optional)
      allowCache - If this field is false, the cache will erase its current value and begin a conversion. If this field is true, the cache will not erase its current value, and will set the status of the result in cache to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and who want to show intermediate, but potentially stale data, immediately should set this field to true. Cache values are stored per macro per user per content and expansions. (optional, defaults to false)
      spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space. (optional)
      embeddedContentRender - Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save. (optional, defaults to current)

    • getAndConvertMacroBodyByMacroId

      ContentBody getAndConvertMacroBodyByMacroId(@NotNull @NotNull String id, @NotNull @NotNull Integer version, @NotNull @NotNull String macroId, @NotNull @NotNull String to, @Nullable @Nullable List<String> expand, @Nullable @Nullable String spaceKeyContext, @Nullable @Nullable String embeddedContentRender)
      Get macro body by macro ID and convert the representation synchronously

      Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for it, unless an ID is specified (by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only modified by Confluence if there are conflicting IDs. Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and transparently propagate out to all instances. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID for the content that contains the macro. (required)
      version - The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version. (required)
      macroId - The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'. (required)
      to - The content representation to return the macro in. (required)
      expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.superbatch.tags.css returns all common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.superbatch.tags.js returns all common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.tags.css returns common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.tags.js returns common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags (optional)
      spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space. (optional)
      embeddedContentRender - Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save. (optional, defaults to current)

    • getAnonymousUser

      UserAnonymous getAnonymousUser(@Nullable @Nullable List<String> expand)
      Get anonymous user

      Returns information about how anonymous users are represented, like the profile picture and display name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-user]

      Parameter:
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. (optional)

    • getAttachments

      @Deprecated ContentArray getAttachments(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable String filename, @Nullable @Nullable String mediaType)
      Veraltet.
      Get attachments

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns the attachments for a piece of content. By default, the following objects are expanded: metadata. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its attachments. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      start - The starting index of the returned attachments. (optional, defaults to 0)
      limit - The maximum number of attachments to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      filename - Filter the results to attachments that match the filename. (optional)
      mediaType - Filter the results to attachments that match the media type. (optional)

    • getAuditRecords

      AuditRecordArray getAuditRecords(@Nullable @Nullable String startDate, @Nullable @Nullable String endDate, @Nullable @Nullable String searchString, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get audit records

      Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [read:audit-log:confluence]

      Parameter:
      startDate - Filters the results to the records on or after the startDate. The startDate must be specified as a [timestamp](https://www.unixtimestamp.com/). (optional)
      endDate - Filters the results to the records on or before the endDate. The endDate must be specified as a [timestamp](https://www.unixtimestamp.com/). (optional)
      searchString - Filters the results to records that have string property values matching the searchString. (optional)
      start - The starting index of the returned records. (optional, defaults to 0)
      limit - The maximum number of records to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 1000)

    • getAuditRecordsForTimePeriod

      AuditRecordArray getAuditRecordsForTimePeriod(@Nullable @Nullable Long number, @Nullable @Nullable String units, @Nullable @Nullable String searchString, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get audit records for time period

      Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [read:audit-log:confluence]

      Parameter:
      number - The number of units for the time period. (optional, defaults to 3)
      units - The unit of time that the time period is measured in. (optional, defaults to MONTHS)
      searchString - Filters the results to records that have string property values matching the searchString. (optional)
      start - The starting index of the returned records. (optional, defaults to 0)
      limit - The maximum number of records to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 1000)

    • getAvailableContentStates

      AvailableContentStates getAvailableContentStates(@NotNull @NotNull String id)
      Gets available content states for content.

      Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list. To get all custom content states, use the /content-states endpoint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - id of content to get available states for (required)

    • getBlueprintTemplates

      BlueprintTemplateArray getBlueprintTemplates(@Nullable @Nullable String spaceKey, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable List<String> expand)
      Get blueprint templates

      Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global blueprints. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      spaceKey - The key of the space to be queried for templates. If the spaceKey is not specified, global blueprint templates will be returned. (optional)
      start - The starting index of the returned templates. (optional, defaults to 0)
      limit - The maximum number of templates to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      expand - A multi-value parameter indicating which properties of the template to expand. - body returns the content of the template in storage format. (optional)

    • getBulkUserLookup

      BulkUserLookupArray getBulkUserLookup(@NotNull @NotNull String accountId, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer limit)
      Get multiple users using ids

      Returns user details for the ids provided in request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-user]

      Parameter:
      accountId - A list of accountId's of users to be returned. (required)
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user. (optional)
      limit - The maximum number of results returned. Currently API returns 200 results max. If more that 200 ids are passed first 200 will be returned. (optional)

    • getContent

      @Deprecated ContentArray getContent(@Nullable @Nullable String type, @Nullable @Nullable String spaceKey, @Nullable @Nullable String title, @Nullable @Nullable List<String> status, @Nullable @Nullable String postingDay, @Nullable @Nullable List<String> expand, @Nullable @Nullable String trigger, @Nullable @Nullable String orderby, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get content

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all content in a Confluence instance. By default, the following objects are expanded: space, history, version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      type - The type of content to return. For example: - page - blogpost (optional, defaults to page)
      spaceKey - The key of the space to be queried for its content. (optional)
      title - The title of the page to be returned. Required for &lt;code&gt;page&lt;/code&gt; type. (optional)
      status - 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. (optional, defaults to current)
      postingDay - The posting date of the blog post to be returned. Required for &lt;code&gt;blogpost&lt;/code&gt; type. Format: &lt;code&gt;yyyy-mm-dd&lt;/code&gt;. (optional)
      expand - A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      trigger - 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. (optional)
      orderby - Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'. (optional)
      start - The starting index of the returned content. (optional, defaults to 0)
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getContentById

      @Deprecated Content getContentById(@NotNull @NotNull String id, @Nullable @Nullable List<String> status, @Nullable @Nullable Integer version, @Nullable @Nullable String embeddedContentRender, @Nullable @Nullable List<String> expand, @Nullable @Nullable String trigger)
      Veraltet.
      Get content by ID

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns a single piece of content, like a page or a blog post. By default, the following objects are expanded: space, history, version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - 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)
      status - 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. (optional, defaults to current)
      version - The version number of the content to be returned. (optional)
      embeddedContentRender - The version of embedded content (e.g. attachments) to render. - &lt;code&gt;current&lt;/code&gt; renders the latest version of the embedded content. - &lt;code&gt;version-at-save&lt;/code&gt; renders the version of the embedded content at the time of save. (optional, defaults to current)
      expand - A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      trigger - 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. (optional)

    • getContentByTypeForSpace

      @Deprecated ContentArray getContentByTypeForSpace(@NotNull @NotNull String spaceKey, @NotNull @NotNull String type, @Nullable @Nullable String depth, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get content by type for space

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its content. (required)
      type - The type of content to return. page, blogpost, &amp;lt;some_customContentType&amp;gt;. (required)
      depth - Filter the results to content at the root level of the space or all content. (optional, defaults to all)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      start - The starting index of the returned content. (optional, defaults to 0)
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getContentChildren

      @Deprecated ContentChildren getContentChildren(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer parentVersion)
      Veraltet.
      Get content children

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships: - page: child content is page, comment, attachment - blogpost: child content is comment, attachment - attachment: child content is comment - comment: child content is attachment Apps can override these default relationships. Apps can also introduce new content types that create new parent-child content relationships. Note, the map will always include all child content types that are valid for the content. However, if the content has no instances of a child content type, the map will contain an empty array for that child content type. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its children. (required)
      expand - 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. (optional)
      parentVersion - The version of the parent content to retrieve children for. Currently, this only works for the latest version. (optional, defaults to 0)

    • getContentChildrenByType

      @Deprecated ContentArray getContentChildrenByType(@NotNull @NotNull String id, @NotNull @NotNull String type, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer parentVersion, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get content children by type

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type: - page: child content is page, comment, attachment - blogpost: child content is comment, attachment - attachment: child content is comment - comment: child content is attachment Custom content types that are provided by apps can also be returned. Note, this method only returns direct children. To return children at all levels, use [Get descendants by type](#api-content-id-descendant-type-get). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its children. (required)
      type - The type of children to return. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      parentVersion - The version of the parent content to retrieve children for. Currently, this only works for the latest version. (optional, defaults to 0)
      start - The starting index of the returned content. (optional)
      limit - The maximum number of content to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getContentComments

      @Deprecated ContentArray getContentComments(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer parentVersion, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable List<String> location, @Nullable @Nullable String depth)
      Veraltet.
      Get content comments

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns the comments on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its comments. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      parentVersion - The version of the parent content to retrieve children for. Currently, this only works for the latest version. (optional, defaults to 0)
      start - The starting index of the returned comments. (optional)
      limit - The maximum number of comments to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      location - The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned. (optional)
      depth - Currently, this parameter is not used. Comments are returned at the root level only. (optional)

    • getContentDescendants

      ContentChildren getContentDescendants(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      Get content descendants

      Returns a map of the descendants of a piece of content. This is similar to [Get content children](#api-content-id-child-get), except that this method returns child pages at all levels, rather than just the direct child pages. A piece of content has different types of descendants, depending on its type: - page: descendant is page, comment, attachment - blogpost: descendant is comment, attachment - attachment: descendant is comment - comment: descendant is attachment The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its descendants. (required)
      expand - 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. (optional)

    • getContentForSpace

      @Deprecated GetContentForSpace200Response getContentForSpace(@NotNull @NotNull String spaceKey, @Nullable @Nullable String depth, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get content for space

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by content ID in ascending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the returned list will only contain content that the current user has permission to view. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its content. (required)
      depth - Filter the results to content at the root level of the space or all content. (optional, defaults to all)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      start - The starting index of the returned content. (optional, defaults to 0)
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getContentProperties

      @Deprecated ContentPropertyArray getContentProperties(@NotNull @NotNull String id, @Nullable @Nullable List<String> key, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get content properties

      Returns the properties for a piece of content. For more information about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-props]

      Parameter:
      id - The ID of the content to be queried for its properties. (required)
      key - The key of the content property. (optional)
      expand - A multi-value parameter indicating which properties of the content to expand. By default, the version object is expanded. - content returns the content that the property is stored against. - version returns information about the version of the property, such as the version number, when it was created, etc. (optional)
      start - The starting index of the returned properties. (optional, defaults to 0)
      limit - The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 10)

    • getContentProperty

      @Deprecated ContentProperty getContentProperty(@NotNull @NotNull String id, @NotNull @NotNull String key, @Nullable @Nullable List<String> expand, @Nullable @Nullable List<String> status)
      Veraltet.
      Get content property

      Returns a content property for a piece of content. For more information, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-props]

      Parameter:
      id - The ID of the content to be queried for the property. (required)
      key - The key of the content property. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. By default, the version object is expanded. - content returns the content that the property is stored against. - version returns information about the version of the property, such as the version number, when it was created, etc. (optional)
      status - Filter the results to a set of content based on their status. If set to any, content with any status is returned. By default it will fetch current and archived statuses ?status=current&amp;status=archived. All supported statuses - any - archived - current - deleted - draft - trashed (optional, defaults to current,archived)

    • getContentRestrictionStatusForGroup

      @Deprecated void getContentRestrictionStatusForGroup(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupName)
      Veraltet.
      Get content restriction status for group

      Deprecated, use [Get content restriction status for group via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-get). Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the admins group, the following request will return true: /wiki/rest/api/content/123/restriction/byOperation/read/group/admins Note that a response of true does not guarantee that the group can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupName - The name of the group to be queried for whether the content restriction applies to it. (required)

    • getContentRestrictionStatusForUser

      void getContentRestrictionStatusForUser(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Get content restriction status for user

      Returns whether the specified content restriction applies to a user. For example, if a page with id=123 has a read restriction for a user with an account ID of 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192, the following request will return true: /wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 Note that a response of true does not guarantee that the user can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that is restricted. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • getContentState

      ContentStateResponse getContentState(@NotNull @NotNull String id, @Nullable @Nullable String status)
      Get content state

      Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The id of the content whose content state is of interest. (required)
      status - Set status to one of [current,draft,archived]. Default value is current. (optional, defaults to current)

    • getContentStateSettings

      ContentStateSettings getContentStateSettings(@NotNull @NotNull String spaceKey)
      Get content state settings for space

      Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space admin permission Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its content state settings. (required)

    • getContentTemplate

      ContentTemplate getContentTemplate(@NotNull @NotNull String contentTemplateId)
      Get content template

      Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view space templates and permission to access the Confluence site ('Can use' global permission) to view global templates. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      contentTemplateId - The ID of the content template to be returned. (required)

    • getContentTemplates

      ContentTemplateArray getContentTemplates(@Nullable @Nullable String spaceKey, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable List<String> expand)
      Get content templates

      Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view space templates and permission to access the Confluence site ('Can use' global permission) to view global templates. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      spaceKey - The key of the space to be queried for templates. If the spaceKey is not specified, global templates will be returned. (optional)
      start - The starting index of the returned templates. (optional, defaults to 0)
      limit - The maximum number of templates to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      expand - A multi-value parameter indicating which properties of the template to expand. - body returns the content of the template in storage format. (optional)

    • getContentVersion

      @Deprecated Version getContentVersion(@NotNull @NotNull String id, @NotNull @NotNull Integer versionNumber, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get content version

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns a version for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its version. (required)
      versionNumber - The number of the version to be retrieved. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded. - collaborators returns the users that collaborated on the version. - content returns the content for the version. (optional)

    • getContentVersions

      @Deprecated VersionArray getContentVersions(@NotNull @NotNull String id, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get content versions

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns the versions for a piece of content in descending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its versions. (required)
      start - The starting index of the returned versions. (optional, defaults to 0)
      limit - The maximum number of versions to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)
      expand - A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded. - collaborators returns the users that collaborated on the version. - content returns the content for the version. (optional)

    • getContentWatchStatus

      UserWatch getContentWatchStatus(@NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Get content watch status

      Returns whether a user is watching a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      contentId - The ID of the content to be queried for whether the specified user is watching it. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • getContentsWithState

      ContentArray getContentsWithState(@NotNull @NotNull String spaceKey, @NotNull @NotNull Integer stateId, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer limit, @Nullable @Nullable Integer start)
      Get content in space with given content state

      Finds paginated content with **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space View Permission Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      spaceKey - The key of the space to be queried for its content state settings. (required)
      stateId - The id of the content state to filter content by (required)
      expand - A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version (optional)
      limit - Maximum number of results to return (optional, defaults to 25)
      start - Number of result to start returning. (0 indexed) (optional)

    • getCurrentUser

      User getCurrentUser(@Nullable @Nullable List<String> expand)
      Get current user

      Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-user]

      Parameter:
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user. (optional)

    • getCustomContentStates

      List<ContentState> getCustomContentStates()
      Get Custom Content States

      Get custom content states that authenticated user has created. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Must have user authentication. Authentication - Required Scopes: [read:user.property:confluence]

    • getDescendantsOfType

      ContentArray getDescendantsOfType(@NotNull @NotNull String id, @NotNull @NotNull String type, @Nullable @Nullable String depth, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get content descendants by type

      Returns all descendants of a given type, for a piece of content. This is similar to [Get content children by type](#api-content-id-child-type-get), except that this method returns child pages at all levels, rather than just the direct child pages. A piece of content has different types of descendants, depending on its type: - page: descendant is page, comment, attachment - blogpost: descendant is comment, attachment - attachment: descendant is comment - comment: descendant is attachment Custom content types that are provided by apps can also be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its descendants. (required)
      type - The type of descendants to return. (required)
      depth - Filter the results to descendants upto a desired level of the content. Note, the maximum value supported is 100. root level of the content means immediate (level 1) descendants of the type requested. all represents returning all descendants of the type requested. (optional, defaults to all)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      start - The starting index of the returned content. (optional, defaults to 0)
      limit - The maximum number of content to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getGlobalTheme

      Theme getGlobalTheme()
      Get global theme

      Returns the globally assigned theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None Authentication - Required Scopes: [manage:confluence-configuration]

    • getGroupByGroupId

      Group getGroupByGroupId(@NotNull @NotNull String id)
      Get group

      Returns a user group for a given group id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      id - The id of the group. (required)

    • getGroupByName

      @Deprecated Group getGroupByName(@NotNull @NotNull String groupName)
      Veraltet.
      Get group

      Returns a user group for a given group name. Use updated Get group API **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

      Parameter:
      groupName - The name of the group. This is the same as the group name shown in the Confluence administration console. (required)

    • getGroupByQueryParam

      @Deprecated Group getGroupByQueryParam(@NotNull @NotNull String name)
      Veraltet.
      Get group

      Returns a user group for a given group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      name - The name of the group. This is the same as the group name shown in the Confluence administration console. (required)

    • getGroupMembers

      @Deprecated UserArray getGroupMembers(@NotNull @NotNull String groupName, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get group members

      Returns the users that are members of a group. Use updated Get group API **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

      Parameter:
      groupName - The name of the group to be queried for its members. (required)
      start - The starting index of the returned users. (optional, defaults to 0)
      limit - The maximum number of users to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • getGroupMembersByGroupId

      UserArray getGroupMembersByGroupId(@NotNull @NotNull String groupId, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean shouldReturnTotalSize, @Nullable @Nullable List<String> expand)
      Get group members

      Returns the users that are members of a group. Use updated Get group API **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      groupId - The id of the group to be queried for its members. (required)
      start - The starting index of the returned users. (optional, defaults to 0)
      limit - The maximum number of users to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)
      shouldReturnTotalSize - Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value. (optional, defaults to false)
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user. (optional)

    • getGroupMembershipsForUser

      GroupArrayWithLinks getGroupMembershipsForUser(@NotNull @NotNull String accountId, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get group memberships for user

      Returns the groups that a user is a member of. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-user]

      Parameter:
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (required)
      start - The starting index of the returned groups. (optional, defaults to 0)
      limit - The maximum number of groups to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • getGroups

      GroupArrayWithLinks getGroups(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable String accessType)
      Get groups

      Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      start - The starting index of the returned groups. (optional, defaults to 0)
      limit - The maximum number of groups to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)
      accessType - The group permission level for which to filter results. (optional)

    • getHistoryForContent

      @Deprecated ContentHistory getHistoryForContent(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get content history

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns the most recent update for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its history. (required)
      expand - 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. (optional)

    • getIndividualGroupRestrictionStatusByGroupId

      void getIndividualGroupRestrictionStatusByGroupId(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      Get content restriction status for group

      Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the 123456 group id, the following request will return true: /wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456 Note that a response of true does not guarantee that the group can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupId - The id of the group to be queried for whether the content restriction applies to it. (required)

    • getLabelsForContent

      @Deprecated LabelArray getLabelsForContent(@NotNull @NotNull String id, @Nullable @Nullable String prefix, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get labels for content

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns the labels on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space and permission to view the content if it is a page. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its labels. (required)
      prefix - Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by default when a user adds a label via the UI. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added. - team can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI. (optional)
      start - The starting index of the returned labels. (optional, defaults to 0)
      limit - The maximum number of labels to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • getLabelsForSpace

      LabelArray getLabelsForSpace(@NotNull @NotNull String spaceKey, @Nullable @Nullable String prefix, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get Space Labels

      Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels. Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to get labels for. (required)
      prefix - Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by labels that are on content within the provided space. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - team prefix is used for labels applied to the space. (optional)
      start - The starting index of the returned labels. (optional, defaults to 0)
      limit - The maximum number of labels to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • getLookAndFeelSettings

      LookAndFeelSettings getLookAndFeelSettings(@Nullable @Nullable String spaceKey)
      Get look and feel settings

      Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius. The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      spaceKey - The key of the space for which the look and feel settings will be returned. If this is not set, only the global look and feel settings are returned. (optional)

    • getMacroBodyByMacroId

      MacroInstance getMacroBodyByMacroId(@NotNull @NotNull String id, @NotNull @NotNull Integer version, @NotNull @NotNull String macroId)
      Get macro body by macro ID

      Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps. About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for it, unless an ID is specified (by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only modified by Confluence if there are conflicting IDs. Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and transparently propagate out to all instances. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID for the content that contains the macro. (required)
      version - The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version. (required)
      macroId - The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'. (required)

    • getMembersByQueryParam

      @Deprecated UserArray getMembersByQueryParam(@NotNull @NotNull String name, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean shouldReturnTotalSize, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get group members

      Returns the users that are members of a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      name - The name of the group to be queried for its members. (required)
      start - The starting index of the returned users. (optional, defaults to 0)
      limit - The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page. (optional, defaults to 200)
      shouldReturnTotalSize - Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value. (optional, defaults to false)
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user. (optional)

    • getModules

      ConnectModules getModules()
      Get modules

      Returns all modules registered dynamically by the calling app. **[Permissions](#permissions) required:** Only Connect apps can make this request.

    • getPrivacyUnsafeUserEmail

      AccountIdEmailRecord getPrivacyUnsafeUserEmail(@NotNull @NotNull String accountId)
      Get user email address

      Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

      Parameter:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required. (required)

    • getPrivacyUnsafeUserEmailBulk

      List<AccountIdEmailRecord> getPrivacyUnsafeUserEmailBulk(@NotNull @NotNull List<String> accountId)
      Get user email addresses in batch

      Returns user email addresses for a set of accountIds. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). Any accounts which are not available will not be included in the result. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

      Parameter:
      accountId - The account IDs of the users. (required)

    • getRelationship

      Relation getRelationship(@NotNull @NotNull String relationName, @NotNull @NotNull String sourceType, @NotNull @NotNull String sourceKey, @NotNull @NotNull String targetType, @NotNull @NotNull String targetKey, @Nullable @Nullable String sourceStatus, @Nullable @Nullable String targetStatus, @Nullable @Nullable Integer sourceVersion, @Nullable @Nullable Integer targetVersion, @Nullable @Nullable List<String> expand)
      Find relationship from source to target

      Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships are one way. For example, you can use this method to find whether the current user has selected a particular page as a favorite (i.e. 'save for later'): GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123 **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity and source entity. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      relationName - The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). (required)
      sourceType - The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'. (required)
      sourceKey - - The identifier for the source entity: - If sourceType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key. (required)
      targetType - The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'. (required)
      targetKey - The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType is 'space', then specify the space key. (required)
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'. (optional)
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'. (optional)
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'. (optional)
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'. (optional)
      expand - A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity. (optional)

    • getRestrictions

      ContentRestrictionArray getRestrictions(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get restrictions

      Returns the restrictions on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content to be queried for its restrictions. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: restrictions.user, restrictions.group. - restrictions.user returns the piece of content that the restrictions are applied to. - restrictions.group returns the piece of content that the restrictions are applied to. - content returns the piece of content that the restrictions are applied to. (optional)
      start - The starting index of the users and groups in the returned restrictions. (optional, defaults to 0)
      limit - The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 100)

    • getRestrictionsByOperation

      Map<String,GetRestrictionsByOperation200ResponseValue> getRestrictionsByOperation(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      Get restrictions by operation

      Returns restrictions on a piece of content by operation. This method is similar to [Get restrictions](#api-content-id-restriction-get) except that the operations are properties of the return object, rather than items in a results array. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content to be queried for its restrictions. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to. (optional)

    • getRestrictionsForOperation

      ContentRestriction getRestrictionsForOperation(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get restrictions for operation

      Returns the restictions on a piece of content for a given operation (read or update). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      id - The ID of the content to be queried for its restrictions. (required)
      operationKey - The operation type of the restrictions to be returned. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to. (optional)
      start - The starting index of the users and groups in the returned restrictions. (optional, defaults to 0)
      limit - The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 100)

    • getRetentionPeriod

      RetentionPeriod getRetentionPeriod()
      Get retention period

      Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [read:audit-log:confluence]

    • getSpace

      @Deprecated Space getSpace(@NotNull @NotNull String spaceKey, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get space

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns a space. This includes information like the name, description, and permissions, but not the content in the space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be returned. (required)
      expand - A multi-value parameter indicating which properties of the spaces to expand, where: - settings returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get). - metadata returns the space metadata. - metadata.labels returns the space labels, which are used to categorize the space. - operations returns the operations for a space, which are used when setting permissions. - lookAndFeel returns information about the look and feel of the space, including the color scheme. - permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions. - icon returns information about space icon. - description returns the description of the space. - description.plain returns the description of the space, the plain format. - description.view returns the description of the space, the view format. - theme returns information about the space theme. - homepage returns information about the space homepage. - history returns information about the history of the space. (optional)

    • getSpaceContentStates

      List<ContentState> getSpaceContentStates(@NotNull @NotNull String spaceKey)
      Get space suggested content states

      Get content states that are suggested in the space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space view permission Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its content state settings. (required)

    • getSpaceProperties

      @Deprecated SpacePropertyArray getSpaceProperties(@NotNull @NotNull String spaceKey, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get space properties

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all properties for the given space. Space properties are a key-value storage associated with a space. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space. Authentication - Required Scopes: [read:confluence-props]

      Parameter:
      spaceKey - The key of the space to be queried for its properties. (required)
      expand - A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded. - version returns information about the version of the content. - space returns the space that the properties are in. (optional)
      start - The starting index of the returned objects. (optional, defaults to 0)
      limit - The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 10)

    • getSpaceProperty

      @Deprecated SpaceProperty getSpaceProperty(@NotNull @NotNull String spaceKey, @NotNull @NotNull String key, @Nullable @Nullable List<String> expand)
      Veraltet.
      Get space property

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns a space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space. Authentication - Required Scopes: [read:confluence-props]

      Parameter:
      spaceKey - The key of the space that the property is in. (required)
      key - The key of the space property. (required)
      expand - A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded. - version returns information about the version of the content. - space returns the space that the properties are in. (optional)

    • getSpaceSettings

      SpaceSettings getSpaceSettings(@NotNull @NotNull String spaceKey)
      Get space settings

      Returns the settings of a space. Currently only the routeOverrideEnabled setting can be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its settings. (required)

    • getSpaceTheme

      Theme getSpaceTheme(@NotNull @NotNull String spaceKey)
      Get space theme

      Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space. Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be queried for its theme. (required)

    • getSpaces

      @Deprecated SpaceArray getSpaces(@Nullable @Nullable List<String> spaceKey, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable String type, @Nullable @Nullable String status, @Nullable @Nullable List<String> label, @Nullable @Nullable Boolean favourite, @Nullable @Nullable String favouriteUserKey, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Veraltet.
      Get spaces

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Note, the returned list will only contain spaces that the current user has permission to view. Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      spaceKey - The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values. (optional)
      spaceId - The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values. (optional)
      type - Filter the results to spaces based on their type. (optional)
      status - Filter the results to spaces based on their status. (optional)
      label - Filter the results to spaces based on their label. (optional)
      favourite - Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, 'favourite' spaces are also known as 'saved for later' spaces. (optional)
      favouriteUserKey - The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter. Leave blank for the current user. Use [Get user](#api-user-get) to get the userKey for a user. (optional)
      expand - A multi-value parameter indicating which properties of the spaces to expand, where: - settings returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get). - metadata returns the space metadata. - metadata.labels returns the space labels, which are used to categorize the space. - operations returns the operations for a space, which are used when setting permissions. - lookAndFeel returns information about the look and feel of the space, including the color scheme. - permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions. - icon returns information about space icon. - description returns the description of the space. - description.plain returns the description of the space, the plain format. - description.view returns the description of the space, the view format. - theme returns information about the space theme. - homepage returns information about the space homepage. - history returns information about the history of the space. (optional)
      start - The starting index of the returned spaces. (optional, defaults to 0)
      limit - The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • getSystemInfo

      SystemInfoEntity getSystemInfo()
      Get system info

      Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [manage:confluence-configuration]

    • getTask

      LongTaskStatusWithLinks getTask(@NotNull @NotNull String id)
      Get long-running task

      Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-space.summary]

      Parameter:
      id - The ID of the task. (required)

    • getTaskById

      @Deprecated Task getTaskById(@NotNull @NotNull String inlineTaskId)
      Veraltet.
      Get inline task based on global ID

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns inline task based on the global ID. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated with the task. Authentication - Required Scopes: [read:inlinetask:confluence]

      Parameter:
      inlineTaskId - Global ID of the inline task (required)

    • getTaskUpdate

      ContentStateBulkSetTaskUpdate getTaskUpdate(@NotNull @NotNull String taskId)
      Get update on long running task for setting of content state.

      Get Status of long running task that was previously created to set or remove content states from content. User must first create a task by passing in details to /wiki/rest/api/content-states PUT or DELETE endpoints. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Must have created long running task

      Parameter:
      taskId - taskId returned by put or delete requests to /wiki/rest/api/content-states (required)

    • getTasks

      LongTaskStatusArray getTasks(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get long-running tasks

      Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:content.metadata:confluence]

      Parameter:
      start - The starting index of the returned tasks. (optional, defaults to 0)
      limit - The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 100)

    • getTheme

      Theme getTheme(@NotNull @NotNull String themeKey)
      Get theme

      Returns a theme. This includes information about the theme name, description, and icon. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      themeKey - The key of the theme to be returned. (required)

    • getThemes

      ThemeArray getThemes(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get themes

      Returns all [admin-driven themes](https://developer.atlassian.com/cloud/confluence/create-a-confluence-theme/), not including the default theme. Note that this API only applies to themes set for an entire space or site by the admin. User-driven theming controls (Light, Dark, and match browser) are an unrelated feature. Admin-driven themes will override user-driven themes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      start - The starting index of the returned themes. (optional, defaults to 0)
      limit - The maximum number of themes to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 100)

    • getUser

      User getUser(@NotNull @NotNull String accountId, @Nullable @Nullable List<String> expand)
      Get user

      Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings. **Note:** to add, edit, or delete users in your organization, see the [user management REST API](/cloud/admin/user-management/about/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-user]

      Parameter:
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (required)
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user. (optional)

    • getUserProperties

      UserPropertyKeyArray getUserProperties(@NotNull @NotNull String userId, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get user properties

      Returns the properties for a user as list of property keys. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:user.property:confluence]

      Parameter:
      userId - The account ID of the user to be queried for its properties. (required)
      start - The starting index of the returned properties. (optional, defaults to 0)
      limit - The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 5)

    • getUserProperty

      UserProperty getUserProperty(@NotNull @NotNull String userId, @NotNull @NotNull String key)
      Get user property

      Returns the property corresponding to key for a user. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:user.property:confluence]

      Parameter:
      userId - The account ID of the user to be queried for its properties. (required)
      key - The key of the user property. (required)

    • getViewers

      GetViewers200Response getViewers(@NotNull @NotNull String contentId, @Nullable @Nullable String fromDate)
      Get viewers

      Get the total number of distinct viewers a piece of content has. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      contentId - The ID of the content to get the viewers for. (required)
      fromDate - The number of views for the content since the date. (optional)

    • getViews

      GetViews200Response getViews(@NotNull @NotNull String contentId, @Nullable @Nullable String fromDate)
      Get views

      Get the total number of views a piece of content has. Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      contentId - The ID of the content to get the views for. (required)
      fromDate - The number of views for the content since the date. (optional)

    • getWatchersForSpace

      SpaceWatchArray getWatchersForSpace(@NotNull @NotNull String spaceKey, @Nullable @Nullable String start, @Nullable @Nullable String limit)
      Get space watchers

      Returns a list of watchers of a space Authentication - Required Scopes: [read:watcher:confluence, read:user:confluence]

      Parameter:
      spaceKey - The key of the space to get watchers. (required)
      start - The start point of the collection to return. (optional)
      limit - The limit of the number of items to return, this may be restricted by fixed system limits. (optional)

    • getWatchesForPage

      WatchArray getWatchesForPage(@NotNull @NotNull String id, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get watches for page

      Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated. If you want to manage watches for a page, use the following user methods: - [Get content watch status for user](#api-user-watch-content-contentId-get) - [Add content watch](#api-user-watch-content-contentId-post) - [Remove content watch](#api-user-watch-content-contentId-delete) **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its watches. (required)
      start - The starting index of the returned watches. (optional, defaults to 0)
      limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • getWatchesForSpace

      SpaceWatchArray getWatchesForSpace(@NotNull @NotNull String id, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      Get watches for space

      Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated. If you want to manage watches for a space, use the following user methods: - [Get space watch status for user](#api-user-watch-space-spaceKey-get) - [Add space watch](#api-user-watch-space-spaceKey-post) - [Remove space watch](#api-user-watch-space-spaceKey-delete) **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      id - The ID of the content to be queried for its watches. (required)
      start - The starting index of the returned watches. (optional, defaults to 0)
      limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 200)

    • isWatchingLabel

      UserWatch isWatchingLabel(@NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Get label watch status

      Returns whether a user is watching a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      labelName - The name of the label to be queried for whether the specified user is watching it. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • isWatchingSpace

      UserWatch isWatchingSpace(@NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Get space watch status

      Returns whether a user is watching a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [read:confluence-content.summary]

      Parameter:
      spaceKey - The key of the space to be queried for whether the specified user is watching it. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • movePage

      MovePage200Response movePage(@NotNull @NotNull String pageId, @NotNull @NotNull String position, @NotNull @NotNull String targetId)
      Move a page to a new location relative to a target page

      Move a page to a new location relative to a target page: * before - move the page under the same parent as the target, before the target in the list of children * after - move the page under the same parent as the target, after the target in the list of children * append - move the page to be a child of the target Caution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI because they do not show up in the page tree display. To avoid this, never use before or after positions when the targetId is a top-level page. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      pageId - The ID of the page to be moved (required)
      position - The position to move the page to relative to the target page: * before - move the page under the same parent as the target, before the target in the list of children * after - move the page under the same parent as the target, after the target in the list of children * append - move the page to be a child of the target (required)
      targetId - The ID of the target page for this operation (required)

    • publishLegacyDraft

      Content publishLegacyDraft(@NotNull @NotNull String draftId, @NotNull @NotNull ContentBlueprintDraft body, @Nullable @Nullable String status, @Nullable @Nullable List<String> expand)
      Publish legacy draft

      Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of shared drafts. For now, this method works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put). By default, the following objects are expanded: body.storage, history, space, version, ancestors. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the draft and 'Add' permission for the space that the content will be created in. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      draftId - The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL. (required)
      body - (required)
      status - The status of the content to be updated, i.e. the draft. This is set to 'draft' by default, so you shouldn't need to specify it. (optional, defaults to draft)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)

    • publishSharedDraft

      Content publishSharedDraft(@NotNull @NotNull String draftId, @NotNull @NotNull ContentBlueprintDraft body, @Nullable @Nullable String status, @Nullable @Nullable List<String> expand)
      Publish shared draft

      Publishes a shared draft of a page created from a blueprint. By default, the following objects are expanded: body.storage, history, space, version, ancestors. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the draft and 'Add' permission for the space that the content will be created in. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      draftId - The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL. (required)
      body - (required)
      status - The status of the content to be updated, i.e. the draft. This is set to 'draft' by default, so you shouldn't need to specify it. (optional, defaults to draft)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)

    • registerModules

      void registerModules(@NotNull @NotNull ConnectModules body)
      Register modules

      Registers a list of modules. For the list of modules that support dynamic registration, see [Dynamic modules](https://developer.atlassian.com/cloud/confluence/dynamic-modules/). **[Permissions](#permissions) required:** Only Connect apps can make this request.

      Parameter:
      body - (required)

    • removeContentState

      ContentStateResponse removeContentState(@NotNull @NotNull String id, @Nullable @Nullable String status)
      Removes the content state of a content and publishes a new version.

      Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The Id of the content whose content state is to be set. (required)
      status - status of content state from which to delete state. Can be draft or archived (optional)

    • removeContentWatcher

      void removeContentWatcher(@NotNull @NotNull String xAtlassianToken, @NotNull @NotNull String contentId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Remove content watcher

      Removes a user as a watcher from a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection. (required)
      contentId - The ID of the content to remove the watcher from. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • removeGroup

      @Deprecated void removeGroup(@NotNull @NotNull String name)
      Veraltet.
      Delete user group

      Delete user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      name - Name of the group to delete. (required)

    • removeGroupById

      void removeGroupById(@NotNull @NotNull String id)
      Delete user group

      Delete user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      id - Id of the group to delete. (required)

    • removeGroupFromContentRestriction

      void removeGroupFromContentRestriction(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      Remove group from content restriction

      Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupId - The id of the group to remove from the content restriction. (required)

    • removeGroupFromContentRestrictionById

      @Deprecated void removeGroupFromContentRestrictionById(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupName)
      Veraltet.
      Remove group from content restriction

      Deprecated, use [Remove group from content restriction by groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-user-delete). Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      groupName - The name of the group to remove from the content restriction. (required)

    • removeLabelFromContent

      void removeLabelFromContent(@NotNull @NotNull String id, @NotNull @NotNull String label)
      Remove label from content

      Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove label from content using query parameter](#api-content-id-label-delete) except that the label name is specified via a path parameter. Use this method if the label name does not have "/" characters, as the path parameter does not accept "/" characters for security reasons. Otherwise, use [Remove label from content using query parameter](#api-content-id-label-delete). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the label will be removed from. (required)
      label - The name of the label to be removed. (required)

    • removeLabelFromContentUsingQueryParameter

      void removeLabelFromContentUsingQueryParameter(@NotNull @NotNull String id, @NotNull @NotNull String name)
      Remove label from content using query parameter

      Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove label from content](#api-content-id-label-label-delete) except that the label name is specified via a query parameter. Use this method if the label name has "/" characters, as [Remove label from content using query parameter](#api-content-id-label-delete) does not accept "/" characters for the label name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the label will be removed from. (required)
      name - The name of the label to be removed. (required)

    • removeLabelWatcher

      void removeLabelWatcher(@NotNull @NotNull String labelName, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Remove label watcher

      Removes a user as a watcher from a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      labelName - The name of the label to remove the watcher from. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • removeMemberFromGroup

      @Deprecated void removeMemberFromGroup(@NotNull @NotNull String name, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Veraltet.
      Remove member from group

      Remove user as a member from a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      name - Name of the group whose membership is updated. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • removeMemberFromGroupByGroupId

      void removeMemberFromGroupByGroupId(@NotNull @NotNull String groupId, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Remove member from group using group id

      Remove user as a member from a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin. Authentication - Required Scopes: [write:confluence-groups]

      Parameter:
      groupId - Id of the group whose membership is updated. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • removeModules

      void removeModules(@NotNull @NotNull List<String> moduleKey)
      Remove modules

      Remove all or a list of modules registered by the calling app. **[Permissions](#permissions) required:** Only Connect apps can make this request.

      Parameter:
      moduleKey - The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&amp;moduleKey=dynamic-select-field. Nonexistent keys are ignored. (required)

    • removePermission

      void removePermission(@NotNull @NotNull String spaceKey, @NotNull @NotNull Integer id)
      Remove a space permission

      Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space permissions for that user or group. Note: Apps cannot access this REST resource - including when utilizing user impersonation. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:space.permission:confluence]

      Parameter:
      spaceKey - The key of the space to be queried for its content. (required)
      id - Id of the permission to be deleted. (required)

    • removeSpaceWatch

      void removeSpaceWatch(@NotNull @NotNull String spaceKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Remove space watch

      Removes a user as a watcher from a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the accountId to identify the user. - Do not specify a user: The currently logged-in user will be used. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      spaceKey - The key of the space to remove the watcher from. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • removeTemplate

      void removeTemplate(@NotNull @NotNull String contentTemplateId)
      Remove template

      Deletes a template. This results in different actions depending on the type of template: - If the template is a content template, it is deleted. - If the template is a modified space-level blueprint template, it reverts to the template inherited from the global-level blueprint template. - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template. Note, unmodified blueprint templates cannot be deleted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a space template or 'Confluence Administrator' global permission to delete a global template. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      contentTemplateId - The ID of the template to be deleted. (required)

    • removeUserFromContentRestriction

      void removeUserFromContentRestriction(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Remove user from content restriction

      Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content that the restriction applies to. (required)
      operationKey - The operation that the restriction applies to. (required)
      key - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. (optional)

    • resetLookAndFeelSettings

      void resetLookAndFeelSettings(@Nullable @Nullable String spaceKey)
      Reset look and feel settings

      Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      spaceKey - The key of the space for which the look and feel settings will be reset. If this is not set, the global look and feel settings will be reset. (optional)

    • resetSpaceTheme

      void resetSpaceTheme(@NotNull @NotNull String spaceKey)
      Reset space theme

      Resets the space theme. This means that the space will inherit the global look and feel settings **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space to reset the theme for. (required)

    • restoreContentVersion

      Version restoreContentVersion(@NotNull @NotNull String id, @NotNull @NotNull VersionRestore body, @Nullable @Nullable List<String> expand)
      Restore content version

      Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content for which the history will be restored. (required)
      body - The content version to be restored. (required)
      expand - A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded. - collaborators returns the users that collaborated on the version. - content returns the content for the version. (optional)

    • searchByCQL

      SearchPageResponseSearchResult searchByCQL(@NotNull @NotNull String cql, @Nullable @Nullable String cqlcontext, @Nullable @Nullable String cursor, @Nullable @Nullable Boolean next, @Nullable @Nullable Boolean prev, @Nullable @Nullable Integer limit, @Nullable @Nullable Integer start, @Nullable @Nullable Boolean includeArchivedSpaces, @Nullable @Nullable Boolean excludeCurrentSpaces, @Nullable @Nullable String excerpt, @Nullable @Nullable String sitePermissionTypeFilter, @Nullable @Nullable Long _u, @Nullable @Nullable List<String> expand)
      Search content

      Searches for content using the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). **Note that CQL input queries submitted through the /wiki/rest/api/search endpoint no longer support user-specific fields like user, user.fullname, user.accountid, and user.userkey.** See this [deprecation notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/) for more details. Example initial call: /wiki/rest/api/search?cql=type=page&amp;limit=25 Example response: ` { "results": [ { ... }, { ... }, ... { ... } ], "limit": 25, "size": 25, ... "_links": { "base": "&lt;url&gt;", "context": "&lt;url&gt;", "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg", "self": "&lt;url&gt;" } } ` When additional results are available, returns next and prev URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use limit to specify the number of results returned in each call. Example subsequent call (taken from example response): /wiki/rest/api/search?cql=type=page&amp;limit=25&amp;cursor=raNDoMsTRiNg The response to this will have a prev URL similar to the next in the example response. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only entities that the user has permission to view will be returned. Authentication - Required Scopes: [search:confluence]

      Parameter:
      cql - The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query. (required)
      cqlcontext - The space, content, and content status to execute the search against. - spaceKey Key of the space to search against. Optional. - contentId ID of the content to search against. Optional. Must be in the space specified by spaceKey. - contentStatuses Content statuses to search against. Optional. Specify these values in an object. For example, cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22} (optional)
      cursor - Pointer to a set of search results, returned as part of the next or prev URL from the previous search call. (optional)
      next - (optional, defaults to false)
      prev - (optional, defaults to false)
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      start - The start point of the collection to return (optional, defaults to 0)
      includeArchivedSpaces - Whether to include content from archived spaces in the results. (optional, defaults to false)
      excludeCurrentSpaces - Whether to exclude current spaces and only show archived spaces. (optional, defaults to false)
      excerpt - The excerpt strategy to apply to the result (optional, defaults to highlight)
      sitePermissionTypeFilter - Filters users by permission type. Use none to default to licensed users, externalCollaborator for external/guest users, and all to include all permission types. (optional, defaults to none)
      _u - (optional)
      expand - (optional)

    • searchContentByCQL

      ContentArray searchContentByCQL(@NotNull @NotNull String cql, @Nullable @Nullable String cqlcontext, @Nullable @Nullable List<String> expand, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit)
      Search content by CQL

      Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: [Advanced searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). Example initial call: /wiki/rest/api/content/search?cql=type=page&amp;limit=25 Example response: ` { "results": [ { ... }, { ... }, ... { ... } ], "limit": 25, "size": 25, ... "_links": { "base": "&lt;url&gt;", "context": "&lt;url&gt;", "next": "/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg", "self": "&lt;url&gt;" } } ` When additional results are available, returns next and prev URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use limit to specify the number of results returned in each call. Example subsequent call (taken from example response): /wiki/rest/api/content/search?cql=type=page&amp;limit=25&amp;cursor=raNDoMsTRiNg The response to this will have a prev URL similar to the next in the example response. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned. Authentication - Required Scopes: [search:confluence]

      Parameter:
      cql - The CQL string that is used to find the requested content. (required)
      cqlcontext - 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. (optional)
      expand - A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. (optional)
      cursor - Pointer to a set of search results, returned as part of the next or prev URL from the previous search call. (optional)
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)

    • searchGroups

      GroupArrayWithLinks searchGroups(@NotNull @NotNull String query, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean shouldReturnTotalSize)
      Search groups by partial query

      Get search results of groups by partial query provided. Authentication - Required Scopes: [read:confluence-groups]

      Parameter:
      query - the search term used to query results. (required)
      start - The starting index of the returned groups. (optional, defaults to 0)
      limit - The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups. (optional, defaults to 200)
      shouldReturnTotalSize - Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value. (optional, defaults to false)

    • searchTasks

      @Deprecated TaskPageResponse searchTasks(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable String spaceKey, @Nullable @Nullable String pageId, @Nullable @Nullable String assignee, @Nullable @Nullable String creator, @Nullable @Nullable String completedUser, @Nullable @Nullable Long duedateFrom, @Nullable @Nullable Long duedateTo, @Nullable @Nullable Long createdateFrom, @Nullable @Nullable Long createdateTo, @Nullable @Nullable Long completedateFrom, @Nullable @Nullable Long completedateTo, @Nullable @Nullable String status)
      Veraltet.
      Get inline tasks based on search parameters

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Returns inline tasks based on the search query. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only tasks in contents that the user has permission to view are returned. Authentication - Required Scopes: [read:confluence-content.all]

      Parameter:
      start - The starting offset for the results. (optional, defaults to 0)
      limit - The number of results to be returned. (optional, defaults to 20)
      spaceKey - The space key of a space. Multiple space keys can be specified. (optional)
      pageId - The page id of a page. Multiple page ids can be specified. (optional)
      assignee - Account ID of a user to whom a task is assigned. Multiple users can be specified. (optional)
      creator - Account ID of a user to who created a task. Multiple users can be specified. (optional)
      completedUser - Account ID of a user who completed a task. Multiple users can be specified. (optional)
      duedateFrom - Start of date range based on due dates (inclusive). (optional)
      duedateTo - End of date range based on due dates (inclusive). (optional)
      createdateFrom - Start of date range based on create dates (inclusive). (optional)
      createdateTo - End of date range based on create dates (inclusive). (optional)
      completedateFrom - Start of date range based on complete dates (inclusive). (optional)
      completedateTo - End of date range based on complete dates (inclusive). (optional)
      status - The status of the task. (checked/unchecked) (optional)

    • searchUser

      SearchPageResponseSearchResult searchUser(@NotNull @NotNull String cql, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable List<String> expand, @Nullable @Nullable String sitePermissionTypeFilter)
      Search users

      Searches for users using user-specific queries from the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). Note that CQL input queries submitted through the /wiki/rest/api/search/user endpoint only support user-specific fields like user, user.fullname, user.accountid, and user.userkey. Note that some user fields may be set to null depending on the user's privacy settings. These are: email, profilePicture, displayName, and timeZone. Authentication - Required Scopes: [read:content-details:confluence]

      Parameter:
      cql - The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query. Example queries: cql=type=user will return all users cql=user="1234" will return user with accountId "1234" You can also use IN, NOT IN, != operators cql=user IN ("12", "34") will return users with accountids "12" and "34" cql=user.fullname~jo will return users with nickname/full name starting with "jo" cql=user.accountid="123" will return user with accountId "123" (required)
      start - The starting index of the returned users. (optional, defaults to 0)
      limit - The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits. (optional, defaults to 25)
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations for the user, which are used when setting permissions. - personalSpace returns the personal space of the user. (optional)
      sitePermissionTypeFilter - Filters users by permission type. Use none to default to licensed users, externalCollaborator for external/guest users, and all to include all permission types. (optional, defaults to none)

    • setContentState

      ContentStateResponse setContentState(@NotNull @NotNull String id, @NotNull @NotNull ContentStateRestInput contentStateRestInput, @Nullable @Nullable String status)
      Set the content state of a content and publishes a new version of the content.

      Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state. You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id will be used. If the name and color passed in already exist under the current user's existing custom states, the existing state will be reused. If custom states are disabled in the space of the content (which can be determined by getting the content state space settings of the content's space) then this set will fail. You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is required in the body of this request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The Id of the content whose content state is to be set. (required)
      contentStateRestInput - Content state fields for state. Pass in id for an existing state, or new name and color for best matching existing state, or new state if allowed in space. (required)
      status - Status of content onto which state will be placed. If draft, then draft state will change. If current, state will be placed onto a new version of the content with same body as previous version. (optional)

    • setLookAndFeelSettings

      @Deprecated String setLookAndFeelSettings(@NotNull @NotNull String body, @Nullable @Nullable String spaceKey)
      Veraltet.
      Set look and feel settings

      Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      body - The look and feel type to be set. (required)
      spaceKey - The key of the space for which the look and feel settings will be set. If this is not set, the global look and feel settings will be set. (optional)

    • setRetentionPeriod

      RetentionPeriod setRetentionPeriod(@NotNull @NotNull RetentionPeriod body)
      Set retention period

      Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission. Authentication - Required Scopes: [write:audit-log:confluence]

      Parameter:
      body - The updated retention period. (required)

    • setSpaceTheme

      Theme setSpaceTheme(@NotNull @NotNull String spaceKey, @NotNull @NotNull ThemeUpdate body)
      Set space theme

      Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space to set the theme for. (required)
      body - (required)

    • updateAttachmentData

      Content updateAttachmentData(@NotNull @NotNull String id, @NotNull @NotNull String attachmentId, @NotNull @NotNull File _file, @NotNull @NotNull File minorEdit, @Nullable @Nullable File comment)
      Update attachment data

      Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field. This method is essentially the same as [Create or update attachments](#api-content-id-child-attachment-put), except that it matches the attachment ID rather than the name. Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data. The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client libraries have classes that make it easier to implement multipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class provided by Apache HTTP Components. Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is text, the charset parameter for the "text/plain" Content-Type may be used to indicate the character encoding used in that part. In the case of this API endpoint, the comment body parameter should be sent with type=text/plain and charset=utf-8 values. This will force the charset to be UTF-8. Example: This curl command updates an attachment (id='att456') that is attached to a piece of content (id='123') with a comment and minorEdits=true. ` bash curl -D- \\ -u admin:admin \\ -X POST \\ -H 'X-Atlassian-Token: nocheck' \\ -F 'file=@"example.txt"' \\ -F 'minorEdit="true"' \\ -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \\ http://myhost/rest/api/content/123/child/attachment/att456/data ` **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-file]

      Parameter:
      id - The ID of the content that the attachment is attached to. (required)
      attachmentId - The ID of the attachment to update. (required)
      _file - The relative location and name of the attachment to be added to the content. (required)
      minorEdit - If minorEdits is set to 'true', no notification email or activity stream will be generated when the attachment is added to the content. (required)
      comment - The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don't specify any comments. (optional)

    • updateAttachmentProperties

      Content updateAttachmentProperties(@NotNull @NotNull String id, @NotNull @NotNull String attachmentId, @NotNull @NotNull AttachmentPropertiesUpdateBody body)
      Update attachment properties

      Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type, comment, and parent container. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-file, write:confluence-props]

      Parameter:
      id - The ID of the content that the attachment is attached to. (required)
      attachmentId - The ID of the attachment to update. (required)
      body - The details of the attachment to be updated. (required)

    • updateContent

      @Deprecated Content updateContent(@NotNull @NotNull String id, @NotNull @NotNull ContentUpdate content, @Nullable @Nullable String status, @Nullable @Nullable String conflictPolicy)
      Veraltet.
      Update content

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Updates a piece of content. Use this method to update the title or body of a piece of content, change the status, change the parent page, and more. Note, updating draft content is currently not supported. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content to be updated. (required)
      content - The updated content. (required)
      status - The updated status of the content. Use this parameter to change the status of a piece of content without passing the entire request body. (optional, defaults to current)
      conflictPolicy - The action that should be taken when conflicts are discovered. Only used when publishing a draft page. (optional, defaults to abort)

    • updateContentProperty

      @Deprecated ContentProperty updateContentProperty(@NotNull @NotNull String id, @NotNull @NotNull String key, @NotNull @NotNull ContentPropertyUpdate body)
      Veraltet.
      Update content property

      Updates an existing content property. This method will also create a new property for a piece of content, if the property key does not exist and the property version is 1. For more information about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      id - The ID of the content that the property belongs to. (required)
      key - The key of the property. (required)
      body - The content property being updated. (required)

    • updateContentTemplate

      ContentTemplate updateContentTemplate(@NotNull @NotNull ContentTemplateUpdate body)
      Update content template

      Updates a content template. Note, blueprint templates cannot be updated via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a space template or 'Confluence Administrator' global permission to update a global template. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      body - The updated content template. (required)

    • updateLookAndFeel

      LookAndFeelSelection updateLookAndFeel(@NotNull @NotNull LookAndFeelSelection body)
      Select look and feel settings

      Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's settings for a space. The custom and theme settings can only be selected if there is already a theme set for a space. Note, the default space settings are inherited from the current global settings. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      body - The look and feel type to be set. (required)

    • updateLookAndFeelSettings

      LookAndFeelWithLinks updateLookAndFeelSettings(@NotNull @NotNull LookAndFeel body, @Nullable @Nullable String spaceKey)
      Update look and feel settings

      Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created. Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [manage:confluence-configuration]

      Parameter:
      body - The updated settings. All values for the settings must be included, regardless of whether they are being changed. One way to create the request body is to copy the settings from the response body of [Get look and feel settings](#api-settings-lookandfeel-get) and modify it as needed. (required)
      spaceKey - The key of the space for which the look and feel settings will be updated. If this is not set, the global look and feel settings will be updated. (optional)

    • updateRestrictions

      ContentRestrictionArray updateRestrictions(@NotNull @NotNull String id, @NotNull @NotNull ContentRestrictionAddOrUpdateArray body, @Nullable @Nullable List<String> expand)
      Update restrictions

      Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content. Authentication - Required Scopes: [write:confluence-content]

      Parameter:
      id - The ID of the content to update restrictions for. (required)
      body - The updated restrictions for the content. (required)
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to. (optional)

    • updateSpace

      Space updateSpace(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpaceUpdate body)
      Update space

      Updates the name, description, or homepage of a space. - For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead. - Currently you cannot set space labels when updating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space to update. (required)
      body - The updated space. (required)

    • updateSpaceProperty

      @Deprecated SpaceProperty updateSpaceProperty(@NotNull @NotNull String spaceKey, @NotNull @NotNull String key, @NotNull @NotNull SpacePropertyUpdate body)
      Veraltet.
      Update space property

      Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/). Updates a space property. Note, you cannot update the key of a space property, only the value. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space. Authentication - Required Scopes: [write:confluence-props]

      Parameter:
      spaceKey - The key of the space that the property is in. (required)
      key - The key of the property to be updated. (required)
      body - The space property being updated. (required)

    • updateSpaceSettings

      SpaceSettings updateSpaceSettings(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpaceSettingsUpdate spaceSettingsUpdate)
      Update space settings

      Updates the settings for a space. Currently only the routeOverrideEnabled setting can be updated. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space. Authentication - Required Scopes: [write:confluence-space]

      Parameter:
      spaceKey - The key of the space whose settings will be updated. (required)
      spaceSettingsUpdate - The space settings to update. (required)

    • updateTaskById

      @Deprecated Task updateTaskById(@NotNull @NotNull String inlineTaskId, @NotNull @NotNull TaskStatusUpdate taskStatusUpdate)
      Veraltet.
      Update inline task given global ID

      Updates an inline tasks status given its global ID **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated with the task. Authentication - Required Scopes: [read:inlinetask:confluence, write:inlinetask:confluence]

      Parameter:
      inlineTaskId - Global ID of the inline task to update (required)
      taskStatusUpdate - The updated task status. (required)

    • updateUserProperty

      void updateUserProperty(@NotNull @NotNull String userId, @NotNull @NotNull String key, @NotNull @NotNull UserPropertyUpdate body)
      Update user property

      Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Authentication - Required Scopes: [write:user.property:confluence]

      Parameter:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 (required)
      key - The key of the user property. (required)
      body - The user property to be updated. (required)