Confluence (API Token)
Create and manage content in Confluence using API token authentication.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 211 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_admin_key | Returns information about the admin key if one is currently enabled for the calling user within the site. Permissionshttps://support.atlassian.com/user-management/docs/give-users-admin-permissions/ Centralized-user-management-content required: User must be an organization or site admin. | No parameters |
| post_admin_key | Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time. Note: The durationInMinutes field within the request body is optional. If the request body is empty or if the durationInMinutes is set to 0 minutes, a new admin key will be issued to the calling user with a default duration of 10 minutes. Permissionshttps://support.atlassian.com/user-management/docs/give-users-admin-permissions/ C | data: { . durationInMinutes (integer) } (object) required |
| delete_admin_key | Disables admin key access for the calling user within the site. Permissionshttps://support.atlassian.com/user-management/docs/give-users-admin-permissions/ Centralized-user-management-content required: User must be an organization or site admin. | No parameters |
| get_attachments | Returns all attachments. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the container of the attachment. | sort (string) cursor (string) status (array) mediaType (string) filename (string) limit (integer) |
| get_attachments_by_id | Returns a specific attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment's container. | id (string) version (integer) include-labels (boolean) include-properties (boolean) include-operations (boolean) include-versions (boolean) include-version (boolean) include-collaborators (boolean) |
| delete_attachments_by_id | Delete an attachment by id. Deleting an attachment moves the attachment to the trash, where it can be restored later. To permanently delete an attachment or 'purge' it, the endpoint must be called on a trashed attachment with the following param purge=true. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the container of the attachment. Permission to delete attachments in the space. Permission to administer the space if attempting to purge. | id (integer) purge (boolean) |
| get_attachments_by_id_labels | Returns the labels of specific attachment. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the attachment and its corresponding space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_attachments_by_id_operations | Returns the permitted operations on specific attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the attachment and its corresponding space. | id (string) |
| get_attachments_by_attachment_id_properties | Retrieves all Content Properties tied to a specified attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment. | attachment-id (string) key (string) sort (string) cursor (string) limit (integer) |
| post_attachments_by_attachment_id_properties | Creates a new content property for an attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the attachment. | attachment-id (string) data: { . key (string) . value } (object) required |
| get_attachments_by_attachment_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment. | attachment-id (string) property-id (integer) |
| put_attachments_by_attachment_id_properties_by_property_id | Update a content property for attachment by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the attachment. | attachment-id (string) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_attachments_by_attachment_id_properties_by_property_id | Deletes a content property for an attachment by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to attachment the page. | attachment-id (string) property-id (integer) |
| get_attachments_by_id_versions | Returns the versions of specific attachment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment and its corresponding space. | id (string) cursor (string) limit (integer) sort (string) |
| get_attachments_by_attachment_id_versions_by_version_number | Retrieves version details for the specified attachment and version number. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment. | attachment-id (string) version-number (integer) |
| get_attachments_by_id_footer_comments | Returns the comments of the specific attachment. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment and its corresponding containers. | id (string) body-format (string) cursor (string) limit (integer) sort (string) version (integer) |
| get_blogposts | Returns all blog posts. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only blog posts that the user has permission to view will be returned. | id (array) space-id (array) sort (string) status (array) title (string) body-format (string) cursor (string) limit (integer) |
| post_blogposts | Creates a new blog post in the space specified by the spaceId. By default this will create the blog post as a non-draft, unless the status is specified as draft. If creating a non-draft, the title must not be empty. Currently only supports the storage representation specified in the body.representation enums below | private (boolean) data: { . spaceId (string) . status (string) . title (string) . body . createdAt (string) } (object) required |
| get_blogposts_by_id | Returns a specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post and its corresponding space. | id (integer) body-format (string) get-draft (boolean) status (array) version (integer) include-labels (boolean) include-properties (boolean) include-operations (boolean) include-likes (boolean) include-versions (boolean) include-version (boolean) include-favorited-by-current-user-status (boolean) include-webresources (boolean) include-collaborators (boolean) |
| put_blogposts_by_id | Update a blog post by id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post and its corresponding space. Permission to update blog posts in the space. | id (integer) data: { . id (string) . status (string) . title (string) . spaceId (string) . body . version (object) . createdAt (string) } (object) required |
| delete_blogposts_by_id | Delete a blog post by id. By default this will delete blog posts that are non-drafts. To delete a blog post that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted. Deleting a blog post that is not a draft moves the blog post to the trash, where it can be restored later. To permanently delete a blog post or 'purge' it, the endpoint must be called on a trashed blog post with the followin | id (integer) purge (boolean) draft (boolean) |
| get_blogposts_by_id_attachments | Returns the attachments of specific blog post. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. | id (integer) sort (string) cursor (string) status (array) mediaType (string) filename (string) limit (integer) |
| get_blogposts_by_id_custom_content | Returns all custom content for a given type within a given blogpost. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content, the container of the custom content blog post, and the corresponding space. | id (integer) type (string) required sort (string) cursor (string) limit (integer) body-format (string) |
| get_blogposts_by_id_labels | Returns the labels of specific blog post. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_blogposts_by_id_likes_count | Returns the count of likes of specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. | id (integer) |
| get_blogposts_by_id_likes_users | Returns the account IDs of likes of specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. | id (integer) cursor (string) limit (integer) |
| get_blogposts_by_blogpost_id_properties | Retrieves all Content Properties tied to a specified blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post. | blogpost-id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_blogposts_by_blogpost_id_properties | Creates a new property for a blogpost. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the blog post. | blogpost-id (integer) data: { . key (string) . value } (object) required |
| get_blogposts_by_blogpost_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post. | blogpost-id (integer) property-id (integer) |
| put_blogposts_by_blogpost_id_properties_by_property_id | Update a content property for blog post by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the blog post. | blogpost-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_blogposts_by_blogpost_id_properties_by_property_id | Deletes a content property for a blogpost by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the blog post. | blogpost-id (integer) property-id (integer) |
| get_blogposts_by_id_operations | Returns the permitted operations on specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the blog post and its corresponding space. | id (integer) |
| get_blogposts_by_id_versions | Returns the versions of specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post and its corresponding space. | id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| get_blogposts_by_blogpost_id_versions_by_version_number | Retrieves version details for the specified blog post and version number. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the blog post. | blogpost-id (integer) version-number (integer) |
| post_content_convert_ids_to_types | Converts a list of content ids into their associated content types. This is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. This will return types as they should be used in v2. Notably, this will return inline-comment for inline comments and footer-comment for footer comments, which is distinct from them both being represented by comment in v1. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the reque | data: { . contentIds (array) } (object) required |
| get_custom_content | Returns all custom content for a given type. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content, the container of the custom content, and the corresponding space if different from the container. | type (string) required id (array) space-id (array) sort (string) cursor (string) limit (integer) body-format (string) |
| post_custom_content | Creates a new custom content in the given space, page, blogpost or other custom content. Only one of spaceId, pageId, blogPostId, or customContentId is required in the request body. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create custom content in the space. | data: { . type (string) . status (string) . spaceId (string) . pageId (string) . blogPostId (string) . customContentId (string) . title (string) . body } (object) required |
| get_custom_content_by_id | Returns a specific piece of custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content, the container of the custom content, and the corresponding space if different from the container. | id (integer) body-format (string) version (integer) include-labels (boolean) include-properties (boolean) include-operations (boolean) include-versions (boolean) include-version (boolean) include-collaborators (boolean) |
| put_custom_content_by_id | Update a custom content by id. At most one of spaceId, pageId, blogPostId, or customContentId is allowed in the request body. Note that if spaceId is specified, it must be the same as the spaceId used for creating the custom content as moving custom content to a different space is not supported. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to update custom content in the space. | id (integer) data: { . id (string) . type (string) . status (string) . spaceId (string) . pageId (string) . blogPostId (string) . customContentId (string) . title (string) . body . version (object) } (object) required |
| delete_custom_content_by_id | Delete a custom content by id. Deleting a custom content will either move it to the trash or permanently delete it purge it, depending on the apiSupport. To permanently delete a trashed custom content, the endpoint must be called with the following param purge=true. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete custom content in the space. Permission to administer the space | id (integer) purge (boolean) |
| get_custom_content_by_id_attachments | Returns the attachments of specific custom content. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the custom content and its corresponding space. | id (integer) sort (string) cursor (string) status (array) mediaType (string) filename (string) limit (integer) |
| get_custom_content_by_id_footer_comments | Returns the comments of the specific custom content. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content and its corresponding containers. | id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| get_custom_content_by_id_labels | Returns the labels for a specific piece of custom content. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content and its corresponding space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_custom_content_by_id_operations | Returns the permitted operations on specific custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the custom content and its corresponding space. | id (integer) |
| get_custom_content_by_custom_content_id_properties | Retrieves Content Properties tied to a specified custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content. | custom-content-id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_custom_content_by_custom_content_id_properties | Creates a new content property for a piece of custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the custom content. | custom-content-id (integer) data: { . key (string) . value } (object) required |
| get_custom_content_by_custom_content_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page. | custom-content-id (integer) property-id (integer) |
| put_custom_content_by_custom_content_id_properties_by_property_id | Update a content property for a piece of custom content by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the custom content. | custom-content-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_custom_content_by_custom_content_id_properties_by_property_id | Deletes a content property for a piece of custom content by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the custom content. | custom-content-id (integer) property-id (integer) |
| get_labels | Returns all labels. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only labels that the user has permission to view will be returned. | label-id (array) prefix (array) cursor (string) sort (string) limit (integer) |
| get_labels_by_id_attachments | Returns the attachments of specified label. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the attachment and its corresponding space. | id (integer) sort (string) cursor (string) limit (integer) |
| get_labels_by_id_blogposts | Returns the blogposts of specified label. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) space-id (array) body-format (string) sort (string) cursor (string) limit (integer) |
| get_labels_by_id_pages | Returns the pages of specified label. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) space-id (array) body-format (string) sort (string) cursor (string) limit (integer) |
| get_pages | Returns all pages. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only pages that the user has permission to view will be returned. | id (array) space-id (array) sort (string) status (array) title (string) body-format (string) subtype (string) cursor (string) limit (integer) |
| post_pages | Creates a page in the space. Pages are created as published by default unless specified as a draft in the status field. If creating a published page, the title must be specified. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. Permission to create a page in the space. | embedded (boolean) private (boolean) root-level (boolean) data: { . spaceId (string) . status (string) . title (string) . parentId (string) . body . subtype (string) } (object) required |
| get_pages_by_id | Returns a specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page and its corresponding space. | id (integer) body-format (string) get-draft (boolean) status (array) version (integer) include-labels (boolean) include-properties (boolean) include-operations (boolean) include-likes (boolean) include-versions (boolean) include-version (boolean) include-favorited-by-current-user-status (boolean) include-webresources (boolean) include-collaborators (boolean) include-direct-children (boolean) |
| put_pages_by_id | Update a page by id. When the 'current' version is updated, the provided body content is considered as the latest version. This latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm. If two versions are significantly diverged, the latest provided content may entirely override what was previously in the draft. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page and its corresponding space. Pe | id (integer) data: { . id (string) . status (string) . title (string) . spaceId . parentId . ownerId . body . version (object) } (object) required |
| delete_pages_by_id | Delete a page by id. By default this will delete pages that are non-drafts. To delete a page that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted. Deleting a page moves the page to the trash, where it can be restored later. To permanently delete a page or 'purge' it, the endpoint must be called on a trashed page with the following param purge=true. Permissionshttps://confluence.atla | id (integer) purge (boolean) draft (boolean) |
| get_pages_by_id_attachments | Returns the attachments of specific page. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) sort (string) cursor (string) status (array) mediaType (string) filename (string) limit (integer) |
| get_pages_by_id_custom_content | Returns all custom content for a given type within a given page. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content, the container of the custom content page, and the corresponding space. | id (integer) type (string) required sort (string) cursor (string) limit (integer) body-format (string) |
| get_pages_by_id_labels | Returns the labels of specific page. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_pages_by_id_likes_count | Returns the count of likes of specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) |
| get_pages_by_id_likes_users | Returns the account IDs of likes of specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) cursor (string) limit (integer) |
| get_pages_by_id_operations | Returns the permitted operations on specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the page and its corresponding space. | id (integer) |
| get_pages_by_page_id_properties | Retrieves Content Properties tied to a specified page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page. | page-id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_pages_by_page_id_properties | Creates a new content property for a page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the page. | page-id (integer) data: { . key (string) . value } (object) required |
| get_pages_by_page_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page. | page-id (integer) property-id (integer) |
| put_pages_by_page_id_properties_by_property_id | Update a content property for a page by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the page. | page-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_pages_by_page_id_properties_by_property_id | Deletes a content property for a page by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the page. | page-id (integer) property-id (integer) |
| post_pages_by_id_redact | Redacts sensitive content in a Confluence page by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration except code block redactions. The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID. Note: This endpoint requires Atlassian Guard Premium. | id (integer) data: { . createdAt (string) . cleanHistory (boolean) . body (object) . title (object) } (object) required |
| post_blogposts_by_id_redact | Redacts sensitive content in a Confluence blog post by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration except code block redactions. The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID. Note: This endpoint requires Atlassian Guard Premium. | id (integer) data: { . createdAt (string) . cleanHistory (boolean) . body (object) . title (object) } (object) required |
| put_pages_by_id_title | Updates the title of a specified page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page and its corresponding space. Permission to update pages in the space. | id (integer) data: { . status (string) . title (string) } (object) required |
| get_pages_by_id_versions | Returns the versions of specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page and its corresponding space. | id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| post_whiteboards | Creates a whiteboard in the space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. Permission to create a whiteboard in the space. | private (boolean) data: { . spaceId (string) . title (string) . parentId (string) . templateKey (string) . locale (string) } (object) required |
| get_whiteboards_by_id | Returns a specific whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the whiteboard and its corresponding space. | id (integer) include-collaborators (boolean) include-direct-children (boolean) include-operations (boolean) include-properties (boolean) |
| delete_whiteboards_by_id | Delete a whiteboard by id. Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space. | id (integer) |
| get_whiteboards_by_id_properties | Retrieves Content Properties tied to a specified whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the whiteboard. | id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_whiteboards_by_id_properties | Creates a new content property for a whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the whiteboard. | id (integer) data: { . key (string) . value } (object) required |
| get_whiteboards_by_whiteboard_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the whiteboard. | whiteboard-id (integer) property-id (integer) |
| put_whiteboards_by_whiteboard_id_properties_by_property_id | Update a content property for a whiteboard by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the whiteboard. | whiteboard-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_whiteboards_by_whiteboard_id_properties_by_property_id | Deletes a content property for a whiteboard by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the whiteboard. | whiteboard-id (integer) property-id (integer) |
| get_whiteboards_by_id_operations | Returns the permitted operations on specific whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the whiteboard and its corresponding space. | id (integer) |
| get_whiteboards_by_id_direct_children | Returns all children for given whiteboard id in the content tree. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. The following types of content will be returned: - Database - Embed - Folder - Page - Whiteboard This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as: - Get database by idhttp | id (integer) cursor (string) limit (integer) sort (string) |
| get_whiteboards_by_id_descendants | Returns descendants in the content tree for a given whiteboard by ID in top-to-bottom order that is, the highest descendant is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched. The following types of content will be returned: - Database - Embed - Folder | id (integer) limit (integer) depth (integer) cursor (string) |
| get_whiteboards_by_id_ancestors | Returns all ancestors for a given whiteboard by ID in top-to-bottom order that is, the highest ancestor is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get whiteboard by idhttps://developer.atlass | id (integer) limit (integer) |
| post_databases | Creates a database in the space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. Permission to create a database in the space. | private (boolean) data: { . spaceId (string) . title (string) . parentId (string) } (object) required |
| get_databases_by_id | Returns a specific database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the database and its corresponding space. | id (integer) include-collaborators (boolean) include-direct-children (boolean) include-operations (boolean) include-properties (boolean) |
| delete_databases_by_id | Delete a database by id. Deleting a database moves the database to the trash, where it can be restored later Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the database and its corresponding space. Permission to delete databases in the space. | id (integer) |
| get_databases_by_id_properties | Retrieves Content Properties tied to a specified database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the database. | id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_databases_by_id_properties | Creates a new content property for a database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the database. | id (integer) data: { . key (string) . value } (object) required |
| get_databases_by_database_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the database. | database-id (integer) property-id (integer) |
| put_databases_by_database_id_properties_by_property_id | Update a content property for a database by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the database. | database-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_databases_by_database_id_properties_by_property_id | Deletes a content property for a database by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the database. | database-id (integer) property-id (integer) |
| get_databases_by_id_operations | Returns the permitted operations on specific database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the database and its corresponding space. | id (integer) |
| get_databases_by_id_direct_children | Returns all children for given database id in the content tree. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. The following types of content will be returned: - Database - Embed - Folder - Page - Whiteboard This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as: - Get database by idhttps: | id (integer) cursor (string) limit (integer) sort (string) |
| get_databases_by_id_descendants | Returns descendants in the content tree for a given database by ID in top-to-bottom order that is, the highest descendant is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched. The following types of content will be returned: - Database - Embed - Folder - | id (integer) limit (integer) depth (integer) cursor (string) |
| get_databases_by_id_ancestors | Returns all ancestors for a given database by ID in top-to-bottom order that is, the highest ancestor is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get database by idhttps://developer.atlassian. | id (integer) limit (integer) |
| post_embeds | Creates a Smart Link in the content tree in the space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. Permission to create a Smart Link in the content tree in the space. | data: { . spaceId (string) . title (string) . parentId (string) . embedUrl (string) } (object) required |
| get_embeds_by_id | Returns a specific Smart Link in the content tree. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the Smart Link in the content tree and its corresponding space. | id (integer) include-collaborators (boolean) include-direct-children (boolean) include-operations (boolean) include-properties (boolean) |
| delete_embeds_by_id | Delete a Smart Link in the content tree by id. Deleting a Smart Link in the content tree moves the Smart Link to the trash, where it can be restored later Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the Smart Link in the content tree and its corresponding space. Permission to delete Smart Links in the content tree in the space. | id (integer) |
| get_embeds_by_id_properties | Retrieves Content Properties tied to a specified Smart Link in the content tree. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the Smart Link in the content tree. | id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_embeds_by_id_properties | Creates a new content property for a Smart Link in the content tree. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the Smart Link in the content tree. | id (integer) data: { . key (string) . value } (object) required |
| get_embeds_by_embed_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified Smart Link in the content tree. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the Smart Link in the content tree. | embed-id (integer) property-id (integer) |
| put_embeds_by_embed_id_properties_by_property_id | Update a content property for a Smart Link in the content tree by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the Smart Link in the content tree. | embed-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_embeds_by_embed_id_properties_by_property_id | Deletes a content property for a Smart Link in the content tree by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the Smart Link in the content tree. | embed-id (integer) property-id (integer) |
| get_embeds_by_id_operations | Returns the permitted operations on specific Smart Link in the content tree. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the Smart Link in the content tree and its corresponding space. | id (integer) |
| get_embeds_by_id_direct_children | Returns all children for given smart link id in the content tree. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. The following types of content will be returned: - Database - Embed - Folder - Page - Whiteboard This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as: - Get database by idhttp | id (integer) cursor (string) limit (integer) sort (string) |
| get_embeds_by_id_descendants | Returns descendants in the content tree for a given smart link by ID in top-to-bottom order that is, the highest descendant is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched. The following types of content will be returned: - Database - Embed - Folder | id (integer) limit (integer) depth (integer) cursor (string) |
| get_embeds_by_id_ancestors | Returns all ancestors for a given Smart Link in the content tree by ID in top-to-bottom order that is, the highest ancestor is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get Smart Link in the c | id (integer) limit (integer) |
| post_folders | Creates a folder in the space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. Permission to create a folder in the space. | data: { . spaceId (string) . title (string) . parentId (string) } (object) required |
| get_folders_by_id | Returns a specific folder. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the folder and its corresponding space. | id (integer) include-collaborators (boolean) include-direct-children (boolean) include-operations (boolean) include-properties (boolean) |
| delete_folders_by_id | Delete a folder by id. Deleting a folder moves the folder to the trash, where it can be restored later Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the folder and its corresponding space. Permission to delete folders in the space. | id (integer) |
| get_folders_by_id_properties | Retrieves Content Properties tied to a specified folder. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the folder. | id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_folders_by_id_properties | Creates a new content property for a folder. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the folder. | id (integer) data: { . key (string) . value } (object) required |
| get_folders_by_folder_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified folder. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the folder. | folder-id (integer) property-id (integer) |
| put_folders_by_folder_id_properties_by_property_id | Update a content property for a folder by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the folder. | folder-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_folders_by_folder_id_properties_by_property_id | Deletes a content property for a folder by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the folder. | folder-id (integer) property-id (integer) |
| get_folders_by_id_operations | Returns the permitted operations on specific folder. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the folder and its corresponding space. | id (integer) |
| get_folders_by_id_direct_children | Returns all children for given folder id in the content tree. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. The following types of content will be returned: - Database - Embed - Folder - Page - Whiteboard This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as: - Get database by idhttps:// | id (integer) cursor (string) limit (integer) sort (string) |
| get_folders_by_id_descendants | Returns descendants in the content tree for a given folder by ID in top-to-bottom order that is, the highest descendant is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched. The following types of content will be returned: - Database - Embed - Folder - Pa | id (integer) limit (integer) depth (integer) cursor (string) |
| get_folders_by_id_ancestors | Returns all ancestors for a given folder by ID in top-to-bottom order that is, the highest ancestor is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get folder by idhttps://developer.atlassian.com | id (integer) limit (integer) |
| get_pages_by_page_id_versions_by_version_number | Retrieves version details for the specified page and version number. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page. | page-id (integer) version-number (integer) |
| get_custom_content_by_custom_content_id_versions | Returns the versions of specific custom content. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content and its corresponding page and space. | custom-content-id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| get_custom_content_by_custom_content_id_versions_by_version_number | Retrieves version details for the specified custom content and version number. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the page. | custom-content-id (integer) version-number (integer) |
| get_spaces | Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only spaces that the user has permission to view will be returned. | ids (array) keys (array) type (string) status (string) labels (array) favorited-by (string) not-favorited-by (string) sort (string) description-format (string) include-icon (boolean) cursor (string) limit (integer) |
| post_spaces | Creates a Space as specified in the payload. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to create spaces. | data: { . name (string) . key (string) . alias (string) . description (object) . roleAssignments (array) . copySpaceAccessConfiguration (integer) . createPrivateSpace (boolean) } (object) required |
| get_spaces_by_id | Returns a specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the space. | id (integer) description-format (string) include-icon (boolean) include-operations (boolean) include-properties (boolean) include-permissions (boolean) include-role-assignments (boolean) include-labels (boolean) |
| get_spaces_by_id_blogposts | Returns all blog posts in a space. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and view the space. Only blog posts that the user has permission to view will be returned. | id (integer) sort (string) status (array) title (string) body-format (string) cursor (string) limit (integer) |
| get_spaces_by_id_labels | Returns the labels of specific space. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_spaces_by_id_content_labels | Returns the labels of space content pages, blogposts etc. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the space. Only labels that the user has permission to view will be returned. | id (integer) prefix (string) sort (string) cursor (string) limit (integer) |
| get_spaces_by_id_custom_content | Returns all custom content for a given type within a given space. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the custom content and the corresponding space. | id (integer) type (string) required cursor (string) limit (integer) body-format (string) |
| get_spaces_by_id_operations | Returns the permitted operations on specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the corresponding space. | id (integer) |
| get_spaces_by_id_pages | Returns all pages in a space. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'View' permission for the space. Only pages that the user has permission to view will be returned. | id (integer) depth (string) sort (string) status (array) title (string) body-format (string) cursor (string) limit (integer) |
| get_spaces_by_space_id_properties | Returns all properties for the given space. Space properties are a key-value storage associated with a space. The limit parameter specifies the maximum number of results returned in a single response. Use the link response header to paginate through additional results. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'View' permission for the space. | space-id (integer) key (string) cursor (string) limit (integer) |
| post_spaces_by_space_id_properties | Creates a new space property. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'Admin' permission for the space. | space-id (integer) data: { . key (string) . value } (object) required |
| get_spaces_by_space_id_properties_by_property_id | Retrieve a space property by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'View' permission for the space. | space-id (integer) property-id (integer) |
| put_spaces_by_space_id_properties_by_property_id | Update a space property by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'Admin' permission for the space. | space-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_spaces_by_space_id_properties_by_property_id | Deletes a space property by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission and 'Admin' permission for the space. | space-id (integer) property-id (integer) |
| get_spaces_by_id_permissions | Returns space permission assignments for a specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the space. | id (integer) cursor (string) limit (integer) |
| get_space_permissions | Retrieves the available space permissions. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site. | cursor (string) limit (integer) |
| get_space_roles | Retrieves the available space roles. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site; if requesting a certain space's roles, permission to view the space. | space-id (string) role-type (string) principal-id (string) principal-type (string) cursor (string) limit (integer) |
| post_space_roles | Create a space role. Permissionshttps://confluence.atlassian.com/x/_AozKw required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource. | data: { . name (string) . description (string) . spacePermissions (array) } (object) required |
| get_space_roles_by_id | Retrieves the space role by ID. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site. | id (integer) |
| put_space_roles_by_id | Update a space role. Permissionshttps://confluence.atlassian.com/x/_AozKw required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource. | id (string) data: { . name (string) . description (string) . spacePermissions (array) . anonymousReassignmentRoleId (string) . guestReassignmentRoleId (string) } (object) required |
| delete_space_roles_by_id | Delete a space role Permissionshttps://confluence.atlassian.com/x/_AozKw required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource. | id (string) |
| get_space_role_mode | Retrieves the space role mode. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. | No parameters |
| get_spaces_by_id_role_assignments | Retrieves the space role assignments. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the space. | id (integer) role-id (string) role-type (string) principal-id (string) principal-type (string) cursor (string) limit (integer) |
| post_spaces_by_id_role_assignments | Sets space role assignments as specified in the payload. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to manage roles in the space. | id (integer) data (array) required |
| get_pages_by_id_footer_comments | Returns the root footer comments of specific page. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) body-format (string) status (array) sort (string) cursor (string) limit (integer) |
| get_pages_by_id_inline_comments | Returns the root inline comments of specific page. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) body-format (string) status (array) resolution-status (array) sort (string) cursor (string) limit (integer) |
| get_blogposts_by_id_footer_comments | Returns the root footer comments of specific blog post. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. | id (integer) body-format (string) status (array) sort (string) cursor (string) limit (integer) |
| get_blogposts_by_id_inline_comments | Returns the root inline comments of specific blog post. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the blog post and its corresponding space. | id (integer) body-format (string) status (array) resolution-status (array) sort (string) cursor (string) limit (integer) |
| get_footer_comments | Returns all footer comments. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the container and its corresponding space. | body-format (string) sort (string) cursor (string) limit (integer) |
| post_footer_comments | Create a footer comment. The footer comment can be made against several locations: - at the top level specifying pageId or blogPostId in the request body - as a reply specifying parentCommentId in the request body - against an attachment note: this is different than the comments added via the attachment properties page on the UI, which are referred to as version comments - against a custom content Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of | data: { . blogPostId (string) . pageId (string) . parentCommentId (string) . attachmentId (string) . customContentId (string) . body } (object) required |
| get_footer_comments_by_comment_id | Retrieves a footer comment by id Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the container and its corresponding space. | comment-id (integer) body-format (string) version (integer) include-properties (boolean) include-operations (boolean) include-likes (boolean) include-versions (boolean) include-version (boolean) |
| put_footer_comments_by_comment_id | Update a footer comment. This can be used to update the body text of a comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. | comment-id (integer) data (undefined) required |
| delete_footer_comments_by_comment_id | Deletes a footer comment. This is a permanent deletion and cannot be reverted. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space. | comment-id (integer) |
| get_footer_comments_by_id_children | Returns the children footer comments of specific comment. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) body-format (string) sort (string) cursor (string) limit (integer) |
| get_footer_comments_by_id_likes_count | Returns the count of likes of specific footer comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page/blogpost and its corresponding space. | id (integer) |
| get_footer_comments_by_id_likes_users | Returns the account IDs of likes of specific footer comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page/blogpost and its corresponding space. | id (integer) cursor (string) limit (integer) |
| get_footer_comments_by_id_operations | Returns the permitted operations on specific footer comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the footer comment and its corresponding space. | id (integer) |
| get_footer_comments_by_id_versions | Retrieves the versions of the specified footer comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blog post and its corresponding space. | id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| get_footer_comments_by_id_versions_by_version_number | Retrieves version details for the specified footer comment version. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blog post and its corresponding space. | id (integer) version-number (integer) |
| get_inline_comments | Returns all inline comments. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | body-format (string) sort (string) cursor (string) limit (integer) |
| post_inline_comments | Create an inline comment. This can be at the top level specifying pageId or blogPostId in the request body or as a reply specifying parentCommentId in the request body. Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and i | data: { . blogPostId (string) . pageId (string) . parentCommentId (string) . body . inlineCommentProperties (object) } (object) required |
| get_inline_comments_by_comment_id | Retrieves an inline comment by id Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. | comment-id (integer) body-format (string) version (integer) include-properties (boolean) include-operations (boolean) include-likes (boolean) include-versions (boolean) include-version (boolean) |
| put_inline_comments_by_comment_id | Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. | comment-id (integer) data: { . version (object) . body . resolved (boolean) } (object) required |
| delete_inline_comments_by_comment_id | Deletes an inline comment. This is a permanent deletion and cannot be reverted. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space. | comment-id (integer) |
| get_inline_comments_by_id_children | Returns the children inline comments of specific comment. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page and its corresponding space. | id (integer) body-format (string) sort (string) cursor (string) limit (integer) |
| get_inline_comments_by_id_likes_count | Returns the count of likes of specific inline comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page/blogpost and its corresponding space. | id (integer) |
| get_inline_comments_by_id_likes_users | Returns the account IDs of likes of specific inline comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page/blogpost and its corresponding space. | id (integer) cursor (string) limit (integer) |
| get_inline_comments_by_id_operations | Returns the permitted operations on specific inline comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the parent content of the inline comment and its corresponding space. | id (integer) |
| get_inline_comments_by_id_versions | Retrieves the versions of the specified inline comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blog post and its corresponding space. | id (integer) body-format (string) cursor (string) limit (integer) sort (string) |
| get_inline_comments_by_id_versions_by_version_number | Retrieves version details for the specified inline comment version. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the content of the page or blog post and its corresponding space. | id (integer) version-number (integer) |
| get_comments_by_comment_id_properties | Retrieves Content Properties attached to a specified comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the comment. | comment-id (integer) key (string) sort (string) cursor (string) limit (integer) |
| post_comments_by_comment_id_properties | Creates a new content property for a comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to update the comment. | comment-id (integer) data: { . key (string) . value } (object) required |
| get_comments_by_comment_id_properties_by_property_id | Retrieves a specific Content Property by ID that is attached to a specified comment. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the comment. | comment-id (integer) property-id (integer) |
| put_comments_by_comment_id_properties_by_property_id | Update a content property for a comment by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the comment. | comment-id (integer) property-id (integer) data: { . key (string) . value . version (object) } (object) required |
| delete_comments_by_comment_id_properties_by_property_id | Deletes a content property for a comment by its id. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the comment. | comment-id (integer) property-id (integer) |
| get_tasks | Returns all tasks. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only tasks that the user has permission to view will be returned. | body-format (string) include-blank-tasks (boolean) status (string) task-id (array) space-id (array) page-id (array) blogpost-id (array) created-by (array) assigned-to (array) completed-by (array) created-at-from (integer) created-at-to (integer) due-at-from (integer) due-at-to (integer) completed-at-from (integer) completed-at-to (integer) cursor (string) limit (integer) |
| get_tasks_by_id | Returns a specific task. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to view the containing page or blog post and its corresponding space. | id (integer) body-format (string) |
| put_tasks_by_id | Update a task by id. This endpoint currently only supports updating task status. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to edit the containing page or blog post and view its corresponding space. | id (integer) body-format (string) data: { . id (string) . localId (string) . spaceId (string) . pageId (string) . blogPostId (string) . status (string) . createdBy (string) . assignedTo (string) . completedBy (string) . createdAt (string) . updatedAt (string) . dueAt (string) . completedAt (string) } (object) required |
| get_pages_by_id_children | Returns all child pages for given page id. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only pages that the user has permission to view will be returned. | id (integer) cursor (string) limit (integer) sort (string) |
| get_custom_content_by_id_children | Returns all child custom content for given custom content id. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. Only custom content that the user has permission to view will be returned. | id (integer) cursor (string) limit (integer) sort (string) |
| get_pages_by_id_direct_children | Returns all children for given page id in the content tree. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. The following types of content will be returned: - Database - Embed - Folder - Page - Whiteboard This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as: - Get database by idhttps://de | id (integer) cursor (string) limit (integer) sort (string) |
| get_pages_by_id_ancestors | Returns all ancestors for a given page by ID in top-to-bottom order that is, the highest ancestor is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get page by idhttps://developer.atlassian.com/clou | id (integer) limit (integer) |
| get_pages_by_id_descendants | Returns descendants in the content tree for a given page by ID in top-to-bottom order that is, the highest descendant is the first item in the response payload. The number of results is limited by the limit parameter and additional results if available will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched. The following types of content will be returned: - Database - Embed - Folder - Page | id (integer) limit (integer) depth (integer) cursor (string) |
| post_users_bulk | Returns user details for the ids provided in the request body. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. The user must be able to view user profiles in the Confluence site. | data: { . accountIds (array) } (object) required |
| post_user_access_check_access_by_email | Returns the list of emails from the input list that do not have access to site. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. | data: { . emails (array) } (object) required |
| post_user_access_invite_by_email | Invite a list of emails to the site. Ignores all invalid emails and no action is taken for the emails that already have access to the site. bNOTE:/b This API is asynchronous and may take some time to complete. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Permission to access the Confluence site 'Can use' global permission. | data: { . emails (array) } (object) required |
| get_data_policies_metadata | Returns data policy metadata for the workspace. Permissions permissions required: Only apps can make this request. Permission to access the Confluence site 'Can use' global permission. | No parameters |
| get_data_policies_spaces | Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results if available will be available through the next URL present in the Link response header. Permissionshttps://confluence.atlassian.com/x/_AozKw required: Only apps can make this request. Permission to access the Confluence site 'Can use' global permission. Only spaces that the app has permission to view will be returned. | ids (array) keys (array) sort (string) cursor (string) limit (integer) |
| get_classification_levels | Returns a list of classification levelshttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level available. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission. | No parameters |
| get_spaces_by_id_classification_level_default | Returns the default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/ for a specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the space. | id (integer) |
| put_spaces_by_id_classification_level_default | Update the default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/ for a specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and 'Admin' permission for the space. | id (integer) data: { . id (string) } (object) required |
| delete_spaces_by_id_classification_level_default | Returns the default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/ for a specific space. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and 'Admin' permission for the space. | id (integer) |
| get_pages_by_id_classification_level | Returns the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the page. 'Permission to edit the page is required if trying to view classification level for a draft. | id (integer) status (string) |
| put_pages_by_id_classification_level | Updates the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific page. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to edit the page. | id (integer) data: { . id (string) . status (string) } (object) required |
| post_pages_by_id_classification_level_reset | Resets the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific page for the space default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the page. | id (integer) data: { . status (string) } (object) required |
| get_blogposts_by_id_classification_level | Returns the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the blog post. 'Permission to edit the blog post is required if trying to view classification level for a draft. | id (integer) status (string) |
| put_blogposts_by_id_classification_level | Updates the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific blog post. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to edit the blog post. | id (integer) data: { . id (string) . status (string) } (object) required |
| post_blogposts_by_id_classification_level_reset | Resets the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific blog post for the space default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the blog post. | id (integer) data: { . status (string) } (object) required |
| get_whiteboards_by_id_classification_level | Returns the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the whiteboard. | id (integer) |
| put_whiteboards_by_id_classification_level | Updates the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific whiteboard. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to edit the whiteboard. | id (integer) data: { . id (string) . status (string) } (object) required |
| post_whiteboards_by_id_classification_level_reset | Resets the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific whiteboard for the space default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the whiteboard. | id (integer) data: { . status (string) } (object) required |
| get_databases_by_id_classification_level | Returns the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the database. | id (integer) |
| put_databases_by_id_classification_level | Updates the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific database. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to edit the database. | id (integer) data: { . id (string) . status (string) } (object) required |
| post_databases_by_id_classification_level_reset | Resets the classification levelhttps://developer.atlassian.com/cloud/admin/dlp/rest/intro/ Classification%20level for a specific database for the space default classification levelhttps://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/. Permissionshttps://confluence.atlassian.com/x/_AozKw required: 'Permission to access the Confluence site 'Can use' global permission and permission to view the database. | id (integer) data: { . status (string) } (object) required |
| get_app_properties_by_property_key | Gets a Forge app property by property key. | propertyKey (string) |
| put_app_properties_by_property_key | Creates or updates a Forge app property. | propertyKey (string) data (object) required |
| delete_app_properties_by_property_key | Deletes a Forge app property. | propertyKey (string) |