Collaboration

Confluence

Learn how to use Confluence with Composio

Overview

SLUG: CONFLUENCE

Description

A tool for team collaboration and knowledge management.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read:content:confluence,read:content-details:confluence,write:content:confluence,delete:content:confluence,read:space-details:confluence,read:analytics.content:confluence,read:audit-log:confluence,write:audit-log:confluence,read:configuration:confluence,write:configuration:confluence,read:page:confluence,write:page:confluence,delete:page:confluence,read:blogpost:confluence,write:blogpost:confluence,delete:blogpost:confluence,read:whiteboard:confluence,write:whiteboard:confluence,delete:whiteboard:confluence,read:database:confluence,write:database:confluence,delete:database:confluence,read:embed:confluence,write:embed:confluence,delete:embed:confluence,read:folder:confluence,write:folder:confluence,delete:folder:confluence,read:custom-content:confluence,write:custom-content:confluence,delete:custom-content:confluence,read:attachment:confluence,write:attachment:confluence,delete:attachment:confluence,read:comment:confluence,write:comment:confluence,delete:comment:confluence,read:template:confluence,write:template:confluence,read:label:confluence,write:label:confluence,read:content.permission:confluence,read:content.property:confluence,write:content.property:confluence,read:content.restriction:confluence,write:content.restriction:confluence,read:content.metadata:confluence,read:watcher:confluence,write:watcher:confluence,read:group:confluence,write:group:confluence,read:inlinetask:confluence,write:inlinetask:confluence,read:relation:confluence,write:relation:confluence,read:space:confluence,write:space:confluence,delete:space:confluence,read:space.permission:confluence,write:space.permission:confluence,read:space.property:confluence,write:space.property:confluence,read:user.property:confluence,write:user.property:confluence,read:space.setting:confluence,write:space.setting:confluence,read:user:confluence,read:task:confluence,write:task:confluence,offline_access
bearer_token
string

Connecting to Confluence

Create an auth config

Use the dashboard to create an auth config for the Confluence toolkit. This allows you to connect multiple Confluence accounts to Composio for agents to use.

1

Select App

Navigate to Confluence.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Confluence Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4confluence_auth_config_id = "ac_YOUR_CONFLUENCE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    connection_request = composio.connected_accounts.initiate(
12        user_id=user_id,
13        auth_config_id=auth_config_id,
14    )
15
16    print(
17        f"Visit this URL to authenticate Confluence: {connection_request.redirect_url}"
18    )
19
20    # This will wait for the auth flow to be completed
21    connection_request.wait_for_connection(timeout=15)
22    return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, confluence_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Confluence toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CONFLUENCE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create blog post

Description

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

Action Parameters

body
object
createdAt
string
private
boolean
spaceId
stringRequired
status
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create inline comment

