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

Interface ConfluenceRestClientApi

@Generated("io.github.primelib.primecodegen")
public interface ConfluenceRestClientApi

Method Summary

Modifier and Type	Method	Description
void	deleteAtlassianConnect1AppModuleDynamicV1(@NonNull List<String> moduleKey)	DeleteAtlassianConnect1AppModuleDynamicV1 Remove modules Remove all or a list of modules registered by the calling app.
void	deleteContentByIdlabelByLabelV1(@NonNull String id, @NonNull String label)	DeleteContentByIDLabelByLabelV1 Remove label from content Removes a label from a piece of content.
void	deleteContentByIdlabelV1(@NonNull String id, @NonNull String name)	DeleteContentByIDLabelV1 Remove label from content using query parameter Removes a label from a piece of content.
void	deleteContentByIdpageTreeV1(@NonNull String id)	DeleteContentByIDPageTreeV1 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.
void	deleteContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id, @NonNull String operationKey, @NonNull String groupId)	DeleteContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Remove group from content restriction Removes a group from a content restriction.
void	deleteContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id, @NonNull String operationKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	DeleteContentByIDRestrictionByOperationByOperationKeyUserV1 Remove user from content restriction Removes a group from a content restriction.
ContentRestrictionArray	deleteContentByIdrestrictionV1(@NonNull String id, @Nullable List<String> expand)	DeleteContentByIDRestrictionV1 Delete restrictions Removes all restrictions (read and update) on a piece of content.
ContentStateResponse	deleteContentByIdstateV1(@NonNull String id, @Nullable String status)	DeleteContentByIDStateV1 Removes the content state of a content and publishes a new version.
void	deleteContentByIdversionByVersionNumberV1(@NonNull String id, @NonNull Integer versionNumber)	DeleteContentByIDVersionByVersionNumberV1 Delete content version Delete a historical version.
void	deleteGroupByIdv1(@NonNull String id)	DeleteGroupByIDV1 Delete user group Delete user group.
void	deleteGroupUserByGroupIdv1(@NonNull String groupId, @NonNull String accountId, @Nullable String key, @Nullable String username)	DeleteGroupUserByGroupIDV1 Remove member from group using group id Remove user as a member from a group.
void	deleteRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName, @NonNull String sourceType, @NonNull String sourceKey, @NonNull String targetType, @NonNull String targetKey, @Nullable String sourceStatus, @Nullable String targetStatus, @Nullable Integer sourceVersion, @Nullable Integer targetVersion)	DeleteRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 Delete relationship Deletes a relationship between two entities (user, space, content).
void	deleteSettingsLookandfeelCustomV1(@Nullable String spaceKey)	DeleteSettingsLookandfeelCustomV1 Reset look and feel settings Resets the custom look and feel settings for the site or a single space.
void	deleteSpaceBySpaceKeyLabelV1(@NonNull String spaceKey, @NonNull String name, @Nullable String prefix)	DeleteSpaceBySpaceKeyLabelV1 Remove label from a space
void	deleteSpaceBySpaceKeyPermissionByIdv1(@NonNull String spaceKey, @NonNull Long id)	DeleteSpaceBySpaceKeyPermissionByIDV1 Remove a space permission Removes a space permission.
void	deleteSpaceBySpaceKeyThemeV1(@NonNull String spaceKey)	DeleteSpaceBySpaceKeyThemeV1 Reset space theme Resets the space theme.
void	deleteSpaceBySpaceKeyV1(@NonNull String spaceKey)	DeleteSpaceBySpaceKeyV1 Delete space Permanently deletes a space without sending it to the trash.
void	deleteTemplateByContentTemplateIdv1(@NonNull String contentTemplateId)	DeleteTemplateByContentTemplateIDV1 Remove template Deletes a template.
void	deleteUserByUserIdpropertyByKeyV1(@NonNull String userId, @NonNull String key)	DeleteUserByUserIDPropertyByKeyV1 Delete user property Deletes a property for the given user.
void	deleteUserWatchContentByContentIdv1(@NonNull String xAtlassianToken, @NonNull String contentId, @Nullable String key, @Nullable String username, @Nullable String accountId)	DeleteUserWatchContentByContentIDV1 Remove content watcher Removes a user as a watcher from a piece of content.
void	deleteUserWatchLabelByLabelNameV1(@NonNull String labelName, @Nullable String key, @Nullable String username, @Nullable String accountId)	DeleteUserWatchLabelByLabelNameV1 Remove label watcher Removes a user as a watcher from a label.
void	deleteUserWatchSpaceBySpaceKeyV1(@NonNull String spaceKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	DeleteUserWatchSpaceBySpaceKeyV1 Remove space watch Removes a user as a watcher from a space.
GetViewersR200	getAnalyticsContentByContentIdviewersV1(@NonNull String contentId, @Nullable String fromDate)	GetAnalyticsContentByContentIDViewersV1 Get viewers Get the total number of distinct viewers a piece of content has.
GetViewsR200	getAnalyticsContentByContentIdviewsV1(@NonNull String contentId, @Nullable String fromDate)	GetAnalyticsContentByContentIDViewsV1 Get views Get the total number of views a piece of content has.
ConnectModules	getAtlassianConnect1AppModuleDynamicV1()	GetAtlassianConnect1AppModuleDynamicV1 Get modules Returns all modules registered dynamically by the calling app.
Byte[]	getAuditExportV1(@Nullable String startDate, @Nullable String endDate, @Nullable String searchString, @Nullable String format)	GetAuditExportV1 Export audit records Exports audit records as a CSV file or ZIP file.
RetentionPeriod	getAuditRetentionV1()	GetAuditRetentionV1 Get retention period Returns the retention period for records in the audit log.
AuditRecordArray	getAuditSinceV1(@Nullable Long number, @Nullable String units, @Nullable String searchString, @Nullable Integer start, @Nullable Integer limit)	GetAuditSinceV1 Get audit records for time period Returns records from the audit log, for a time period back from the current date.
AuditRecordArray	getAuditV1(@Nullable String startDate, @Nullable String endDate, @Nullable String searchString, @Nullable Integer start, @Nullable Integer limit)	GetAuditV1 Get audit records Returns all records in the audit log, optionally for a certain date range.
List<AsyncContentBody>	getContentbodyConvertAsyncBulkTasksV1(@NonNull List<String> ids)	GetContentbodyConvertAsyncBulkTasksV1 Get asynchronous content body conversion task result in bulk Returns the content body for the corresponding `asyncId` of a completed conversion task.
AsyncContentBody	getContentbodyConvertAsyncByIdv1(@NonNull String id)	GetContentbodyConvertAsyncByIDV1 Get asynchronously converted content body from the id or the current status of the task.
void	getContentByIdchildAttachmentByAttachmentIddownloadV1(@NonNull String id, @NonNull String attachmentId, @Nullable Long version, @Nullable List<String> status)	GetContentByIDChildAttachmentByAttachmentIDDownloadV1 Get URI to download attachment Redirects the client to a URL that serves an attachment's binary data.
ContentArray	getContentByIddescendantByTypeV1(@NonNull String id, @NonNull String type, @Nullable String depth, @Nullable List<String> expand, @Nullable Integer start, @Nullable Integer limit)	Deprecated.
Map<String,Object>	getContentByIddescendantV1(@NonNull String id, @Nullable List<String> expand)	Deprecated.
AsyncId	getContentByIdhistoryByVersionMacroIdbyMacroIdconvertAsyncByToV1(@NonNull String id, @NonNull Integer version, @NonNull String macroId, @NonNull String to, @Nullable List<String> expand, @Nullable Boolean allowCache, @Nullable String spaceKeyContext, @Nullable String embeddedContentRender)	GetContentByIDHistoryByVersionMacroIDByMacroIDConvertAsyncByToV1 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.
ContentBody	getContentByIdhistoryByVersionMacroIdbyMacroIdconvertByToV1(@NonNull String id, @NonNull Integer version, @NonNull String macroId, @NonNull String to, @Nullable List<String> expand, @Nullable String spaceKeyContext, @Nullable String embeddedContentRender)	GetContentByIDHistoryByVersionMacroIDByMacroIDConvertByToV1 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.
MacroInstance	getContentByIdhistoryByVersionMacroIdbyMacroIdv1(@NonNull String id, @NonNull Integer version, @NonNull String macroId)	GetContentByIDHistoryByVersionMacroIDByMacroIDV1 Get macro body by macro ID Returns the body of a macro in storage format, for the given macro ID.
WatchArray	getContentByIdnotificationChildCreatedV1(@NonNull String id, @Nullable Integer start, @Nullable Integer limit)	GetContentByIDNotificationChildCreatedV1 Get watches for page Returns the watches for a page.
SpaceWatchArray	getContentByIdnotificationCreatedV1(@NonNull String id, @Nullable Integer start, @Nullable Integer limit)	GetContentByIDNotificationCreatedV1 Get watches for space Returns all space watches for the space that the content is in.
void	getContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id, @NonNull String operationKey, @NonNull String groupId)	GetContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Get content restriction status for group Returns whether the specified content restriction applies to a group.
void	getContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id, @NonNull String operationKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	GetContentByIDRestrictionByOperationByOperationKeyUserV1 Get content restriction status for user Returns whether the specified content restriction applies to a user.
ContentRestriction	getContentByIdrestrictionByOperationByOperationKeyV1(@NonNull String id, @NonNull String operationKey, @Nullable List<String> expand, @Nullable Integer start, @Nullable Integer limit)	GetContentByIDRestrictionByOperationByOperationKeyV1 Get restrictions for operation Returns the restictions on a piece of content for a given operation (read or update).
GetRestrictionsByOperation	getContentByIdrestrictionByOperationV1(@NonNull String id, @Nullable List<String> expand)	GetContentByIDRestrictionByOperationV1 Get restrictions by operation Returns restrictions on a piece of content by operation.
ContentRestrictionArray	getContentByIdrestrictionV1(@NonNull String id, @Nullable List<String> expand, @Nullable Integer start, @Nullable Integer limit)	GetContentByIDRestrictionV1 Get restrictions Returns the restrictions on a piece of content.
AvailableContentStates	getContentByIdstateAvailableV1(@NonNull String id)	GetContentByIDStateAvailableV1 Gets available content states for content.
ContentStateResponse	getContentByIdstateV1(@NonNull String id, @Nullable String status)	GetContentByIDStateV1 Get content state Gets the current content state of the draft or current version of content.
ContentArray	getContentSearchV1(@NonNull String cql, @Nullable String cqlcontext, @Nullable List<String> expand, @Nullable String cursor, @Nullable Integer limit)	GetContentSearchV1 Search content by CQL Returns the list of content that matches a Confluence Query Language (CQL) query.
List<ContentState>	getContentStatesV1()	GetContentStatesV1 Get Custom Content States Get custom content states that authenticated user has created.
UserArray	getGroupByGroupIdmembersByGroupIdv1(@NonNull String groupId, @Nullable Integer start, @Nullable Integer limit, @Nullable Boolean shouldReturnTotalSize, @Nullable List<String> expand)	GetGroupByGroupIDMembersByGroupIDV1 Get group members Returns the users that are members of a group.
Group	getGroupByIdv1(@NonNull String id)	GetGroupByIDV1 Get group Returns a user group for a given group id.
GroupArrayWithLinks	getGroupPickerV1(@NonNull String query, @Nullable Integer start, @Nullable Integer limit, @Nullable Boolean shouldReturnTotalSize)	GetGroupPickerV1 Search groups by partial query Get search results of groups by partial query provided.
GroupArrayWithLinks	getGroupV1(@Nullable Integer start, @Nullable Integer limit, @Nullable String accessType)	GetGroupV1 Get groups Returns all user groups.
LabelDetails	getLabelV1(@NonNull String name, @Nullable String type, @Nullable Integer start, @Nullable Integer limit)	GetLabelV1 Get label information Returns label information and a list of contents associated with the label.
LongTaskStatusWithLinks	getLongtaskByIdv1(@NonNull String id)	GetLongtaskByIDV1 Get long-running task Returns information about an active long-running task (e.g.
LongTaskStatusArray	getLongtaskV1(@Nullable String key, @Nullable Integer start, @Nullable Integer limit)	GetLongtaskV1 Get long-running tasks Returns information about all active long-running tasks (e.g.
Relation	getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName, @NonNull String sourceType, @NonNull String sourceKey, @NonNull String targetType, @NonNull String targetKey, @Nullable String sourceStatus, @Nullable String targetStatus, @Nullable Integer sourceVersion, @Nullable Integer targetVersion, @Nullable List<String> expand)	GetRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 Find relationship from source to target Find whether a particular type of relationship exists from a source entity to a target entity.
RelationArray	getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeV1(@NonNull String relationName, @NonNull String sourceType, @NonNull String sourceKey, @NonNull String targetType, @Nullable String sourceStatus, @Nullable String targetStatus, @Nullable Integer sourceVersion, @Nullable Integer targetVersion, @Nullable List<String> expand, @Nullable Integer start, @Nullable Integer limit)	GetRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeV1 Find target entities related to a source entity Returns all target entities that have a particular relationship to the source entity.
RelationArray	getRelationByRelationNameToByTargetTypeByTargetKeyFromBySourceTypeV1(@NonNull String relationName, @NonNull String sourceType, @NonNull String targetType, @NonNull String targetKey, @Nullable String sourceStatus, @Nullable String targetStatus, @Nullable Integer sourceVersion, @Nullable Integer targetVersion, @Nullable List<String> expand, @Nullable Integer start, @Nullable Integer limit)	GetRelationByRelationNameToByTargetTypeByTargetKeyFromBySourceTypeV1 Find source entities related to a target entity Returns all target entities that have a particular relationship to the source entity.
SearchPageResponseSearchResult	getSearchUserV1(@NonNull String cql, @Nullable Integer start, @Nullable Integer limit, @Nullable List<String> expand, @Nullable String sitePermissionTypeFilter)	GetSearchUserV1 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/).
SearchPageResponseSearchResult	getSearchV1(@NonNull String cql, @Nullable String cqlcontext, @Nullable String cursor, @Nullable Boolean next, @Nullable Boolean prev, @Nullable Integer limit, @Nullable Integer start, @Nullable Boolean includeArchivedSpaces, @Nullable Boolean excludeCurrentSpaces, @Nullable String excerpt, @Nullable String sitePermissionTypeFilter, @Nullable List<String> expand)	GetSearchV1 Search content Searches for content using the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
LookAndFeelSettings	getSettingsLookandfeelV1(@Nullable String spaceKey)	GetSettingsLookandfeelV1 Get look and feel settings Returns the look and feel settings for the site or a single space.
SystemInfoEntity	getSettingsSystemInfoV1()	GetSettingsSystemInfoV1 Get system info Returns the system information for the Confluence Cloud tenant.
Theme	getSettingsThemeByThemeKeyV1(@NonNull String themeKey)	GetSettingsThemeByThemeKeyV1 Get theme Returns a theme.
Theme	getSettingsThemeSelectedV1()	GetSettingsThemeSelectedV1 Get global theme Returns the globally assigned theme.
ThemeArray	getSettingsThemeV1(@Nullable Integer start, @Nullable Integer limit)	GetSettingsThemeV1 Get themes Returns all themes, not including the default theme.
LabelArray	getSpaceBySpaceKeyLabelV1(@NonNull String spaceKey, @Nullable String prefix, @Nullable Integer start, @Nullable Integer limit)	GetSpaceBySpaceKeyLabelV1 Get Space Labels Returns a list of labels associated with a space.
SpaceSettings	getSpaceBySpaceKeySettingsV1(@NonNull String spaceKey)	GetSpaceBySpaceKeySettingsV1 Get space settings Returns the settings of a space.
ContentArray	getSpaceBySpaceKeyStateContentV1(@NonNull String spaceKey, @NonNull Integer stateId, @Nullable List<String> expand, @Nullable Integer limit, @Nullable Integer start)	GetSpaceBySpaceKeyStateContentV1 Get content in space with given content state Returns all content that has the provided content state in a space.
ContentStateSettings	getSpaceBySpaceKeyStateSettingsV1(@NonNull String spaceKey)	GetSpaceBySpaceKeyStateSettingsV1 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.
List<ContentState>	getSpaceBySpaceKeyStateV1(@NonNull String spaceKey)	GetSpaceBySpaceKeyStateV1 Get space suggested content states Get content states that are suggested in the space.
Theme	getSpaceBySpaceKeyThemeV1(@NonNull String spaceKey)	GetSpaceBySpaceKeyThemeV1 Get space theme Returns the theme selected for a space, if one is set.
SpaceWatchArray	getSpaceBySpaceKeyWatchV1(@NonNull String spaceKey, @Nullable String start, @Nullable String limit)	GetSpaceBySpaceKeyWatchV1 Get space watchers Returns a list of watchers of a space
BlueprintTemplateArray	getTemplateBlueprintV1(@Nullable String spaceKey, @Nullable Integer start, @Nullable Integer limit, @Nullable List<String> expand)	GetTemplateBlueprintV1 Get blueprint templates Returns all templates provided by blueprints.
ContentTemplate	getTemplateByContentTemplateIdv1(@NonNull String contentTemplateId, @Nullable List<String> expand)	GetTemplateByContentTemplateIDV1 Get content template Returns a content template.
ContentTemplateArray	getTemplatePageV1(@Nullable String spaceKey, @Nullable Integer start, @Nullable Integer limit, @Nullable List<String> expand)	GetTemplatePageV1 Get content templates Returns all content templates.
UserAnonymous	getUserAnonymousV1(@Nullable List<String> expand)	GetUserAnonymousV1 Get anonymous user Returns information about how anonymous users are represented, like the profile picture and display name.
BulkUserLookupArray	getUserBulkV1(@NonNull String accountId, @Nullable List<String> expand)	GetUserBulkV1 Get multiple users using ids Returns user details for the ids provided in the request.
UserProperty	getUserByUserIdpropertyByKeyV1(@NonNull String userId, @NonNull String key)	GetUserByUserIDPropertyByKeyV1 Get user property Returns the property corresponding to `key` for a user.
UserPropertyKeyArray	getUserByUserIdpropertyV1(@NonNull String userId, @Nullable Integer start, @Nullable Integer limit)	GetUserByUserIDPropertyV1 Get user properties Returns the properties for a user as list of property keys.
Map<String,Object>	getUserCurrentV1(@Nullable List<String> expand)	GetUserCurrentV1 Get current user Returns the currently logged-in user.
List<AccountIDEmailRecord>	getUserEmailBulkV1(@NonNull List<String> accountId)	GetUserEmailBulkV1 Get user email addresses in batch Returns a user's email address regardless of the user’s profile visibility settings.
AccountIDEmailRecord	getUserEmailV1(@NonNull String accountId)	GetUserEmailV1 Get user email address Returns a user's email address regardless of the user’s profile visibility settings.
GroupArrayWithLinks	getUserMemberofV1(@NonNull String accountId, @Nullable Integer start, @Nullable Integer limit)	GetUserMemberofV1 Get group memberships for user Returns the groups that a user is a member of.
Map<String,Object>	getUserV1(@NonNull String accountId, @Nullable List<String> expand)	GetUserV1 Get user Returns a user.
UserWatch	getUserWatchContentByContentIdv1(@NonNull String contentId, @Nullable String key, @Nullable String username, @Nullable String accountId)	GetUserWatchContentByContentIDV1 Get content watch status Returns whether a user is watching a piece of content.
UserWatch	getUserWatchLabelByLabelNameV1(@NonNull String labelName, @Nullable String key, @Nullable String username, @Nullable String accountId)	GetUserWatchLabelByLabelNameV1 Get label watch status Returns whether a user is watching a label.
UserWatch	getUserWatchSpaceBySpaceKeyV1(@NonNull String spaceKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	GetUserWatchSpaceBySpaceKeyV1 Get space watch status Returns whether a user is watching a space.
void	postAtlassianConnect1AppModuleDynamicV1(@NonNull ConnectModules payload)	PostAtlassianConnect1AppModuleDynamicV1 Register modules Registers a list of modules.
AuditRecord	postAuditV1(@NonNull AuditRecordCreate payload)	PostAuditV1 Create audit record Creates a record in the audit log.
void	postContentArchiveV1(@NonNull ArchivePagesB payload)	PostContentArchiveV1 Archive pages Archives a list of pages.
Content	postContentBlueprintInstanceByDraftIdv1(@NonNull String draftId, @Nullable String status, @Nullable List<String> expand, @NonNull Map<String,Object> payload)	PostContentBlueprintInstanceByDraftIDV1 Publish legacy draft Publishes a legacy draft of a page created from a blueprint.
List<AsyncId>	postContentbodyConvertAsyncBulkTasksV1(@NonNull List<ContentBodyConversionInput> payload)	PostContentbodyConvertAsyncBulkTasksV1 Create asynchronous content body conversion tasks in bulk Asynchronously converts content bodies from one format to another format in bulk.
AsyncId	postContentbodyConvertAsyncByToV1(@NonNull String to, @Nullable List<String> expand, @Nullable String spaceKeyContext, @Nullable String contentIdContext, @Nullable Boolean allowCache, @Nullable String embeddedContentRender, @NonNull Map<String,Object> payload)	PostContentbodyConvertAsyncByToV1 Asynchronously convert content body Converts a content body from one format to another format asynchronously.
Content	postContentByIdcopyV1(@NonNull String id, @Nullable List<String> expand, @NonNull CopyPageRequest payload)	PostContentByIDCopyV1 Copy single page Copies a single page and its associated properties, permissions, attachments, and custom contents.
LabelArray	postContentByIdlabelV1(@NonNull String id, @NonNull Object payload)	PostContentByIDLabelV1 Add labels to content Adds labels to a piece of content.
void	postContentByIdpagehierarchyCopyV1(@NonNull String id, @NonNull CopyPageHierarchyRequest payload)	PostContentByIDPagehierarchyCopyV1 Copy page hierarchy Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.
PermissionCheckResponse	postContentByIdpermissionCheckV1(@NonNull String id, @NonNull ContentPermissionRequest payload)	PostContentByIDPermissionCheckV1 Check content permissions Check if a user or a group can perform an operation to the specified content.
ContentRestrictionArray	postContentByIdrestrictionV1(@NonNull String id, @Nullable List<String> expand, @NonNull Object payload)	PostContentByIDRestrictionV1 Add restrictions Adds restrictions to a piece of content.
Version	postContentByIdversionV1(@NonNull String id, @Nullable List<String> expand, @NonNull VersionRestore payload)	PostContentByIDVersionV1 Restore content version Restores a historical version to be the latest version.
void	postGroupUserByGroupIdv1(@NonNull String groupId, @NonNull AccountId payload)	PostGroupUserByGroupIDV1 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.
Group	postGroupV1(@NonNull GroupName payload)	PostGroupV1 Create new user group Creates a new user group.
Object	postSettingsLookandfeelCustomV1(@Nullable String spaceKey, @NonNull LookAndFeel payload)	PostSettingsLookandfeelCustomV1 Update look and feel settings Updates the look and feel settings for the site or for a single space.
LabelArray	postSpaceBySpaceKeyLabelV1(@NonNull String spaceKey, @NonNull List<Map<String,Object>> payload)	PostSpaceBySpaceKeyLabelV1 Add labels to a space Adds labels to a piece of content.
void	postSpaceBySpaceKeyPermissionCustomContentV1(@NonNull String spaceKey, @NonNull SpacePermissionCustomContent payload)	PostSpaceBySpaceKeyPermissionCustomContentV1 Add new custom content permission to space Adds new custom content permission to space.
SpacePermissionV2	postSpaceBySpaceKeyPermissionV1(@NonNull String spaceKey, @NonNull Map<String,Object> payload)	PostSpaceBySpaceKeyPermissionV1 Add new permission to space Adds new permission to space.
Space	postSpacePrivateV1(@NonNull Map<String,Object> payload)	PostSpacePrivateV1 Create private space Creates a new space that is only visible to the creator.
Space	postSpaceV1(@NonNull Map<String,Object> payload)	PostSpaceV1 Create space Creates a new space.
ContentTemplate	postTemplateV1(@NonNull Map<String,Object> payload)	PostTemplateV1 Create content template Creates a new content template.
void	postUserByUserIdpropertyByKeyV1(@NonNull String userId, @NonNull String key, @NonNull UserPropertyCreate payload)	PostUserByUserIDPropertyByKeyV1 Create user property by key Creates a property for a user.
void	postUserWatchContentByContentIdv1(@NonNull String contentId, @Nullable String key, @Nullable String username, @Nullable String accountId)	PostUserWatchContentByContentIDV1 Add content watcher Adds a user as a watcher to a piece of content.
void	postUserWatchLabelByLabelNameV1(@NonNull String xAtlassianToken, @NonNull String labelName, @Nullable String key, @Nullable String username, @Nullable String accountId)	PostUserWatchLabelByLabelNameV1 Add label watcher Adds a user as a watcher to a label.
void	postUserWatchSpaceBySpaceKeyV1(@NonNull String xAtlassianToken, @NonNull String spaceKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	PostUserWatchSpaceBySpaceKeyV1 Add space watcher Adds a user as a watcher to a space.
RetentionPeriod	putAuditRetentionV1(@NonNull RetentionPeriod payload)	PutAuditRetentionV1 Set retention period Sets the retention period for records in the audit log.
Content	putContentBlueprintInstanceByDraftIdv1(@NonNull String draftId, @Nullable String status, @Nullable List<String> expand, @NonNull Map<String,Object> payload)	PutContentBlueprintInstanceByDraftIDV1 Publish shared draft Publishes a shared draft of a page created from a blueprint.
Content	putContentByIdchildAttachmentByAttachmentIdv1(@NonNull String id, @NonNull String attachmentId, @NonNull Map<String,Object> payload)	PutContentByIDChildAttachmentByAttachmentIDV1 Update attachment properties Updates the attachment properties, i.e.
void	putContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id, @NonNull String operationKey, @NonNull String groupId)	PutContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Add group to content restriction Adds a group to a content restriction by Group Id.
void	putContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id, @NonNull String operationKey, @Nullable String key, @Nullable String username, @Nullable String accountId)	PutContentByIDRestrictionByOperationByOperationKeyUserV1 Add user to content restriction Adds a user to a content restriction.
ContentRestrictionArray	putContentByIdrestrictionV1(@NonNull String id, @Nullable List<String> expand, @NonNull Object payload)	PutContentByIDRestrictionV1 Update restrictions Updates restrictions for a piece of content.
ContentStateResponse	putContentByIdstateV1(@NonNull String id, @NonNull String status, @NonNull ContentStateRestInput payload)	PutContentByIDStateV1 Set the content state of a content and publishes a new version of the content.
MovePageR200	putContentByPageIdmoveByPositionByTargetIdv1(@NonNull String pageId, @NonNull String position, @NonNull String targetId)	PutContentByPageIDMoveByPositionByTargetIDV1 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.
Relation	putRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName, @NonNull String sourceType, @NonNull String sourceKey, @NonNull String targetType, @NonNull String targetKey, @Nullable String sourceStatus, @Nullable String targetStatus, @Nullable Integer sourceVersion, @Nullable Integer targetVersion)	PutRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 Create relationship Creates a relationship between two entities (user, space, content).
LookAndFeelSelection	putSettingsLookandfeelV1(@NonNull LookAndFeelSelection payload)	PutSettingsLookandfeelV1 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.
SpaceSettings	putSpaceBySpaceKeySettingsV1(@NonNull String spaceKey, @NonNull SpaceSettingsUpdate payload)	PutSpaceBySpaceKeySettingsV1 Update space settings Updates the settings for a space.
Theme	putSpaceBySpaceKeyThemeV1(@NonNull String spaceKey, @NonNull ThemeUpdate payload)	PutSpaceBySpaceKeyThemeV1 Set space theme Sets the theme for a space.
Space	putSpaceBySpaceKeyV1(@NonNull String spaceKey, @NonNull Map<String,Object> payload)	PutSpaceBySpaceKeyV1 Update space Updates the name, description, or homepage of a space.
ContentTemplate	putTemplateV1(@NonNull Map<String,Object> payload)	PutTemplateV1 Update content template Updates a content template.
void	putUserByUserIdpropertyByKeyV1(@NonNull String userId, @NonNull String key, @NonNull UserPropertyUpdate payload)	PutUserByUserIDPropertyByKeyV1 Update user property Updates a property for the given user.

Method Details

getAtlassianConnect1AppModuleDynamicV1

ConnectModules getAtlassianConnect1AppModuleDynamicV1()

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

postAtlassianConnect1AppModuleDynamicV1

void postAtlassianConnect1AppModuleDynamicV1(@NonNull ConnectModules payload)

PostAtlassianConnect1AppModuleDynamicV1 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.

Parameters:

payload -

deleteAtlassianConnect1AppModuleDynamicV1

void deleteAtlassianConnect1AppModuleDynamicV1(@NonNull List<String> moduleKey)

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

Parameters:

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&moduleKey=dynamic-select-field`. Nonexistent keys are ignored.

getAuditV1

AuditRecordArray getAuditV1(@Nullable String startDate,
 @Nullable String endDate,
 @Nullable String searchString,
 @Nullable Integer start,
 @Nullable Integer limit)

GetAuditV1 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.

Parameters:

startDate - Filters the results to the records on or after the `startDate`. The `startDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.

endDate - Filters the results to the records on or before the `endDate`. The `endDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.

searchString - Filters the results to records that have string property values matching the `searchString`.

start - The starting index of the returned records.

limit - The maximum number of records to return per page. Note, this may be restricted by fixed system limits.

postAuditV1

AuditRecord postAuditV1(@NonNull AuditRecordCreate payload)

PostAuditV1 Create audit record Creates a record in the audit log. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.

Parameters:

payload - The record to be created in the audit log.

getAuditExportV1

Byte[] getAuditExportV1(@Nullable String startDate,
 @Nullable String endDate,
 @Nullable String searchString,
 @Nullable String format)

GetAuditExportV1 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.

Parameters:

startDate - Filters the exported results to the records on or after the `startDate`. The `startDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.

endDate - Filters the exported results to the records on or before the `endDate`. The `endDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.

searchString - Filters the exported results to records that have string property values matching the `searchString`.

format - The format of the export file for the audit records.

getAuditRetentionV1

RetentionPeriod getAuditRetentionV1()

GetAuditRetentionV1 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.

putAuditRetentionV1

RetentionPeriod putAuditRetentionV1(@NonNull RetentionPeriod payload)

PutAuditRetentionV1 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.

Parameters:

payload - The updated retention period.

getAuditSinceV1

AuditRecordArray getAuditSinceV1(@Nullable Long number,
 @Nullable String units,
 @Nullable String searchString,
 @Nullable Integer start,
 @Nullable Integer limit)

GetAuditSinceV1 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.

Parameters:

number - The number of units for the time period.

units - The unit of time that the time period is measured in.

searchString - Filters the results to records that have string property values matching the `searchString`.

start - The starting index of the returned records.

limit - The maximum number of records to return per page. Note, this may be restricted by fixed system limits.

postContentArchiveV1

void postContentArchiveV1(@NonNull ArchivePagesB payload)

PostContentArchiveV1 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/<taskId> 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.

Parameters:

payload - The pages to be archived.

putContentBlueprintInstanceByDraftIdv1

Content putContentBlueprintInstanceByDraftIdv1(@NonNull String draftId,
 @Nullable String status,
 @Nullable List<String> expand,
 @NonNull Map<String,Object> payload)

PutContentBlueprintInstanceByDraftIDV1 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.

Parameters:

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.

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.

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. - `childTypes.whiteboard` returns whether the content has child whiteboards. - `childTypes.database` returns whether the content has child databases. - `childTypes.embed` returns whether the content has child embeds (smartlinks). - `childTypes.folder` returns whether the content has child folders. - `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.whiteboard` returns whiteboards that are descendants at the level immediately below the content. - `children.database` returns databases that are descendants at the level immediately below the content. - `children.embed` returns embeds (smartlinks) that are descendants at the level immediately below the content. - `children.folder` returns folders 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.whiteboard` returns whiteboards that are descendants at any level below the content. - `descendants.database` returns databases that are descendants at any level below the content. - `descendants.embed` returns embeds (smartlinks) that are descendants at any level below the content. - `descendants.folder` returns folders 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.

payload -

postContentBlueprintInstanceByDraftIdv1

Content postContentBlueprintInstanceByDraftIdv1(@NonNull String draftId,
 @Nullable String status,
 @Nullable List<String> expand,
 @NonNull Map<String,Object> payload)

PostContentBlueprintInstanceByDraftIDV1 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.

Parameters:

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.

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.

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. - `childTypes.whiteboard` returns whether the content has child whiteboards. - `childTypes.database` returns whether the content has child databases. - `childTypes.embed` returns whether the content has child embeds (smartlinks). - `childTypes.folder` returns whether the content has child folders. - `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.whiteboard` returns whiteboards that are descendants at the level immediately below the content. - `children.database` returns databases that are descendants at the level immediately below the content. - `children.embed` returns embeds (smartlinks) that are descendants at the level immediately below the content. - `children.folder` returns folders 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.whiteboard` returns whiteboards that are descendants at any level below the content. - `descendants.database` returns databases that are descendants at any level below the content. - `descendants.embed` returns embeds (smartlinks) that are descendants at any level below the content. - `descendants.folder` returns folders 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.

payload -

getContentSearchV1

ContentArray getContentSearchV1(@NonNull String cql,
 @Nullable String cqlcontext,
 @Nullable List<String> expand,
 @Nullable String cursor,
 @Nullable Integer limit)

GetContentSearchV1 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&limit=25 ``` Example response: ``` { "results": [ { ... }, { ... }, ... { ... } ], "limit": 25, "size": 25, ... "_links": { "base": "<url>", "context": "<url>", "next": "/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg", "self": "<url>" } } ``` 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&limit=25&cursor=raNDoMsTRiNg ``` The response to this will have a `prev` URL similar to the `next` in the example response. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[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.

Parameters:

cql - The CQL string that is used to find the requested content.

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.

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. - `childTypes.whiteboard` returns whether the content has child whiteboards. - `childTypes.database` returns whether the content has child databases. - `childTypes.embed` returns whether the content has child embeds (smartlinks). - `childTypes.folder` returns whether the content has child folders. - `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.whiteboard` returns whiteboards that are descendants at the level immediately below the content. - `children.database` returns databases that are descendants at the level immediately below the content. - `children.embed` returns embeds (smartlinks) that are descendants at the level immediately below the content. - `children.folder` returns folders 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.whiteboard` returns whiteboards that are descendants at any level below the content. - `descendants.database` returns databases that are descendants at any level below the content. - `descendants.embed` returns embeds (smartlinks) that are descendants at any level below the content. - `descendants.folder` returns folders 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.

cursor - Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.

limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

deleteContentByIdpageTreeV1

void deleteContentByIdpageTreeV1(@NonNull String id)

DeleteContentByIDPageTreeV1 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: <pre><code> { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } </code></pre> Use the `/longtask/<taskId>` 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.

Parameters:

id - The ID of the content which forms root of the page tree, to be deleted.

putContentByPageIdmoveByPositionByTargetIdv1

MovePageR200 putContentByPageIdmoveByPositionByTargetIdv1(@NonNull String pageId,
 @NonNull String position,
 @NonNull String targetId)

PutContentByPageIDMoveByPositionByTargetIDV1 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.

Parameters:

pageId - The ID of the page to be moved

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

targetId - The ID of the target page for this operation

putContentByIdchildAttachmentByAttachmentIdv1

Content putContentByIdchildAttachmentByAttachmentIdv1(@NonNull String id,
 @NonNull String attachmentId,
 @NonNull Map<String,Object> payload)

PutContentByIDChildAttachmentByAttachmentIDV1 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.

Parameters:

id - The ID of the content that the attachment is attached to.

attachmentId - The ID of the attachment to update.

payload - The details of the attachment to be updated.

getContentByIdchildAttachmentByAttachmentIddownloadV1

void getContentByIdchildAttachmentByAttachmentIddownloadV1(@NonNull String id,
 @NonNull String attachmentId,
 @Nullable Long version,
 @Nullable List<String> status)

GetContentByIDChildAttachmentByAttachmentIDDownloadV1 Get URI to download attachment Redirects the client to a URL that serves an attachment's binary data.

Parameters:

id - The ID of the content that the attachment is attached to.

attachmentId - The ID of the attachment to download.

version - The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of the attachment.

status - The statuses allowed on the retrieved attachment. If this parameter is absent, it will default to `current`.

getContentByIddescendantV1

@Deprecated
Map<String,Object> getContentByIddescendantV1(@NonNull String id,
 @Nullable List<String> expand)

Deprecated.

GetContentByIDDescendantV1 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`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `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.

Parameters:

id - The ID of the content to be queried for its descendants.

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. - `whiteboard` returns all child whiteboards of the content. - `database` returns all child databases of the content. - `embed` returns all child embeds of the content. - `folder` returns all child folders of the content.

getContentByIddescendantByTypeV1

@Deprecated
ContentArray getContentByIddescendantByTypeV1(@NonNull String id,
 @NonNull String type,
 @Nullable String depth,
 @Nullable List<String> expand,
 @Nullable Integer start,
 @Nullable Integer limit)

Deprecated.

GetContentByIDDescendantByTypeV1 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`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `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. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page.

Parameters:

id - The ID of the content to be queried for its descendants.

type - The type of descendants to return.

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.

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. - `childTypes.whiteboard` returns whether the content has child whiteboards. - `childTypes.database` returns whether the content has child databases. - `childTypes.embed` returns whether the content has child embeds (smartlinks). - `childTypes.folder` returns whether the content has child folders. - `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.whiteboard` returns whiteboards that are descendants at the level immediately below the content. - `children.database` returns databases that are descendants at the level immediately below the content. - `children.embed` returns embeds (smartlinks) that are descendants at the level immediately below the content. - `children.folder` returns folders 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.whiteboard` returns whiteboards that are descendants at any level below the content. - `descendants.database` returns databases that are descendants at any level below the content. - `descendants.embed` returns embeds (smartlinks) that are descendants at any level below the content. - `descendants.folder` returns folders 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.

start - The starting index of the returned content.

limit - The maximum number of content to return per page. Note, this may be restricted by fixed system limits.

getContentByIdhistoryByVersionMacroIdbyMacroIdv1

MacroInstance getContentByIdhistoryByVersionMacroIdbyMacroIdv1(@NonNull String id,
 @NonNull Integer version,
 @NonNull String macroId)

GetContentByIDHistoryByVersionMacroIDByMacroIDV1 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. For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by examining the "local-id" parameter node inside the "parameters" node. Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID. Example: <ac:adf-node type="extension"> <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters"> <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter> </ac:adf-node> 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. This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.

Parameters:

id - The ID for the content that contains the macro.

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.

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'.

getContentByIdhistoryByVersionMacroIdbyMacroIdconvertByToV1

ContentBody getContentByIdhistoryByVersionMacroIdbyMacroIdconvertByToV1(@NonNull String id,
 @NonNull Integer version,
 @NonNull String macroId,
 @NonNull String to,
 @Nullable List<String> expand,
 @Nullable String spaceKeyContext,
 @Nullable String embeddedContentRender)

GetContentByIDHistoryByVersionMacroIDByMacroIDConvertByToV1 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. For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by examining the "local-id" parameter node inside the "parameters" node. Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID. Example: <ac:adf-node type="extension"> <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters"> <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter> </ac:adf-node> 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. This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.

Parameters:

id - The ID for the content that contains the macro.

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.

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'.

to - The content representation to return the macro in.

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 `<script>` tags - `webresource.superbatch.tags.css` returns all common CSS dependencies as html `<style>` tags - `webresource.superbatch.tags.js` returns all common dependencies as html `<script>` and `<style>` 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 `<script>` tags - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags - `webresource.tags.js` returns common dependencies as html `<script>` and `<style>` tags

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 `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` 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.

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.

getContentByIdhistoryByVersionMacroIdbyMacroIdconvertAsyncByToV1

AsyncId getContentByIdhistoryByVersionMacroIdbyMacroIdconvertAsyncByToV1(@NonNull String id,
 @NonNull Integer version,
 @NonNull String macroId,
 @NonNull String to,
 @Nullable List<String> expand,
 @Nullable Boolean allowCache,
 @Nullable String spaceKeyContext,
 @Nullable String embeddedContentRender)

GetContentByIDHistoryByVersionMacroIDByMacroIDConvertAsyncByToV1 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. For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by examining the "local-id" parameter node inside the "parameters" node. Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID. Example: <ac:adf-node type="extension"> <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters"> <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter> </ac:adf-node> 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. This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.

Parameters:

id - The ID for the content that contains the macro.

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.

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'.

to - The content representation to return the macro in. Currently, the following conversions are allowed: - `export_view` - `styled_view` - `view`

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 `<script>` tags - `webresource.superbatch.tags.css` returns all common CSS dependencies as html `<style>` tags - `webresource.superbatch.tags.js` returns all common dependencies as html `<script>` and `<style>` 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 `<script>` tags - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags - `webresource.tags.js` returns common dependencies as html `<script>` and `<style>` tags

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.

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 `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` 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.

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.

postContentByIdlabelV1

LabelArray postContentByIdlabelV1(@NonNull String id,
 @NonNull Object payload)

PostContentByIDLabelV1 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.

Parameters:

id - The ID of the content that will have labels added to it.

payload - The labels to add to the content.

deleteContentByIdlabelV1

void deleteContentByIdlabelV1(@NonNull String id,
 @NonNull String name)

DeleteContentByIDLabelV1 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.

Parameters:

id - The ID of the content that the label will be removed from.

name - The name of the label to be removed.

deleteContentByIdlabelByLabelV1

void deleteContentByIdlabelByLabelV1(@NonNull String id,
 @NonNull String label)

DeleteContentByIDLabelByLabelV1 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.

Parameters:

id - The ID of the content that the label will be removed from.

label - The name of the label to be removed.

getContentByIdnotificationChildCreatedV1

WatchArray getContentByIdnotificationChildCreatedV1(@NonNull String id,
 @Nullable Integer start,
 @Nullable Integer limit)

GetContentByIDNotificationChildCreatedV1 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).

Parameters:

id - The ID of the content to be queried for its watches.

start - The starting index of the returned watches.

limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

getContentByIdnotificationCreatedV1

SpaceWatchArray getContentByIdnotificationCreatedV1(@NonNull String id,
 @Nullable Integer start,
 @Nullable Integer limit)

GetContentByIDNotificationCreatedV1 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).

Parameters:

id - The ID of the content to be queried for its watches.

start - The starting index of the returned watches.

limit - The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

postContentByIdpagehierarchyCopyV1

void postContentByIdpagehierarchyCopyV1(@NonNull String id,
 @NonNull CopyPageHierarchyRequest payload)

PostContentByIDPagehierarchyCopyV1 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: <pre><code> { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } </code></pre> Use the /longtask/<taskId> REST API to get the copy task status.

Parameters:

id -

payload - Request object from json post body

postContentByIdcopyV1

Content postContentByIdcopyV1(@NonNull String id,
 @Nullable List<String> expand,
 @NonNull CopyPageRequest payload)

PostContentByIDCopyV1 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 - `parent_content`: page will be copied as a child of the specified parent content - `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`.

Parameters:

id -

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. - `childTypes.whiteboard` returns whether the content has child whiteboards. - `childTypes.database` returns whether the content has child databases. - `childTypes.embed` returns whether the content has child embeds (smartlinks). - `childTypes.folder` returns whether the content has child folder. - `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.whiteboard` returns whiteboards that are descendants at the level immediately below the content. - `children.database` returns databases that are descendants at the level immediately below the content. - `children.embed` returns embeds (smartlinks) that are descendants at the level immediately below the content. - `children.folder` returns folders 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.whiteboard` returns whiteboards that are descendants at any level below the content. - `descendants.database` returns databases that are descendants at any level below the content. - `descendants.embed` returns embeds (smartlinks) that are descendants at any level below the content. - `descendants.folder` returns folders 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.

payload - Request object from json post body

postContentByIdpermissionCheckV1

PermissionCheckResponse postContentByIdpermissionCheckV1(@NonNull String id,
 @NonNull ContentPermissionRequest payload)

PostContentByIDPermissionCheckV1 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.

Parameters:

id - The ID of the content to check permissions against.

payload - The content permission request.

getContentByIdrestrictionV1

ContentRestrictionArray getContentByIdrestrictionV1(@NonNull String id,
 @Nullable List<String> expand,
 @Nullable Integer start,
 @Nullable Integer limit)

GetContentByIDRestrictionV1 Get restrictions Returns the restrictions on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.

Parameters:

id - The ID of the content to be queried for its restrictions.

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.

start - The starting index of the users and groups in the returned restrictions.

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.

putContentByIdrestrictionV1

ContentRestrictionArray putContentByIdrestrictionV1(@NonNull String id,
 @Nullable List<String> expand,
 @NonNull Object payload)

PutContentByIDRestrictionV1 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.

Parameters:

id - The ID of the content to update restrictions for.

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.

payload - The updated restrictions for the content.

postContentByIdrestrictionV1

ContentRestrictionArray postContentByIdrestrictionV1(@NonNull String id,
 @Nullable List<String> expand,
 @NonNull Object payload)

PostContentByIDRestrictionV1 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.

Parameters:

id - The ID of the content to add restrictions to.

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.

payload - The restrictions to be added to the content.

deleteContentByIdrestrictionV1

ContentRestrictionArray deleteContentByIdrestrictionV1(@NonNull String id,
 @Nullable List<String> expand)

DeleteContentByIDRestrictionV1 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.

Parameters:

id - The ID of the content to remove restrictions from.

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.

getContentByIdrestrictionByOperationV1

GetRestrictionsByOperation getContentByIdrestrictionByOperationV1(@NonNull String id,
 @Nullable List<String> expand)

GetContentByIDRestrictionByOperationV1 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.

Parameters:

id - The ID of the content to be queried for its restrictions.

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.

getContentByIdrestrictionByOperationByOperationKeyV1

ContentRestriction getContentByIdrestrictionByOperationByOperationKeyV1(@NonNull String id,
 @NonNull String operationKey,
 @Nullable List<String> expand,
 @Nullable Integer start,
 @Nullable Integer limit)

GetContentByIDRestrictionByOperationByOperationKeyV1 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.

Parameters:

id - The ID of the content to be queried for its restrictions.

operationKey - The operation type of the restrictions to be returned.

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.

start - The starting index of the users and groups in the returned restrictions.

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.

getContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1

void getContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id,
 @NonNull String operationKey,
 @NonNull String groupId)

GetContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that the restriction applies to.

groupId - The id of the group to be queried for whether the content restriction applies to it.

putContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1

void putContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id,
 @NonNull String operationKey,
 @NonNull String groupId)

PutContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that the restriction applies to.

groupId - The groupId of the group to add to the content restriction.

deleteContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1

void deleteContentByIdrestrictionByOperationByOperationKeyByGroupIdbyGroupIdv1(@NonNull String id,
 @NonNull String operationKey,
 @NonNull String groupId)

DeleteContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that the restriction applies to.

groupId - The id of the group to remove from the content restriction.

getContentByIdrestrictionByOperationByOperationKeyUserV1

void getContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id,
 @NonNull String operationKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

GetContentByIDRestrictionByOperationByOperationKeyUserV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that is restricted.

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.

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.

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`.

putContentByIdrestrictionByOperationByOperationKeyUserV1

void putContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id,
 @NonNull String operationKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

PutContentByIDRestrictionByOperationByOperationKeyUserV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that the restriction applies to.

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.

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.

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`.

deleteContentByIdrestrictionByOperationByOperationKeyUserV1

void deleteContentByIdrestrictionByOperationByOperationKeyUserV1(@NonNull String id,
 @NonNull String operationKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

DeleteContentByIDRestrictionByOperationByOperationKeyUserV1 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.

Parameters:

id - The ID of the content that the restriction applies to.

operationKey - The operation that the restriction applies to.

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.

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.

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`.

getContentByIdstateV1

ContentStateResponse getContentByIdstateV1(@NonNull String id,
 @Nullable String status)

GetContentByIDStateV1 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.

Parameters:

id - The id of the content whose content state is of interest.

status - Set status to one of [current,draft,archived]. Default value is current.

putContentByIdstateV1

ContentStateResponse putContentByIdstateV1(@NonNull String id,
 @NonNull String status,
 @NonNull ContentStateRestInput payload)

PutContentByIDStateV1 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.

Parameters:

id - The Id of the content whose content state is to be set.

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.

payload - 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.

deleteContentByIdstateV1

ContentStateResponse deleteContentByIdstateV1(@NonNull String id,
 @Nullable String status)

DeleteContentByIDStateV1 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.

Parameters:

id - The Id of the content whose content state is to be set.

status - status of content state from which to delete state. Can be draft or archived

getContentByIdstateAvailableV1

AvailableContentStates getContentByIdstateAvailableV1(@NonNull String id)

GetContentByIDStateAvailableV1 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.

Parameters:

id - id of content to get available states for

postContentByIdversionV1

Version postContentByIdversionV1(@NonNull String id,
 @Nullable List<String> expand,
 @NonNull VersionRestore payload)

PostContentByIDVersionV1 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.

Parameters:

id - The ID of the content for which the history will be restored.

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.

payload - The content version to be restored.

deleteContentByIdversionByVersionNumberV1

void deleteContentByIdversionByVersionNumberV1(@NonNull String id,
 @NonNull Integer versionNumber)

DeleteContentByIDVersionByVersionNumberV1 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.

Parameters:

id - The ID of the content that the version will be deleted from.

versionNumber - The number of the version to be deleted. The version number starts from 1 up to current version.

getContentStatesV1

List<ContentState> getContentStatesV1()

GetContentStatesV1 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.

postContentbodyConvertAsyncByToV1

AsyncId postContentbodyConvertAsyncByToV1(@NonNull String to,
 @Nullable List<String> expand,
 @Nullable String spaceKeyContext,
 @Nullable String contentIdContext,
 @Nullable Boolean allowCache,
 @Nullable String embeddedContentRender,
 @NonNull Map<String,Object> payload)

PostContentbodyConvertAsyncByToV1 Asynchronously convert content body Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task. Supported conversions: - atlas_doc_format: editor, export_view, storage, styled_view, view - storage: atlas_doc_format, editor, export_view, styled_view, view - editor: storage 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.

Parameters:

to - The name of the target format for the content body.

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 `<script>` tags - `webresource.superbatch.tags.css` returns all common CSS dependencies as html `<style>` tags - `webresource.superbatch.tags.js` returns all common dependencies as html `<script>` and `<style>` 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 `<script>` tags - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags - `webresource.tags.js` returns common dependencies as html `<script>` and `<style>` tags

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 `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` 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.

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 `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` 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.

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.

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.

payload - The content body to convert.

getContentbodyConvertAsyncByIdv1

AsyncContentBody getContentbodyConvertAsyncByIdv1(@NonNull String id)

GetContentbodyConvertAsyncByIDV1 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.

Parameters:

id - The asyncId of the macro task to get the converted body.

getContentbodyConvertAsyncBulkTasksV1

List<AsyncContentBody> getContentbodyConvertAsyncBulkTasksV1(@NonNull List<String> ids)

GetContentbodyConvertAsyncBulkTasksV1 Get asynchronous content body conversion task result in bulk Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not completed, the task status is returned instead. Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical conversion request is made again with the `allowCache` parameter set to false. Note that there is a maximum limit of 50 task results per request to this endpoint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameters:

ids - The asyncIds of the conversion tasks.

postContentbodyConvertAsyncBulkTasksV1

List<AsyncId> postContentbodyConvertAsyncBulkTasksV1(@NonNull List<ContentBodyConversionInput> payload)

PostContentbodyConvertAsyncBulkTasksV1 Create asynchronous content body conversion tasks in bulk Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this endpoint. Supported conversions: - storage: editor, export_view, styled_view, view - editor: storage Once a conversion task is completed, it is available for polling for up to 5 minutes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.

Parameters:

payload - An array of parameters to create content body conversion tasks.

getLabelV1

LabelDetails getLabelV1(@NonNull String name,
 @Nullable String type,
 @Nullable Integer start,
 @Nullable Integer limit)

GetLabelV1 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.

Parameters:

name - Name of the label to query.

type - The type of contents that are to be returned.

start - The starting offset for the results.

limit - The number of results to be returned.

getGroupV1

GroupArrayWithLinks getGroupV1(@Nullable Integer start,
 @Nullable Integer limit,
 @Nullable String accessType)

GetGroupV1 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).

Parameters:

start - The starting index of the returned groups.

limit - The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

accessType - The group permission level for which to filter results.

postGroupV1

Group postGroupV1(@NonNull GroupName payload)

PostGroupV1 Create new user group Creates a new user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.

Parameters:

payload - Name of the group that is to be created.

getGroupByIdv1

Group getGroupByIdv1(@NonNull String id)

GetGroupByIDV1 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).

Parameters:

id - The id of the group.

deleteGroupByIdv1

void deleteGroupByIdv1(@NonNull String id)

DeleteGroupByIDV1 Delete user group Delete user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.

Parameters:

id - Id of the group to delete.

getGroupPickerV1

GroupArrayWithLinks getGroupPickerV1(@NonNull String query,
 @Nullable Integer start,
 @Nullable Integer limit,
 @Nullable Boolean shouldReturnTotalSize)

GetGroupPickerV1 Search groups by partial query Get search results of groups by partial query provided.

Parameters:

query - the search term used to query results.

start - The starting index of the returned groups.

limit - The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.

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.

getGroupByGroupIdmembersByGroupIdv1

UserArray getGroupByGroupIdmembersByGroupIdv1(@NonNull String groupId,
 @Nullable Integer start,
 @Nullable Integer limit,
 @Nullable Boolean shouldReturnTotalSize,
 @Nullable List<String> expand)

GetGroupByGroupIDMembersByGroupIDV1 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).

Parameters:

groupId - The id of the group to be queried for its members.

start - The starting index of the returned users.

limit - The maximum number of users to return per page. Note, this may be restricted by fixed system limits.

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.

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`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

postGroupUserByGroupIdv1

void postGroupUserByGroupIdv1(@NonNull String groupId,
 @NonNull AccountId payload)

PostGroupUserByGroupIDV1 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.

Parameters:

groupId - GroupId of the group whose membership is updated

payload - AccountId of the user who needs to be added as member.

deleteGroupUserByGroupIdv1

void deleteGroupUserByGroupIdv1(@NonNull String groupId,
 @NonNull String accountId,
 @Nullable String key,
 @Nullable String username)

DeleteGroupUserByGroupIDV1 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.

Parameters:

groupId - Id of the group whose membership is updated.

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`.

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.

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.

getLongtaskV1

LongTaskStatusArray getLongtaskV1(@Nullable String key,
 @Nullable Integer start,
 @Nullable Integer limit)

GetLongtaskV1 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).

Parameters:

key - The key of the tasks.

start - The starting index of the returned tasks.

limit - The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.

getLongtaskByIdv1

LongTaskStatusWithLinks getLongtaskByIdv1(@NonNull String id)

GetLongtaskByIDV1 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).

Parameters:

id - The ID of the task.

getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeV1

RelationArray getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeV1(@NonNull String relationName,
 @NonNull String sourceType,
 @NonNull String sourceKey,
 @NonNull String targetType,
 @Nullable String sourceStatus,
 @Nullable String targetStatus,
 @Nullable Integer sourceVersion,
 @Nullable Integer targetVersion,
 @Nullable List<String> expand,
 @Nullable Integer start,
 @Nullable Integer limit)

GetRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeV1 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.

Parameters:

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.

sourceType - The source entity type of the relationship.

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.

targetType - The target entity type of the relationship.

sourceStatus - The status of the source. This parameter is only used when the `sourceType` is 'content'.

targetStatus - The status of the target. This parameter is only used when the `targetType` is 'content'.

sourceVersion - The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is 'historical'.

targetVersion - The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is 'historical'.

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.

start - The starting index of the returned relationships.

limit - The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1

Relation getRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName,
 @NonNull String sourceType,
 @NonNull String sourceKey,
 @NonNull String targetType,
 @NonNull String targetKey,
 @Nullable String sourceStatus,
 @Nullable String targetStatus,
 @Nullable Integer sourceVersion,
 @Nullable Integer targetVersion,
 @Nullable List<String> expand)

GetRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 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.

Parameters:

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).

sourceType - The source entity type of the relationship. This must be 'user', if the `relationName` is 'favourite'.

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.

targetType - The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'.

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.

sourceStatus - The status of the source. This parameter is only used when the `sourceType` is 'content'.

targetStatus - The status of the target. This parameter is only used when the `targetType` is 'content'.

sourceVersion - The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is 'historical'.

targetVersion - The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is 'historical'.

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.

putRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1

Relation putRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName,
 @NonNull String sourceType,
 @NonNull String sourceKey,
 @NonNull String targetType,
 @NonNull String targetKey,
 @Nullable String sourceStatus,
 @Nullable String targetStatus,
 @Nullable Integer sourceVersion,
 @Nullable Integer targetVersion)

PutRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 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: `PUT /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).

Parameters:

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.

sourceType - The source entity type of the relationship. This must be 'user', if the `relationName` is 'favourite'.

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.

targetType - The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'.

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.

sourceStatus - The status of the source. This parameter is only used when the `sourceType` is 'content'.

targetStatus - The status of the target. This parameter is only used when the `targetType` is 'content'.

sourceVersion - The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is 'historical'.

targetVersion - The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is 'historical'.

deleteRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1

void deleteRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1(@NonNull String relationName,
 @NonNull String sourceType,
 @NonNull String sourceKey,
 @NonNull String targetType,
 @NonNull String targetKey,
 @Nullable String sourceStatus,
 @Nullable String targetStatus,
 @Nullable Integer sourceVersion,
 @Nullable Integer targetVersion)

DeleteRelationByRelationNameFromBySourceTypeBySourceKeyToByTargetTypeByTargetKeyV1 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.

Parameters:

relationName - The name of the relationship.

sourceType - The source entity type of the relationship. This must be 'user', if the `relationName` is 'favourite'.

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.

targetType - The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'.

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.

sourceStatus - The status of the source. This parameter is only used when the `sourceType` is 'content'.

targetStatus - The status of the target. This parameter is only used when the `targetType` is 'content'.

sourceVersion - The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is 'historical'.

targetVersion - The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is 'historical'.

getRelationByRelationNameToByTargetTypeByTargetKeyFromBySourceTypeV1

RelationArray getRelationByRelationNameToByTargetTypeByTargetKeyFromBySourceTypeV1(@NonNull String relationName,
 @NonNull String sourceType,
 @NonNull String targetType,
 @NonNull String targetKey,
 @Nullable String sourceStatus,
 @Nullable String targetStatus,
 @Nullable Integer sourceVersion,
 @Nullable Integer targetVersion,
 @Nullable List<String> expand,
 @Nullable Integer start,
 @Nullable Integer limit)

GetRelationByRelationNameToByTargetTypeByTargetKeyFromBySourceTypeV1 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.

Parameters:

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.

sourceType - The source entity type of the relationship.

targetType - The target entity type of the relationship.

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.

sourceStatus - The status of the source. This parameter is only used when the `sourceType` is 'content'.

targetStatus - The status of the target. This parameter is only used when the `targetType` is 'content'.

sourceVersion - The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is 'historical'.

targetVersion - The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is 'historical'.

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.

start - The starting index of the returned relationships.

limit - The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

getSearchV1

SearchPageResponseSearchResult getSearchV1(@NonNull String cql,
 @Nullable String cqlcontext,
 @Nullable String cursor,
 @Nullable Boolean next,
 @Nullable Boolean prev,
 @Nullable Integer limit,
 @Nullable Integer start,
 @Nullable Boolean includeArchivedSpaces,
 @Nullable Boolean excludeCurrentSpaces,
 @Nullable String excerpt,
 @Nullable String sitePermissionTypeFilter,
 @Nullable List<String> expand)

GetSearchV1 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&limit=25 ``` Example response: ``` { "results": [ { ... }, { ... }, ... { ... } ], "limit": 25, "size": 25, ... "_links": { "base": "<url>", "context": "<url>", "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg", "self": "<url>" } } ``` 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&limit=25&cursor=raNDoMsTRiNg ``` The response to this will have a `prev` URL similar to the `next` in the example response. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[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.

Parameters:

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.

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}`

cursor - Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.

next -

prev -

limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

start - The start point of the collection to return

includeArchivedSpaces - Whether to include content from archived spaces in the results.

excludeCurrentSpaces - Whether to exclude current spaces and only show archived spaces.

excerpt - The excerpt strategy to apply to the result

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.

expand -

getSearchUserV1

SearchPageResponseSearchResult getSearchUserV1(@NonNull String cql,
 @Nullable Integer start,
 @Nullable Integer limit,
 @Nullable List<String> expand,
 @Nullable String sitePermissionTypeFilter)

GetSearchUserV1 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.

Parameters:

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 up to 10k 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"

start - The starting index of the returned users.

limit - The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.

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.

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.

getSettingsLookandfeelV1

LookAndFeelSettings getSettingsLookandfeelV1(@Nullable String spaceKey)

GetSettingsLookandfeelV1 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

Parameters:

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.

putSettingsLookandfeelV1

LookAndFeelSelection putSettingsLookandfeelV1(@NonNull LookAndFeelSelection payload)

PutSettingsLookandfeelV1 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.

Parameters:

payload - The look and feel type to be set.

postSettingsLookandfeelCustomV1

Object postSettingsLookandfeelCustomV1(@Nullable String spaceKey,
 @NonNull LookAndFeel payload)

PostSettingsLookandfeelCustomV1 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.

Parameters:

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.

payload - 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.

deleteSettingsLookandfeelCustomV1

void deleteSettingsLookandfeelCustomV1(@Nullable String spaceKey)

DeleteSettingsLookandfeelCustomV1 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.

Parameters:

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.

getSettingsSystemInfoV1

SystemInfoEntity getSettingsSystemInfoV1()

GetSettingsSystemInfoV1 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).

getSettingsThemeV1

ThemeArray getSettingsThemeV1(@Nullable Integer start,
 @Nullable Integer limit)

GetSettingsThemeV1 Get themes Returns all themes, not including the default theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

Parameters:

start - The starting index of the returned themes.

limit - The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.

getSettingsThemeSelectedV1

Theme getSettingsThemeSelectedV1()

GetSettingsThemeSelectedV1 Get global theme Returns the globally assigned theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

getSettingsThemeByThemeKeyV1

Theme getSettingsThemeByThemeKeyV1(@NonNull String themeKey)

GetSettingsThemeByThemeKeyV1 Get theme Returns a theme. This includes information about the theme name, description, and icon. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

Parameters:

themeKey - The key of the theme to be returned.

postSpaceV1

Space postSpaceV1(@NonNull Map<String,Object> payload)

PostSpaceV1 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.

Parameters:

payload - The space to be created.

postSpacePrivateV1

Space postSpacePrivateV1(@NonNull Map<String,Object> payload)

PostSpacePrivateV1 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.

Parameters:

payload - The space to be created.

putSpaceBySpaceKeyV1

Space putSpaceBySpaceKeyV1(@NonNull String spaceKey,
 @NonNull Map<String,Object> payload)

PutSpaceBySpaceKeyV1 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.

Parameters:

spaceKey - The key of the space to update.

payload - The updated space.

deleteSpaceBySpaceKeyV1

void deleteSpaceBySpaceKeyV1(@NonNull String spaceKey)

DeleteSpaceBySpaceKeyV1 Delete space Permanently deletes a space without sending it to the trash. 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.

Parameters:

spaceKey - The key of the space to delete.

postSpaceBySpaceKeyPermissionV1

SpacePermissionV2 postSpaceBySpaceKeyPermissionV1(@NonNull String spaceKey,
 @NonNull Map<String,Object> payload)

PostSpaceBySpaceKeyPermissionV1 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.

Parameters:

spaceKey - The key of the space to be queried for its content.

payload - The permission to be created.

postSpaceBySpaceKeyPermissionCustomContentV1

void postSpaceBySpaceKeyPermissionCustomContentV1(@NonNull String spaceKey,
 @NonNull SpacePermissionCustomContent payload)

PostSpaceBySpaceKeyPermissionCustomContentV1 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.

Parameters:

spaceKey - The key of the space to be queried for its content.

payload - The permissions to be created.

deleteSpaceBySpaceKeyPermissionByIdv1

void deleteSpaceBySpaceKeyPermissionByIdv1(@NonNull String spaceKey,
 @NonNull Long id)

DeleteSpaceBySpaceKeyPermissionByIDV1 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.

Parameters:

spaceKey - The key of the space to be queried for its content.

id - Id of the permission to be deleted.

getSpaceBySpaceKeySettingsV1

SpaceSettings getSpaceBySpaceKeySettingsV1(@NonNull String spaceKey)

GetSpaceBySpaceKeySettingsV1 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.

Parameters:

spaceKey - The key of the space to be queried for its settings.

putSpaceBySpaceKeySettingsV1

SpaceSettings putSpaceBySpaceKeySettingsV1(@NonNull String spaceKey,
 @NonNull SpaceSettingsUpdate payload)

PutSpaceBySpaceKeySettingsV1 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.

Parameters:

spaceKey - The key of the space whose settings will be updated.

payload - The space settings to update.

getSpaceBySpaceKeyStateV1

List<ContentState> getSpaceBySpaceKeyStateV1(@NonNull String spaceKey)

GetSpaceBySpaceKeyStateV1 Get space suggested content states Get content states that are suggested in the space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

Parameters:

spaceKey - The key of the space to be queried for its content state settings.

getSpaceBySpaceKeyStateSettingsV1

ContentStateSettings getSpaceBySpaceKeyStateSettingsV1(@NonNull String spaceKey)

GetSpaceBySpaceKeyStateSettingsV1 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**: 'Admin' permission for the space.

Parameters:

spaceKey - The key of the space to be queried for its content state settings.

getSpaceBySpaceKeyStateContentV1

ContentArray getSpaceBySpaceKeyStateContentV1(@NonNull String spaceKey,
 @NonNull Integer stateId,
 @Nullable List<String> expand,
 @Nullable Integer limit,
 @Nullable Integer start)

GetSpaceBySpaceKeyStateContentV1 Get content in space with given content state Returns all content that has the provided content state in a space. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

Parameters:

spaceKey - The key of the space to be queried for its content state settings.

stateId - The id of the content state to filter content by

expand - A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

limit - Maximum number of results to return

start - Number of result to start returning. (0 indexed)

getSpaceBySpaceKeyThemeV1

Theme getSpaceBySpaceKeyThemeV1(@NonNull String spaceKey)

GetSpaceBySpaceKeyThemeV1 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.

Parameters:

spaceKey - The key of the space to be queried for its theme.

putSpaceBySpaceKeyThemeV1

Theme putSpaceBySpaceKeyThemeV1(@NonNull String spaceKey,
 @NonNull ThemeUpdate payload)

PutSpaceBySpaceKeyThemeV1 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.

Parameters:

spaceKey - The key of the space to set the theme for.

payload -

deleteSpaceBySpaceKeyThemeV1

void deleteSpaceBySpaceKeyThemeV1(@NonNull String spaceKey)

DeleteSpaceBySpaceKeyThemeV1 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.

Parameters:

spaceKey - The key of the space to reset the theme for.

getSpaceBySpaceKeyWatchV1

SpaceWatchArray getSpaceBySpaceKeyWatchV1(@NonNull String spaceKey,
 @Nullable String start,
 @Nullable String limit)

GetSpaceBySpaceKeyWatchV1 Get space watchers Returns a list of watchers of a space

Parameters:

spaceKey - The key of the space to get watchers.

start - The start point of the collection to return.

limit - The limit of the number of items to return, this may be restricted by fixed system limits.

getSpaceBySpaceKeyLabelV1

LabelArray getSpaceBySpaceKeyLabelV1(@NonNull String spaceKey,
 @Nullable String prefix,
 @Nullable Integer start,
 @Nullable Integer limit)

GetSpaceBySpaceKeyLabelV1 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.

Parameters:

spaceKey - The key of the space to get labels for.

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.

start - The starting index of the returned labels.

limit - The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

postSpaceBySpaceKeyLabelV1

LabelArray postSpaceBySpaceKeyLabelV1(@NonNull String spaceKey,
 @NonNull List<Map<String,Object>> payload)

PostSpaceBySpaceKeyLabelV1 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.

Parameters:

spaceKey - The key of the space to add labels to.

payload - The labels to add to the content.

deleteSpaceBySpaceKeyLabelV1

void deleteSpaceBySpaceKeyLabelV1(@NonNull String spaceKey,
 @NonNull String name,
 @Nullable String prefix)

DeleteSpaceBySpaceKeyLabelV1 Remove label from a space

Parameters:

spaceKey - The key of the space to remove a labels from.

name - The name of the label to remove

prefix - The prefix of the label to remove. If not provided defaults to global.

putTemplateV1

ContentTemplate putTemplateV1(@NonNull Map<String,Object> payload)

PutTemplateV1 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.

Parameters:

payload - The updated content template.

postTemplateV1

ContentTemplate postTemplateV1(@NonNull Map<String,Object> payload)

PostTemplateV1 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.

Parameters:

payload - The content template to be created. The content body must be in 'storage' format.

getTemplateBlueprintV1

BlueprintTemplateArray getTemplateBlueprintV1(@Nullable String spaceKey,
 @Nullable Integer start,
 @Nullable Integer limit,
 @Nullable List<String> expand)

GetTemplateBlueprintV1 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.

Parameters:

spaceKey - The key of the space to be queried for templates. If the `spaceKey` is not specified, global blueprint templates will be returned.

start - The starting index of the returned templates.

limit - The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

expand - A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

getTemplatePageV1

ContentTemplateArray getTemplatePageV1(@Nullable String spaceKey,
 @Nullable Integer start,
 @Nullable Integer limit,
 @Nullable List<String> expand)

GetTemplatePageV1 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.

Parameters:

spaceKey - The key of the space to be queried for templates. If the `spaceKey` is not specified, global templates will be returned.

start - The starting index of the returned templates.

limit - The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

expand - A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

getTemplateByContentTemplateIdv1

ContentTemplate getTemplateByContentTemplateIdv1(@NonNull String contentTemplateId,
 @Nullable List<String> expand)

GetTemplateByContentTemplateIDV1 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.

Parameters:

contentTemplateId - The ID of the content template to be returned.

expand - A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

deleteTemplateByContentTemplateIdv1

void deleteTemplateByContentTemplateIdv1(@NonNull String contentTemplateId)

DeleteTemplateByContentTemplateIDV1 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.

Parameters:

contentTemplateId - The ID of the template to be deleted.

getUserV1

Map<String,Object> getUserV1(@NonNull String accountId,
 @Nullable List<String> expand)

GetUserV1 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).

Parameters:

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`.

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`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

getUserAnonymousV1

UserAnonymous getUserAnonymousV1(@Nullable List<String> expand)

GetUserAnonymousV1 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).

Parameters:

expand - A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations that the user is allowed to do.

getUserCurrentV1

Map<String,Object> getUserCurrentV1(@Nullable List<String> expand)

GetUserCurrentV1 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).

Parameters:

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`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

getUserMemberofV1

GroupArrayWithLinks getUserMemberofV1(@NonNull String accountId,
 @Nullable Integer start,
 @Nullable Integer limit)

GetUserMemberofV1 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).

Parameters:

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`.

start - The starting index of the returned groups.

limit - The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

getUserBulkV1

BulkUserLookupArray getUserBulkV1(@NonNull String accountId,
 @Nullable List<String> expand)

GetUserBulkV1 Get multiple users using ids Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameters:

accountId - A list of accountId's of users to be returned.

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`(@deprecated) use `isGuest` instead to return whether the user is a guest.

getUserWatchContentByContentIdv1

UserWatch getUserWatchContentByContentIdv1(@NonNull String contentId,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

GetUserWatchContentByContentIDV1 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).

Parameters:

contentId - The ID of the content to be queried for whether the specified user is watching it.

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.

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.

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`.

postUserWatchContentByContentIdv1

void postUserWatchContentByContentIdv1(@NonNull String contentId,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

PostUserWatchContentByContentIDV1 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).

Parameters:

contentId - The ID of the content to add the watcher to.

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.

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.

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`.

deleteUserWatchContentByContentIdv1

void deleteUserWatchContentByContentIdv1(@NonNull String xAtlassianToken,
 @NonNull String contentId,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

DeleteUserWatchContentByContentIDV1 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).

Parameters:

xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.

contentId - The ID of the content to remove the watcher from.

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.

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.

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`.

getUserWatchLabelByLabelNameV1

UserWatch getUserWatchLabelByLabelNameV1(@NonNull String labelName,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

GetUserWatchLabelByLabelNameV1 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).

Parameters:

labelName - The name of the label to be queried for whether the specified user is watching it.

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.

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.

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`.

postUserWatchLabelByLabelNameV1

void postUserWatchLabelByLabelNameV1(@NonNull String xAtlassianToken,
 @NonNull String labelName,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

PostUserWatchLabelByLabelNameV1 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).

Parameters:

xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.

labelName - The name of the label to add the watcher to.

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.

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.

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`.

deleteUserWatchLabelByLabelNameV1

void deleteUserWatchLabelByLabelNameV1(@NonNull String labelName,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

DeleteUserWatchLabelByLabelNameV1 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).

Parameters:

labelName - The name of the label to remove the watcher from.

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.

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.

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`.

getUserWatchSpaceBySpaceKeyV1

UserWatch getUserWatchSpaceBySpaceKeyV1(@NonNull String spaceKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

GetUserWatchSpaceBySpaceKeyV1 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).

Parameters:

spaceKey - The key of the space to be queried for whether the specified user is watching it.

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.

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.

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`.

postUserWatchSpaceBySpaceKeyV1

void postUserWatchSpaceBySpaceKeyV1(@NonNull String xAtlassianToken,
 @NonNull String spaceKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

PostUserWatchSpaceBySpaceKeyV1 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).

Parameters:

xAtlassianToken - Note, you must add header when making a request, as this operation has XSRF protection.

spaceKey - The key of the space to add the watcher to.

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.

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.

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`.

deleteUserWatchSpaceBySpaceKeyV1

void deleteUserWatchSpaceBySpaceKeyV1(@NonNull String spaceKey,
 @Nullable String key,
 @Nullable String username,
 @Nullable String accountId)

DeleteUserWatchSpaceBySpaceKeyV1 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).

Parameters:

spaceKey - The key of the space to remove the watcher from.

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.

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.

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`.

getUserEmailV1

AccountIDEmailRecord getUserEmailV1(@NonNull String accountId)

GetUserEmailV1 Get user email address Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, 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). For Forge apps, this API only supports access via asApp() requests. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameters:

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.

getUserEmailBulkV1

List<AccountIDEmailRecord> getUserEmailBulkV1(@NonNull List<String> accountId)

GetUserEmailBulkV1 Get user email addresses in batch Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, 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). For Forge apps, this API only supports access via asApp() requests. 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).

Parameters:

accountId - The account IDs of the users.

getAnalyticsContentByContentIdviewsV1

GetViewsR200 getAnalyticsContentByContentIdviewsV1(@NonNull String contentId,
 @Nullable String fromDate)

GetAnalyticsContentByContentIDViewsV1 Get views Get the total number of views a piece of content has.

Parameters:

contentId - The ID of the content to get the views for.

fromDate - The number of views for the content since the date.

getAnalyticsContentByContentIdviewersV1

GetViewersR200 getAnalyticsContentByContentIdviewersV1(@NonNull String contentId,
 @Nullable String fromDate)

GetAnalyticsContentByContentIDViewersV1 Get viewers Get the total number of distinct viewers a piece of content has.

Parameters:

contentId - The ID of the content to get the viewers for.

fromDate - The number of views for the content since the date.

getUserByUserIdpropertyV1

UserPropertyKeyArray getUserByUserIdpropertyV1(@NonNull String userId,
 @Nullable Integer start,
 @Nullable Integer limit)

GetUserByUserIDPropertyV1 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).

Parameters:

userId - The account ID of the user to be queried for its properties.

start - The starting index of the returned properties.

limit - The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

getUserByUserIdpropertyByKeyV1

UserProperty getUserByUserIdpropertyByKeyV1(@NonNull String userId,
 @NonNull String key)

GetUserByUserIDPropertyByKeyV1 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).

Parameters:

userId - The account ID of the user to be queried for its properties.

key - The key of the user property.

putUserByUserIdpropertyByKeyV1

void putUserByUserIdpropertyByKeyV1(@NonNull String userId,
 @NonNull String key,
 @NonNull UserPropertyUpdate payload)

PutUserByUserIDPropertyByKeyV1 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).

Parameters:

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

key - The key of the user property.

payload - The user property to be updated.

postUserByUserIdpropertyByKeyV1

void postUserByUserIdpropertyByKeyV1(@NonNull String userId,
 @NonNull String key,
 @NonNull UserPropertyCreate payload)

PostUserByUserIDPropertyByKeyV1 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).

Parameters:

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

key - The key of the user property.

payload - The user property to be created.

deleteUserByUserIdpropertyByKeyV1

void deleteUserByUserIdpropertyByKeyV1(@NonNull String userId,
 @NonNull String key)

DeleteUserByUserIDPropertyByKeyV1 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).

Parameters:

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

key - The key of the user property.