com.mcparmory/atlassian-confluence

Adds a new attachment to a piece of content. To update an existing attachment instead, use the create or update attachments operation. Requires X-Atlassian-Token: nocheck header to prevent XSRF attacks.

Adds access restrictions to a piece of content. This operation appends new restrictions without modifying any existing ones. Requires permission to edit the target content.

Adds one or more labels to existing content without removing previously assigned labels. This operation is additive and preserves all existing labels on the content.

Adds one or more labels to a space without removing existing labels. This operation appends new labels to the space's current label set.

Adds a user as a member to a group by its groupId. Requires site admin permissions.

Apply a theme to a Confluence space. Requires 'Admin' permission for the space. To reset to the default theme, use the reset_space_theme operation instead.

Archives a list of pages by their content IDs. The archival process is asynchronous; use the /longtask/<taskId> endpoint to monitor progress.

Checks whether a specific content restriction applies to a user. Returns true if the restriction is enforced for that user, though this does not guarantee access due to inherited restrictions, space permissions, or product access levels.

Check whether a user is watching a specific piece of content. Requires 'Confluence Administrator' permission if checking another user's status, otherwise only 'Can use' permission is needed.

Checks whether a content restriction applies to a specific group. Returns true if the group has the specified restriction (read or update) on the content, though this does not guarantee group access due to other permission factors.

Check whether a user is watching a specific label in Confluence. If no user is specified, the currently logged-in user is checked.

Check whether a specific relationship exists between two entities. Relationships are directional, so the source and target entities matter. For example, you can check if a user has marked a page as a favorite.

Check whether a user is watching a specific space. Identifies the user via account ID query parameter or uses the currently logged-in user if not specified.

Asynchronously converts multiple content bodies between supported formats in bulk, with a maximum of 10 conversions per request. Conversion tasks remain available for polling for up to 5 minutes after completion.

Asynchronously convert content body between different formats (storage, editor, atlas_doc_format, view variants). Returns an asyncId to retrieve the conversion result, which remains available for 5 minutes after completion.

Asynchronously converts a macro body to a specified content representation format. Returns a task ID that can be used to retrieve the conversion result, which remains available for 5 minutes after completion.

Copies a single page with its associated properties, permissions, attachments, and custom contents to a specified destination (space, parent page, parent content, or existing page).

Copy an entire page hierarchy including all descendant pages, with optional copying of attachments, permissions, properties, labels, and custom contents. Returns a long-running task ID to track the copy operation progress.

Creates a new user group in Confluence. Requires site administrator permissions.

Creates a new private space visible only to the creator. Requires 'Create Space(s)' global permission.

Creates a relationship between two Confluence entities (user, space, or content). Supports built-in relationships like 'favourite' (save for later) as well as custom relationship types.

Creates a new space in Confluence. Requires 'Create Space(s)' global permission. Note that space labels cannot be set during creation.

Creates a new content template for a space or globally. Requires 'Admin' permission for the space or 'Confluence Administrator' global permission. Note: blueprint templates cannot be created via this API.

Delete a historical version of content. The changes from the deleted version are automatically rolled up into the next version. Note that the current version cannot be deleted.

Delete a user group from the Confluence instance. Requires site administrator permissions.

Asynchronously delete a page and all its descendants by moving them to the space's trash. Only supported for pages with current status. Returns a task ID to track the deletion progress.

Removes a relationship between two Confluence entities (user, space, or content). For favourite relationships, users can only delete their own, while space administrators can delete any user's favourites.

Permanently deletes a space without sending it to trash. The deletion occurs as a long-running task, so the space may not be immediately deleted when the response is returned. Poll the status link in the response to monitor task completion.

Removes a specific permission from a space. Deleting Read Space permission for a user or group will cascade and remove all other space permissions for that user or group.

Deletes a template, with behavior varying by template type: content templates are removed, modified space-level or global-level blueprint templates revert to their parent templates, and unmodified blueprint templates cannot be deleted. Requires 'Admin' permission for space templates or 'Confluence Administrator' global permission for global templates.

Retrieves a download URI for an attachment associated with a piece of content. The client is redirected to a URL that serves the attachment's binary data.

Retrieve email addresses for multiple users in a single batch request, bypassing profile visibility restrictions. This operation requires appropriate permissions and is subject to app approval guidelines for Connect apps or asApp() context for Forge apps.

Retrieves information about how anonymous users are represented in Confluence, including their profile picture and display name. Requires 'Can use' global permission to access the Confluence site.

Retrieve the converted content body for a completed asynchronous conversion task, or check the current status if the task is still processing. Completed results are available for up to 5 minutes or until a new conversion request is made with caching disabled.

Retrieve completed content body conversion results for multiple asynchronous tasks. Results are available for up to 5 minutes after task completion or until a new conversion request is made with caching disabled.

Retrieves access restrictions for a specific content item based on the operation type (read or update). Returns the users and groups with restrictions applied to that content.

Retrieves the current state of a content item, supporting draft, current, or archived versions. Requires permission to view the specified content.

Retrieve the total number of distinct viewers for a specific piece of content, optionally filtered by a start date.

Retrieve the total number of views for a specific piece of content, optionally filtered from a given date onwards.

Retrieves the currently authenticated user's profile information, including display name, user key, account ID, and profile picture. Requires 'Can use' global permission to access the Confluence site.

Retrieve a user group by its unique identifier. Requires permission to access the Confluence site.

Retrieve the status of an active long-running task such as a space export, including elapsed time and completion percentage. Requires 'Can use' global permission to access the Confluence site.

Retrieves the body of a macro in storage format, including macro name, body content, and parameters. Returns macro metadata for the specified macro ID within a particular content version.

Retrieves the body of a macro in a specified content representation format. Returns macro metadata including name, body, and parameters for a given macro ID and content version.

Retrieves the theme configuration for a space. If no custom theme is set, the space inherits the global look and feel settings.

Retrieves a content template with its metadata, including name, space or blueprint location, and template body. Requires 'View' permission for space templates or 'Can use' global permission for global templates.

Retrieve detailed information about a specific user, including display name, account ID, profile picture, and other profile data. Information returned may be restricted based on the user's profile visibility settings.

Retrieves a specific property for a Confluence user by its key. User properties are stored at the site level and require 'Can use' global permission to access.

Grants a new custom content permission to a user or group within a Confluence space. Only apps can modify app-specific permissions, and the requesting user must have Admin permission for the space.

Grant read or update permission to a group for a piece of content by adding the group to the content restriction. Requires permission to edit the content.