Description

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. **[permissions](https://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.

Action Parameters

blogPostId
string
body
object
inlineCommentProperties__textSelection
string
inlineCommentProperties__textSelectionMatchCount
integer
inlineCommentProperties__textSelectionMatchIndex
integer
pageId
string
parentCommentId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space. permission to create a page in the space.

Action Parameters

body
object
embedded
boolean
parentId
string
private
boolean
root__level
boolean
spaceId
stringRequired
status
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create space

Description

Creates a space as specified in the payload. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to create spaces.

Action Parameters

alias
string
description__representation
string
description__value
string
key
string
name
stringRequired
roleAssignments__principal__principalId
string
roleAssignments__principal__principalType
string
roleAssignments__roleId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete page

Description

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`. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space. permission to delete pages in the space. permission to administer the space (if attempting to purge).

Action Parameters

draft
boolean
id
integerRequired
purge
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get child pages

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
label__id
array
limit
integerDefaults to 25
prefix
array
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get page by id

Description

Returns a specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space.

Action Parameters

body__format
string
get__draft
boolean
id
integerRequired
include__collaborators
boolean
include__favorited__by__current__user__status
boolean
include__labels
boolean
include__likes
boolean
include__operations
boolean
include__properties
boolean
include__version
booleanDefaults to True
include__versions
boolean
include__webresources
boolean
status
array
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get spaces

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
description__format
string
favorited__by
string
ids
array
include__icon
boolean
keys
array
labels
array
limit
integerDefaults to 25
not__favorited__by
string
sort
string
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space. permission to update pages in the space.

Action Parameters

body
objectRequired
id
stringRequired
ownerId
parentId
spaceId
status
stringRequired
title
stringRequired
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check site access for a list of emails

Description

Returns the list of emails from the input list that do not have access to site. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission).

Action Parameters

emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Convert content ids to content types

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the requested content. any content that the user does not have permission to view or does not exist will map to `null` in the response.

Action Parameters

contentIds
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create bulk user lookup using ids

Description

Returns user details for the ids provided in the request body. **[permissions](https://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.

Action Parameters

accountIds
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for attachment

Description

Creates a new content property for an attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the attachment.

Action Parameters

attachment__id
stringRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for blog post

Description

Creates a new property for a blogpost. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the blog post.

Action Parameters

blogpost__id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for comment

Description

Creates a new content property for a comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the comment.

Action Parameters

comment__id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for custom content

Description

Creates a new content property for a piece of custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the custom content.

Action Parameters

custom__content__id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for database

Description

Creates a new content property for a database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the database.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for folder

Description

Creates a new content property for a folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the folder.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for page

Description

Creates a new content property for a page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the page.

Action Parameters

key
string
page__id
integerRequired
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create content property for whiteboard

Description

Creates a new content property for a whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the whiteboard.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create custom content

Description

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. **[permissions](https://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.

Action Parameters

blogPostId
string
body
objectRequired
customContentId
string
pageId
string
spaceId
string
status
string
title
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create database

Description

Creates a database in the space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space. permission to create a database in the space.

Action Parameters

parentId
string
private
boolean
spaceId
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create folder

Description

Creates a folder in the space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space. permission to create a folder in the space.

Action Parameters

parentId
string
spaceId
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Smart Link Content Property

Description

Creates a new content property for a smart link in the content tree. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the smart link in the content tree.

Action Parameters

id
integerRequired
key
string
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create smart link in the content tree

Description

Creates a smart link in the content tree in the space. **[permissions](https://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.

Action Parameters

embedUrl
string
parentId
string
spaceId
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create space property in space

Description

Creates a new space property. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.

Action Parameters

key
string
space__id
integerRequired
value

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create whiteboard

Description

Creates a whiteboard in the space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space. permission to create a whiteboard in the space.

Action Parameters

locale
string
parentId
string
private
boolean
spaceId
stringRequired
templateKey
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete attachment

Description

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`. **[permissions](https://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).

Action Parameters

id
integerRequired
purge
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete blog post

Description

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 following param `purge=true`. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post and its corresponding space. permission to delete blog posts in the space. permission to administer the space (if attempting to purge).

Action Parameters

draft
boolean
id
integerRequired
purge
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for attachment by id

Description

Deletes a content property for an attachment by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to attachment the page.

Action Parameters

attachment__id
stringRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for blogpost by id

Description

Deletes a content property for a blogpost by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the blog post.

Action Parameters

blogpost__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for comment by id

Description

Deletes a content property for a comment by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the comment.

Action Parameters

comment__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for database by id

Description

Deletes a content property for a database by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the database.

Action Parameters

database__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for folder by id

Description

Deletes a content property for a folder by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the folder.

Action Parameters

folder__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for page by id

Description

Deletes a content property for a page by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the page.

Action Parameters

page__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content property for whiteboard by id

Description

Deletes a content property for a whiteboard by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the whiteboard.

Action Parameters

property__id
integerRequired
whiteboard__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete custom content

Description

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`. **[permissions](https://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 (if attempting to purge).

Action Parameters

id
integerRequired
purge
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Custom Content Property By Id

Description

Deletes a content property for a piece of custom content by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the custom content.

Action Parameters

custom__content__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete database

Description

Delete a database by id. deleting a database moves the database to the trash, where it can be restored later **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the database and its corresponding space. permission to delete databases in the space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete folder

Description

Delete a folder by id. deleting a folder moves the folder to the trash, where it can be restored later **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the folder and its corresponding space. permission to delete folders in the space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete inline comment

Description

Deletes an inline comment. this is a permanent deletion and cannot be reverted. **[permissions](https://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.

Action Parameters

comment__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete smart link in the content tree

Description

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 **[permissions](https://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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete space default classification level

Description

Returns the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete space property by id

Description

Deletes a space property by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.

Action Parameters

property__id
integerRequired
space__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete whiteboard

Description

Delete a whiteboard by id. deleting a whiteboard moves the whiteboard to the trash, where it can be restored later **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the whiteboard and its corresponding space. permission to delete whiteboards in the space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get account ids of likes for blog post

Description

Returns the account ids of likes of specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the blog post and its corresponding space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get account ids of likes for inline comment

Description

Returns the account ids of likes of specific inline comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get account ids of likes for page

Description

Returns the account ids of likes of specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all ancestors of database

Description

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 id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the database and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all ancestors of folder

Description

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 id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-folders-id-get). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the folder and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all ancestors of page

Description

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 id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission).

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all ancestors of smart link in content tree

Description

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 content tree by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the smart link in the content tree and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all ancestors of whiteboard

Description

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 id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the whiteboard and its corresponding space

Action Parameters

id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachments

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the container of the attachment.

Action Parameters

cursor
string
filename
string
limit
integerDefaults to 50
mediaType
string
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachments for blog post

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the blog post and its corresponding space.

Action Parameters

cursor
string
filename
string
id
integerRequired
limit
integerDefaults to 50
mediaType
string
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachments for custom content

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the custom content and its corresponding space.

Action Parameters

cursor
string
filename
string
id
integerRequired
limit
integerDefaults to 50
mediaType
string
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachments for label

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment and its corresponding space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachments for page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

cursor
string
filename
string
id
integerRequired
limit
integerDefaults to 50
mediaType
string
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachment by id

Description

Returns a specific attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment's container.

Action Parameters

id
stringRequired
include__collaborators
boolean
include__labels
boolean
include__operations
boolean
include__properties
boolean
include__version
booleanDefaults to True
include__versions
boolean
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachment comments

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment and its corresponding containers.

Action Parameters

body__format
string
cursor
string
id
stringRequired
limit
integerDefaults to 25
sort
string
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get attachment versions

Description

Returns the versions of specific attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment and its corresponding space.

Action Parameters

cursor
string
id
stringRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get available space permissions

Description

Retrieves the available space permissions. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site.

Action Parameters

cursor
string
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get available space roles

Description

Retrieves the available space roles. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site; if requesting a certain space's roles, permission to view the space.

Action Parameters

cursor
string
limit
integerDefaults to 25
principal__id
string
principal__type
string
role__type
string
space__id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog posts

Description

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. **[permissions](https://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.

Action Parameters

body__format
string
cursor
string
id
array
limit
integerDefaults to 25
sort
string
space__id
array
status
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog posts for label

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
space__id
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog posts in space

Description

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. **[permissions](https://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.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
status
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog post by id

Description

Returns a specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post and its corresponding space.

Action Parameters

body__format
string
get__draft
boolean
id
integerRequired
include__collaborators
boolean
include__favorited__by__current__user__status
boolean
include__labels
boolean
include__likes
boolean
include__operations
boolean
include__properties
boolean
include__version
booleanDefaults to True
include__versions
boolean
include__webresources
boolean
status
array
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog post classification level

Description

Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post. **[permissions](https://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.

Action Parameters

id
integerRequired
status
stringDefaults to current

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get blog post versions

Description

Returns the versions of specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get children inline comments

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get child custom content

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for attachment

Description

Retrieves all content properties tied to a specified attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
cursor
string
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for blog post

Description

Retrieves all content properties tied to a specified blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
cursor
string
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for comment

Description

Retrieves content properties attached to a specified comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the comment.

Action Parameters

comment__id
integerRequired
cursor
string
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for custom content

Description

Retrieves content properties tied to a specified custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content.

Action Parameters

cursor
string
custom__content__id
integerRequired
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for database

Description

Retrieves content properties tied to a specified database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the database.

Action Parameters

cursor
string
id
integerRequired
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for folder

Description

Retrieves content properties tied to a specified folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the folder.

Action Parameters

cursor
string
id
integerRequired
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for page

Description

Retrieves content properties tied to a specified page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page.

Action Parameters

cursor
string
key
string
limit
integerDefaults to 25
page__id
integerRequired
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content properties for whiteboard

Description

Retrieves content properties tied to a specified whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the whiteboard.

Action Parameters

cursor
string
id
integerRequired
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for attachment by id

Description

Retrieves a specific content property by id that is attached to a specified attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for blog post by id

Description

Retrieves a specific content property by id that is attached to a specified blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for comment by id

Description

Retrieves a specific content property by id that is attached to a specified comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the comment.

Action Parameters

comment__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for custom content by id

Description

Retrieves a specific content property by id that is attached to a specified custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page.

Action Parameters

custom__content__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for database by id

Description

Retrieves a specific content property by id that is attached to a specified database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the database.

Action Parameters

database__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for folder by id

Description

Retrieves a specific content property by id that is attached to a specified folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the folder.

Action Parameters

folder__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for page by id

Description

Retrieves a specific content property by id that is attached to a specified page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page.

Action Parameters

page__id
integerRequired
property__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get content property for whiteboard by id

Description

Retrieves a specific content property by id that is attached to a specified whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the whiteboard.

Action Parameters

property__id
integerRequired
whiteboard__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content by id

Description

Returns a specific piece of custom content. **[permissions](https://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).

Action Parameters

body__format
string
id
integerRequired
include__collaborators
boolean
include__labels
boolean
include__operations
boolean
include__properties
boolean
include__version
booleanDefaults to True
include__versions
boolean
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content by type

Description

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. **[permissions](https://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).

Action Parameters

body__format
string
cursor
string
id
array
limit
integerDefaults to 25
sort
string
space__id
array
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content by type in blog post

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content, the container of the custom content (blog post), and the corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content by type in page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content, the container of the custom content (page), and the corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content by type in space

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content and the corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content comments

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content and its corresponding containers.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get custom content versions

Description

Returns the versions of specific custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the custom content and its corresponding page and space.

Action Parameters

body__format
string
cursor
string
custom__content__id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get database by id

Description

Returns a specific database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the database and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get database classification level

Description

Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the database.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get data policy metadata for the workspace

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get folder by id

Description

Returns a specific folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the folder and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get footer comments for blog post

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the blog post and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get footer comments for page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get inline comments

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get inline comments for blog post

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the blog post and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
resolution__status
array
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get inline comments for page

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
resolution__status
array
sort
string
status
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get inline comment by id

Description

Retrieves an inline comment by id **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page or blogpost and its corresponding space.

Action Parameters

body__format
string
comment__id
integerRequired
include__likes
boolean
include__operations
boolean
include__properties
boolean
include__version
booleanDefaults to True
include__versions
boolean
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get inline comment versions

Description

Retrieves the versions of the specified inline comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page or blog post and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for attachment

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for blog post

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for custom content

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for page

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for space

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the space. only labels that the user has permission to view will be returned.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
stringDefaults to my, team
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get labels for space content

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the space. only labels that the user has permission to view will be returned.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
prefix
stringDefaults to my, team
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get like count for blog post

Description

Returns the count of likes of specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the blog post and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get like count for inline comment

Description

Returns the count of likes of specific inline comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get like count for page

Description

Returns the count of likes of specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get list of classification levels

Description

Returns a list of [classification levels](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) available. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission).

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get pages

Description

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. **[permissions](https://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.

Action Parameters

body__format
string
cursor
string
id
array
limit
integerDefaults to 25
sort
string
space__id
array
status
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get pages for label

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string
space__id
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get pages in space

Description

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. **[permissions](https://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.

Action Parameters

body__format
string
cursor
string
depth
stringDefaults to all
id
integerRequired
limit
integerDefaults to 25
sort
string
status
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get page classification level

Description

Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page. **[permissions](https://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.

Action Parameters

id
integerRequired
status
stringDefaults to current

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get page versions

Description

Returns the versions of specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space.

Action Parameters

body__format
string
cursor
string
id
integerRequired
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for attachment

Description

Returns the permitted operations on specific attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the parent content of the attachment and its corresponding space.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for a database

Description

Returns the permitted operations on specific database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the database and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for a folder

Description

Returns the permitted operations on specific folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the folder and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for a whiteboard

Description

Returns the permitted operations on specific whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the whiteboard and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for blog post

Description

Returns the permitted operations on specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the parent content of the blog post and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for custom content

Description

Returns the permitted operations on specific custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the parent content of the custom content and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for inline comment

Description

Returns the permitted operations on specific inline comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the parent content of the inline comment and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for page

Description

Returns the permitted operations on specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the parent content of the page and its corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permitted operations for space

Description

Returns the permitted operations on specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Smart Link Content Props

Description

Retrieves content properties tied to a specified smart link in the content tree. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the smart link in the content tree.

Action Parameters

cursor
string
id
integerRequired
key
string
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get smart link in the content tree by id

Description

Returns a specific smart link in the content tree. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the smart link in the content tree and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get spaces with data policies

Description

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. **[permissions](https://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.

Action Parameters

cursor
string
ids
array
keys
array
limit
integerDefaults to 25
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space by id

Description

Returns a specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the space.

Action Parameters

description__format
string
id
integerRequired
include__icon
boolean
include__labels
boolean
include__operations
boolean
include__permissions
boolean
include__properties
boolean
include__role__assignments
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space default classification level

Description

Returns the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the space.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space permissions assignments

Description

Returns space permission assignments for a specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space properties in space

Description

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. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission) and 'view' permission for the space.

Action Parameters

cursor
string
key
string
limit
integerDefaults to 25
space__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space property by id

Description

Retrieve a space property by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission) and 'view' permission for the space.

Action Parameters

property__id
integerRequired
space__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space role assignments

Description

Retrieves the space role assignments. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the space.

Action Parameters

cursor
string
id
integerRequired
limit
integerDefaults to 25
principal__id
string
principal__type
string
role__id
string
role__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get space role by id

Description

Retrieves the space role by id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tasks

Description

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. **[permissions](https://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.

Action Parameters

assigned__to
array
blogpost__id
array
body__format
string
completed__at__from
integer
completed__at__to
integer
completed__by
array
created__at__from
integer
created__at__to
integer
created__by
array
cursor
string
due__at__from
integer
due__at__to
integer
include__blank__tasks
boolean
limit
integerDefaults to 25
page__id
array
space__id
array
status
string
task__id
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get task by id

Description

Returns a specific task. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the containing page or blog post and its corresponding space.

Action Parameters

body__format
string
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version details for attachment version

Description

Retrieves version details for the specified attachment and version number. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the attachment.

Action Parameters

attachment__id
stringRequired
version__number
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version details for blog post version

Description

Retrieves version details for the specified blog post and version number. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post.

Action Parameters

blogpost__id
integerRequired
version__number
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version details for custom content version

Description

Retrieves version details for the specified custom content and version number. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page.

Action Parameters

custom__content__id
integerRequired
version__number
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version details for inline comment version

Description

Retrieves version details for the specified inline comment version. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page or blog post and its corresponding space.

Action Parameters

id
integerRequired
version__number
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version details for page version

Description

Retrieves version details for the specified page and version number. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page.

Action Parameters

page__id
integerRequired
version__number
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get whiteboard by id

Description

Returns a specific whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the whiteboard and its corresponding space.

Action Parameters

id
integerRequired
include__collaborators
boolean
include__direct__children
boolean
include__operations
boolean
include__properties
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get whiteboard classification level

Description

Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the whiteboard.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Invite a list of emails to the site

Description

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. <b>note:</b> this api is asynchronous and may take some time to complete. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission).

Action Parameters

emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reset blog post classification level

Description

Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the blog post.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reset database classification level

Description

Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the database.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reset page classification level

Description

Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the page.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reset whiteboard classification level

Description

Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the whiteboard.

Action Parameters

id
integerRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Content

Description

Searches for content using the confluence query language (cql).

Action Parameters

cql
stringRequired
cqlcontext
object
cursor
string
excerpt
stringDefaults to highlight
excludeCurrentSpaces
boolean
expand
array
includeArchivedSpaces
boolean
limit
integerDefaults to 25
next
boolean
prev
boolean
sitePermissionTypeFilter
stringDefaults to none
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Users

Description

Searches for users using user-specific queries from the confluence query language (cql).

Action Parameters

cql
stringRequired
expand
array
limit
integerDefaults to 25
sitePermissionTypeFilter
stringDefaults to none
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set space role assignments

Description

Sets space role assignments as specified in the payload. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to manage roles in the space.

Action Parameters

id
integerRequired
principal__principalId
string
principal__principalType
string
roleId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update blog post

Description

Update a blog post by id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the blog post and its corresponding space. permission to update blog posts in the space.

Action Parameters

body
objectRequired
createdAt
string
id
stringRequired
spaceId
string
status
stringRequired
title
stringRequired
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update blog post classification level

Description

Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the blog post.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for attachment by id

Description

Update a content property for attachment by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the attachment.

Action Parameters

attachment__id
stringRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for blog post by id

Description

Update a content property for blog post by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the blog post.

Action Parameters

blogpost__id
integerRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for comment by id

Description

Update a content property for a comment by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the comment.

Action Parameters

comment__id
integerRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for database by id

Description

Update a content property for a database by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the database.

Action Parameters

database__id
integerRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for folder by id

Description

Update a content property for a folder by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the folder.

Action Parameters

folder__id
integerRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for page by id

Description

Update a content property for a page by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the page.

Action Parameters

key
string
page__id
integerRequired
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content property for whiteboard by id

Description

Update a content property for a whiteboard by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the whiteboard.

Action Parameters

key
string
property__id
integerRequired
value
version__message
string
version__number
integer
whiteboard__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update custom content

Description

Update a custom content by id. `spaceid` is always required and maximum one of `pageid`, `blogpostid`, or `customcontentid` is allowed in the request body. **[permissions](https://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.

Action Parameters

blogPostId
string
body
objectRequired
customContentId
string
id
stringRequired
pageId
string
spaceId
string
status
stringRequired
title
stringRequired
type
stringRequired
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Custom Content Prop By Id

Description

Update a content property for a piece of custom content by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the custom content.

Action Parameters

custom__content__id
integerRequired
key
string
property__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update database classification level

Description

Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the database.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update inline comment

Description

Update an inline comment. this can be used to update the body text of a comment and/or to resolve the comment **[permissions](https://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.

Action Parameters

body
object
comment__id
integerRequired
resolved
boolean
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update page classification level

Description

Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the page.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update space default classification level

Description

Update the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update space property by id

Description

Update a space property by its id. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.

Action Parameters

key
string
property__id
integerRequired
space__id
integerRequired
value
version__message
string
version__number
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task

Description

Update a task by id. this endpoint currently only supports updating task status. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to edit the containing page or blog post and view its corresponding space.

Action Parameters

assignedTo
string
blogPostId
string
body__format
string
completedAt
string
completedBy
string
createdAt
string
createdBy
string
dueAt
string
id
stringRequired
localId
string
pageId
string
spaceId
string
status
stringRequired
updatedAt
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update whiteboard classification level

Description

Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the whiteboard.

Action Parameters

id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired