[Integration] connector for AI agents

Add Labels To A Specific Content Item In Confluence.

Adds Restrictions To A Piece Of Content. Note, This Does Not Change Any Existing Restrictions On The Content. Permission To Edit The Content Is Required.

Adds A User As A Watcher To A Piece Of Content. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). Note, You Must Add The X-Atlassian-Token No-Check Header When Making A Request, As This Operation Has XSRF Protection. 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Adds A Group To A Content Restriction By Group Id. That Is, Grant Read Or Update Permission To The Group For A Piece Of Content. Permission To Edit The Content Is Required.

Adds A User As A Watcher To A Label. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). Note, You Must Add The X-Atlassian-Token No-Check Header When Making A Request, As This Operation Has XSRF Protection. 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Adds Labels To A Piece Of Content. Does Not Modify The Existing Labels. Labels Can Also Be Added When Creating Content Or Updated When Updating Content. Permission To Update The Content Is Required.

Adds A User As A Member In A Group Represented By Its GroupId

Adds A User As A Watcher To A Space. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). Note, You Must Add The X-Atlassian-Token No-Check Header When Making A Request, As This Operation Has XSRF Protection. 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Adds A User To A Content Restriction. That Is, Grant Read Or Update Permission To The User For A Piece Of Content. Permission To Edit The Content Is Required.

Archives A List Of Pages. The Pages To Be Archived Are Specified As A List Of Content IDs. This API Accepts The Archival Request And Returns A Task ID. The Archival Process Happens Asynchronously. Use The /Longtask/ REST API To Get The Copy Task Status. Each Content ID Needs To Resolve To Page Objects That Are Not Already In An Archived State. The Content IDs Need Not Belong To The Same Space.

Converts A Content Body From One Format To Another Format Asynchronously. Returns The AsyncId For The Asynchronous Task. Supported Conversions - Atlas_doc_format (Editor, Export_view, Storage, Styled_view, View), Storage (Atlas_doc_format, Editor, Export_view, Styled_view, View), Editor (Storage). No Other Conversions Are Supported At The Moment. Once A Conversion Is Completed, It Will Be Available For 5 Minutes At The Result Endpoint. If Request Specifies 'ContentIdContext', 'View' Permission For The Space, And Permission To View The Content Is Required.

Check If A User Or A Group Can Perform An Operation To The Specified Content. The Operation To Check Must Be Provided. The User'S Account ID Or The ID Of The Group Can Be Provided In The Subject To Check Permissions Against A Specified User Or Group. The Following Permission Checks Are Done To Make Sure That The User Or Group Has The Proper Access - Site Permissions, Space Permissions, Content Restrictions. Permission To Access The Confluence Site ('Can Use' Global Permission) If Checking Permission For Self, Otherwise 'Confluence Administrator' Global Permission Is Required.

Copy Page Hierarchy Allows The Copying Of An Entire Hierarchy Of Pages And Their Associated Properties, Permissions And Attachments. The Id Path Parameter Refers To The Content Id Of The Page To Copy, And The New Parent Of This Copied Page Is Defined Using The DestinationPageId In The Request Body. The TitleOptions Object Defines The Rules Of Renaming Page Titles During The Copy. Use The /Longtask/ REST API To Get The Copy Task Status.

Copies A Single Page And Its Associated Properties, Permissions, Attachments, And Custom Contents. The Id Path Parameter Refers To The Content ID Of The Page To Copy. The Target Of The Page To Be Copied Is Defined Using The Destination In The Request Body And Can Be One Of The Following Types - 'Space' (Page Will Be Copied To The Specified Space As A Root Page On The Space), 'Parent_page' (Page Will Be Copied As A Child Of The Specified Parent Page), 'Parent_content' (Page Will Be Copied As A Child Of The Specified Parent Content), 'Existing_page' (Page Will Be Copied And Replace The Specified Page). By Default, The Following Objects Are Expanded (Space, History, Version). 'Add' Permission For The Space That The Content Will Be Copied In And Permission To Update The Content If Copying To An 'Existing_page' Is Required.

Create A Space Role. User Must Be An Organization Or Site Admin. Connect And Forge App Users Are Not Authorized To Access This Resource. Direct API Access Using OAuth 2.0 Or Basic Auth (Email + API Token) Is Supported For Admin Users.

Asynchronously Converts Content Bodies From One Format To Another Format In Bulk. Use The Content Body REST API To Get The Status Of Conversion Tasks. Note That There Is A Maximum Limit Of 10 Conversions Per Request To This Endpoint. Supported Conversions - Storage (Editor, Export_view, Styled_view, View), Editor (Storage). Once A Conversion Task Is Completed, It Is Available For Polling For Up To 5 Minutes. 'View' Permission For The Space, And Permission To View The Content If The SpaceKeyContext Or ContentIdContext Are Present Is Required.

Adds An Attachment To A Piece Of Content. This Method Only Adds A New Attachment. If You Want To Update An Existing Attachment, Use Create Or Update Attachments. Note, You Must Set A X-Atlassian-Token Nocheck Header On The Request For This Method, Otherwise It Will Be Blocked. This Protects Against XSRF Attacks, Which Is Necessary As This Method Accepts Multipart/Form-Data. Permission To Update The Content Is Required.

Creates A Record In The Audit Log.

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.

Creates A New Content Property For An Attachment.

Creates A New Property For A Blogpost.

Creates A New Content Property For A Comment.

Creates A New Content Property For A Piece Of Custom Content.

Creates A New Content Property For A Database.

Creates A New Content Property For A Folder.

Creates A New Content Property For A Page.

Creates A New Content Property For A Smart Link In The Content Tree.

Creates A New Content Property For A Whiteboard.

Creates A New Content Template. Note, Blueprint Templates Cannot Be Created Via The REST API. 'Admin' Permission For The Space To Create A Space Template Or 'Confluence Administrator' Global Permission To Create A Global Template Is Required.

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.

Creates A Database In The Space. Permission To View The Corresponding Space And Permission To Create A Database In The Space Is Required.

Creates A Folder In The Space. Permission To View The Corresponding Space And Permission To Create A Folder In The Space Is Required.

Create A Footer Comment. The Footer Comment Can Be Made Against Several Locations - At The Top Level (Specifying PageId Or BlogPostId In The Request Body), As A Reply (Specifying ParentCommentId In The Request Body), Against An Attachment, Or Against A Custom Content.

Creates A New User Group.

Creates Or Updates A Forge App Property. This API Can Only Be Accessed Using AsApp() Requests From Forge. Regular API Calls With Bearer Tokens Will Return 401 Unauthorized. This Endpoint Requires OAuth 2.0 Scope Read:App-Data:Confluence And Can Only Be Used Within Forge App Context.

Adds An Attachment To A Piece Of Content. If The Attachment Already Exists For The Content, Then The Attachment Is Updated (I.E. A New Version Of The Attachment Is Created). Note, You Must Set A X-Atlassian-Token Nocheck Header On The Request For This Method, Otherwise It Will Be Blocked. This Protects Against XSRF Attacks, Which Is Necessary As This Method Accepts Multipart/Form-Data. Permission To Update The Content Is Required.

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.

Creates A Smart Link In The Content Tree In The Space. Permission To View The Corresponding Space. Permission To Create A Smart Link In The Content Tree In The Space.

Creates A Space As Specified In The Payload.

Creates A New Space Property.

Creates A Property For A User. These Properties Stored Against A User Are On A Confluence Site Level And Not Space Or Content Level. Note, The Number Of Properties Which Could Be Created Per App In A Tenant For Each User Might Be Restricted By Fixed System Limits. Permission To Access The Confluence Site Is Required.

Creates A Whiteboard In The Space. Permission To View The Corresponding Space. Permission To Create A Whiteboard In The Space.

Delete A Space Role. User Must Be An Organization Or Site Admin. Connect And Forge App Users Are Not Authorized To Access This Resource. Direct API Access Using OAuth 2.0 Or Basic Auth (Email + API Token) Is Supported For Admin Users.

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.

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.

Deletes A Content Property For An Attachment By Its Id.

Deletes A Content Property For A Blogpost By Its Id.

Deletes A Content Property For A Comment By Its Id.

Deletes A Content Property For A Piece Of Custom Content By Its Id.

Deletes A Content Property For A Database By Its Id.

Deletes A Content Property For A Folder By Its Id.

Deletes A Content Property For A Page By Its Id.

Deletes A Content Property For A Smart Link In The Content Tree By Its Id.

Deletes A Content Property For A Whiteboard By Its Id.

Removes All Restrictions (Read And Update) On A Piece Of Content. Permission To Edit The Content Is Required.

Delete A Historical Version. This Does Not Delete The Changes Made To The Content In That Version, Rather The Changes For The Deleted Version Are Rolled Up Into The Next Version. Note, You Cannot Delete The Current Version. Permission To Update The Content Is Required.

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.

Delete A Database By Id. Deleting A Database Moves The Database To The Trash, Where It Can Be Restored Later. Permission To View The Database And Its Corresponding Space, And Permission To Delete Databases In The Space Is Required.

Delete A Folder By Id. Deleting A Folder Moves The Folder To The Trash, Where It Can Be Restored Later. Permission To View The Folder And Its Corresponding Space, And Permission To Delete Folders In The Space Is Required.

Deletes A Footer Comment. This Is A Permanent Deletion And Cannot Be Reverted.

Delete User Group.

Deletes An Inline Comment. This Is A Permanent Deletion And Cannot Be Reverted.

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.

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

Delete The Default Classification Level For A Specific Space.

Deletes A Space Property By Its Id.

Deletes A Property For The Given User. These Properties Stored Against A User Are On A Confluence Site Level And Not Space Or Content Level. Permission To Access The Confluence Site Is Required.

Delete A Whiteboard By Id. Deleting A Whiteboard Moves The Whiteboard To The Trash, Where It Can Be Restored Later. Permission To View The Whiteboard And Its Corresponding Space. Permission To Delete Whiteboards In The Space.

Deletes A Forge App Property. This API Can Only Be Accessed Using AsApp() Requests From Forge. Regular API Calls With Bearer Tokens Will Return 401 Unauthorized. This Endpoint Requires OAuth 2.0 Scope Read:App-Data:Confluence And Can Only Be Used Within Forge App Context.

Disables Admin Key Access For The Calling User Within The Site. User Must Be An Organization Or Site Admin.

Enables Admin Key Access For The Calling User Within The Site. If An Admin Key Already Exists For The User, A New One Will Be Issued With An Updated Expiration Time. Note, The DurationInMinutes Field Within The Request Body Is Optional. If The Request Body Is Empty Or If The DurationInMinutes Is Set To 0 Minutes, A New Admin Key Will Be Issued To The Calling User With A Default Duration Of 10 Minutes. User Must Be An Organization Or Site Admin.

Exports Audit Records As A CSV File Or ZIP File.

Gets A Forge App Property By Property Key. This API Can Only Be Accessed Using AsApp() Requests From Forge. Regular API Calls With Bearer Tokens Will Return 401 Unauthorized. This Endpoint Requires OAuth 2.0 Scope Read:App-Data:Confluence And Can Only Be Used Within Forge App Context.

Returns The Account IDs Of Likes Of Specific Blog Post.

Returns The Account IDs Of Likes Of Specific Footer Comment.

Returns The Account IDs Of Likes Of Specific Inline Comment.

Returns The Account IDs Of Likes Of Specific Page.

Returns Information About The Admin Key If One Is Currently Enabled For The Calling User Within The Site. User Must Be An Organization Or Site Admin.

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.

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.

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.

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.

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.

Returns Information About How Anonymous Users Are Represented, Like The Profile Picture And Display Name.

Returns The Content Body For The Corresponding AsyncId Of A Completed Conversion Task. If The Task Is Not Completed, The Task Status Is Returned Instead. Once A Conversion Task Is Completed, The Result Can Be Obtained For Up To 5 Minutes, Or Until An Identical Conversion Request Is Made Again With The AllowCache Parameter Set To False. Note That There Is A Maximum Limit Of 50 Task Results Per Request To This Endpoint. Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns The Asynchronous Content Body For The Corresponding Id If The Task Is Complete Or Returns The Status Of The Task. After The Task Is Completed, The Result Can Be Obtained For 5 Minutes, Or Until An Identical Conversion Request Is Made Again, With AllowCache Query Param Set To False. If Request Specifies 'ContentIdContext', 'View' Permission For The Space, And Permission To View The Content Is Required.

Returns A Specific Attachment.

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.

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.

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.

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.

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.

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.

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.

Returns All Records In The Audit Log, Optionally For A Certain Date Range. This Contains Information About Events Like Space Exports, Group Membership Changes, App Installations, Etc.

Returns Records From The Audit Log, For A Time Period Back From The Current Date. For Example, You Can Use This Method To Get The Last 3 Months Of Records. This Contains Information About Events Like Space Exports, Group Membership Changes, App Installations, Etc.

Gets Content States That Are Available For The Content To Be Set As. Will Return All Enabled Space Content States. Will Only Return Most The 3 Most Recently Published Custom Content States To Match UI Editor List. To Get All Custom Content States, Use The /Content-States Endpoint. Permission To Edit The Content Is Required.

Retrieves The Available Space Permissions.

Retrieves The Available Space Roles.

Returns A Specific Blog Post.

Returns The Classification Level For A Specific Blog Post.

Returns All Blog Posts. The Number Of Results Is Limited By The Limit Parameter And Additional Results Will Be Available Through The Next URL Present In The Link Response Header.

Returns The Blogposts Of Specified Label. The Number Of Results Is Limited By The Limit Parameter And Additional Results Will Be Available Through The Next URL Present In The Link Response Header.

Returns All Blog Posts In A Space. The Number Of Results Is Limited By The Limit Parameter And Additional Results Will Be Available Through The Next URL Present In The Link Response Header.

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.

Returns All Templates Provided By Blueprints. Use This Method To Retrieve All Global Blueprint Templates Or All Blueprint Templates In A Space. Note, All Global Blueprints Are Inherited By Each Space. Space Blueprints Can Be Customised Without Affecting The Global Blueprints.

Returns All Child Custom Content For A Given Custom Content By 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.

Returns The Children Footer Comments Of Specific Comment. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.

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.

Returns All Content That Has The Provided Content State In A Space. If The Expand Query Parameter Is Used With The Body.Export_view And/Or Body.Styled_view Properties, Then The Query Limit Parameter Will Be Restricted To A Maximum Value Of 25. 'View' Permission For The Space Is Required.

Get Labels For A Specific Content Item From Confluence.

Retrieves All Content Properties Tied To A Specified Attachment.

Retrieves All Content Properties Tied To A Specified Blog Post.

Retrieves Content Properties Attached To A Specified Comment.

Retrieves Content Properties Tied To A Specified Custom Content.

Retrieves Content Properties Tied To A Specified Database.

Retrieves Content Properties Tied To A Specified Folder.

Retrieves Content Properties Tied To A Specified Page.

Retrieves Content Properties Tied To A Specified Smart Link In The Content Tree.

Retrieves Content Properties Tied To A Specified Whiteboard.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Attachment.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Blog Post.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Comment.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Custom Content.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Database.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Folder.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Page.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Smart Link In The Content Tree.

Retrieves A Specific Content Property By ID That Is Attached To A Specified Whiteboard.

Returns Whether The Specified Content Restriction Applies To A Group. For Example, If A Page With Id=123 Has A Read Restriction For The 123456 Group Id, The Following Request Will Return True - /Wiki/Rest/Api/Content/123/Restriction/ByOperation/Read/ByGroupId/123456. Note That A Response Of True Does Not Guarantee That The Group Can View The Page, As It Does Not Account For Account-Inherited Restrictions, Space Permissions, Or Even Product Access. Permission To View The Content Is Required.

Returns Whether The Specified Content Restriction Applies To A User. For Example, If A Page With Id=123 Has A Read Restriction For A User With An Account ID Of 384093:32b4d9w0-F6a5-3535-11a3-9c8c88d10192, The Following Request Will Return True - /Wiki/Rest/Api/Content/123/Restriction/ByOperation/Read/User?AccountId=384093:32b4d9w0-F6a5-3535-11a3-9c8c88d10192. Note That A Response Of True Does Not Guarantee That The User Can View The Page, As It Does Not Account For Account-Inherited Restrictions, Space Permissions, Or Even Product Access. Permission To View The Content Is Required.

Returns The Restrictions On A Piece Of Content. Permission To View The Content Is Required.

Returns Restrictions On A Piece Of Content By Operation. This Method Is Similar To Get Restrictions Except That The Operations Are Properties Of The Return Object, Rather Than Items In A Results Array. Permission To View The Content Is Required.

Returns The Restrictions On A Piece Of Content For A Given Operation (Read Or Update). Permission To View The Content Is Required.

Gets The Current Content State Of The Draft Or Current Version Of Content. To Specify The Draft Version, Set The Parameter Status To Draft, Otherwise Archived Or Current Will Get The Relevant Published State. Permission To View The Content Is Required.

Get Object Describing Whether Content States Are Allowed At All, If Custom Content States Or Space Content States Are Restricted, And A List Of Space Content States Allowed For The Space If They Are Not Restricted. 'Admin' Permission For The Space Is Required.

Returns A Content Template. This Includes Information About Template, Like The Name, The Space Or Blueprint That The Template Is In, The Body Of The Template, And More.

Returns All Content Templates. Use This Method To Retrieve All Global Content Templates Or All Content Templates In A Space.

Returns Whether A User Is Watching A Piece Of Content. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns The Currently Logged-In User. This Includes Information About The User, Like The Display Name, UserKey, Account ID, Profile Picture, And More.

Returns A Specific Piece Of Custom Content.

Returns All Custom Content For A Given Type. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.

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.

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.

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.

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.

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.

Get Custom Content States That Authenticated User Has Created. Must Have User Authentication.

Returns Data Policy Metadata For The Workspace. This Is An EXPERIMENTAL Endpoint That Requires OAuth 2.0 App Authentication (Not Basic Auth). Only Atlassian Apps With The 'Read:Configuration:Confluence' OAuth Scope Can Make This Request. This Endpoint May Return 404 If Data Policies Are Not Enabled In Your Confluence Instance, If You'Re Using Basic Authentication Instead Of OAuth 2.0, Or If The App Doesn'T Have The Required Permissions. Requires 'Can Use' Global Permission.

Returns A Specific Database. Permission To View The Database And Its Corresponding Space Is Required.

Returns The Classification Level For A Specific Database.

Returns Descendants In The Content Tree For A Given Database By ID In Top-To-Bottom Order. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available By Calling This Endpoint With The Cursor In The Response Payload. There Is Also A Depth Parameter Specifying Depth Of Descendants To Be Fetched. The Following Types Of Content Will Be Returned - Database, Embed, Folder, Page, Whiteboard.

Returns Descendants In The Content Tree For A Given Smart Link By ID In Top-To-Bottom Order. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available By Calling This Endpoint With The Cursor In The Response Payload. There Is Also A Depth Parameter Specifying Depth Of Descendants To Be Fetched. The Following Types Of Content Will Be Returned - Database, Embed, Folder, Page, Whiteboard.

Returns Descendants In The Content Tree For A Given Whiteboard By ID In Top-To-Bottom Order. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available By Calling This Endpoint With The Cursor In The Response Payload. There Is Also A Depth Parameter Specifying Depth Of Descendants To Be Fetched. The Following Types Of Content Will Be Returned - Database, Embed, Folder, Page, Whiteboard.

Returns Descendants In The Content Tree For A Given Folder By ID In Top-To-Bottom Order. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available By Calling This Endpoint With The Cursor In The Response Payload. There Is Also A Depth Parameter Specifying Depth Of Descendants To Be Fetched. The Following Types Of Content Will Be Returned - Database, Embed, Folder, Page, Whiteboard.

Returns Descendants In The Content Tree For A Given Page By ID In Top-To-Bottom Order. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available By Calling This Endpoint With The Cursor In The Response Payload. There Is Also A Depth Parameter Specifying Depth Of Descendants To Be Fetched. The Following Types Of Content Will Be Returned - Database, Embed, Folder, Page, Whiteboard.

Returns All Direct Children For A Given Database By 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. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.

Returns All Direct Children For A Given Folder By 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. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.

Returns All Direct Children For A Given Page By 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. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.

Returns All Direct Children For A Given Smart Link By 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. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.

Returns All Direct Children For A Given Whiteboard By 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. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.

Returns A Specific Folder. Permission To View The Folder And Its Corresponding Space Is Required.

Retrieves A Footer Comment By Id.

Returns All Footer Comments. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.

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.

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.

Gets Forge App Properties. This API Can Only Be Accessed Using AsApp() Requests From Forge. Regular API Calls With Bearer Tokens Will Return 401 Unauthorized. This Endpoint Requires OAuth 2.0 Scope Read:App-Data:Confluence And Can Only Be Used Within Forge App Context.

Get Confluence Global Settings, Showing Instance-Wide Configuration Options For Features, Security, And Behavior.

Get The Global Theme Applied To The Entire Confluence Instance, Showing Default Styling For All Spaces. Returns The Globally Assigned Theme.

Returns A User Group For A Given Group Id.

Returns The Users That Are Members Of A Group. Use Updated Get Group API

Returns The Groups That A User Is A Member Of.

Retrieves An Inline Comment By Id.

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.

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.

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.

Returns Label Information And A List Of Contents Associated With The Label. Only Contents That The User Is Permitted To View Is Returned.

Returns Whether A User Is Watching A Label. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns The Count Of Likes Of Specific Blog Post.

Returns The Count Of Likes Of Specific Footer Comment.

Returns The Count Of Likes Of Specific Inline Comment.

Returns The Count Of Likes Of Specific Page.

Returns A List Of Classification Levels Available.

Returns Information About An Active Long-Running Task (E.G. Space Export), Such As How Long It Has Been Running And The Percentage Of The Task That Has Completed.

Returns Information About All Active Long-Running Tasks (E.G. Space Export), Such As How Long Each Task Has Been Running And The Percentage Of Each Task That Has Completed.

Returns The Look And Feel Settings For The Site Or A Single Space. This Includes Attributes Such As The Color Scheme, Padding, And Border Radius. The Look And Feel Settings For A Space Can Be Inherited From The Global Look And Feel Settings Or Provided By A Theme.

Returns Async Id Of The Conversion Task Which Will Convert The Macro Into A Content Body Of The Desired Format. The Result Will Be Available For 5 Minutes After Completion Of The Conversion. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Currently, The Following Conversions Are Allowed - Export_view, Styled_view, View. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.

Returns The Body Of A Macro In Format Specified In Path, For The Given Macro ID. This Includes Information Like The Name Of The Macro, The Body Of The Macro, And Any Macro Parameters. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '50884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.

Returns The Body Of A Macro In Storage Format, For The Given Macro ID. This Includes Information Like The Name Of The Macro, The Body Of The Macro, And Any Macro Parameters. This Method Is Mainly Used By Cloud Apps. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '50884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.

Returns All Modules Registered Dynamically By The Calling App. Only Connect Apps Can Make This Request.

Returns User Details For The Ids Provided In The Request. Currently This API Returns A Maximum Of 100 Results. If More Than 100 Account Ids Are Passed In, Then The First 100 Will Be Returned.

Returns A Specific Page.

Returns The Classification Level For A Specific Page.

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.

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.

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.

Returns The Permitted Operations On Specific Database.

Returns The Permitted Operations On Specific Folder.

Returns The Permitted Operations On Specific Smart Link In The Content Tree.

Returns The Permitted Operations On Specific Whiteboard.

Returns The Permitted Operations On Specific Attachment.

Returns The Permitted Operations On Specific Blog Post.

Returns The Permitted Operations On Specific Custom Content.

Returns The Permitted Operations On Specific Footer Comment.

Returns The Permitted Operations On Specific Inline Comment.

Returns The Permitted Operations On Specific Page.

Returns The Permitted Operations On Specific Space.

Returns The Retention Period For Records In The Audit Log. The Retention Period Is How Long An Audit Record Is Kept For, From Creation Date Until It Is Deleted.

Returns A Specific Smart Link In The Content Tree. Permission To View The Smart Link In The Content Tree And Its Corresponding Space.

Returns A Specific Space.

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.

Returns The Default Classification Level For A Specific Space.

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.

Returns Space Permission Assignments For A Specific Space.

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.

Retrieve A Space Property By Its Id.

Retrieves The Space Role Assignments.

Retrieves The Space Role By ID.

Retrieves The Space Role Mode.

Returns The Settings Of A Space. Currently Only The `RouteOverrideEnabled` Setting Can Be Returned.

Get Content States That Are Suggested In The Space. 'View' Permission For The Space Is Required.

Get The Current Theme Applied To A Specific Space, Showing Active Styling And Customization. Returns The Theme Selected For A Space, If One Is Set. If No Space Theme Is Set, This Means That The Space Is Inheriting The Global Look And Feel Settings.

Returns Whether A User Is Watching A Space. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns A List Of Watchers Of A Space.

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.

Returns All Spaces With Data Policies. 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. This Is An EXPERIMENTAL Endpoint That Requires OAuth 2.0 App Authentication (Not Basic Auth). Only Atlassian Apps With The 'Read:Space:Confluence' OAuth Scope Can Make This Request. This Endpoint May Return 404 If Data Policies Are Not Enabled In Your Confluence Instance, If You'Re Using Basic Authentication Instead Of OAuth 2.0, Or If The App Doesn'T Have The Required Permissions. Requires 'Can Use' Global Permission. Only Spaces That The App Has Permission To View Will Be Returned.

Returns The System Information For The Confluence Cloud Tenant. This Information Is Used By Atlassian.

Returns A Specific Task. Permission To View The Containing Page Or Blog Post And Its Corresponding Space Is Required.

Get Details Of A Specific Theme By Key, Including Theme Name, Description, And Icon Information.

Redirects The Client To A URL That Serves An Attachment'S Binary Data.

Returns A User. This Includes Information About The User, Such As The Display Name, Account ID, Profile Picture, And More. The Information Returned May Be Restricted By The User'S Profile Visibility Settings.

Returns A User'S Email Address Regardless Of The User'S Profile Visibility Settings. For Connect Apps, This API Is Only Available To Apps Approved By Atlassian, According To These Guidelines. For Forge Apps, This API Only Supports Access Via AsApp() Requests.

Returns A User'S Email Address Regardless Of The User'S Profile Visibility Settings. For Connect Apps, This API Is Only Available To Apps Approved By Atlassian, According To These Guidelines. For Forge Apps, This API Only Supports Access Via AsApp() Requests. Any Accounts Which Are Not Available Will Not Be Included In The Result.

Returns The Properties For A User As List Of Property Keys. These Properties Stored Against A User Are On A Confluence Site Level And Not Space Or Content Level. Permission To Access The Confluence Site Is Required.

Returns The Property Corresponding To Key For A User. These Properties Stored Against A User Are On A Confluence Site Level And Not Space Or Content Level. Permission To Access The Confluence Site Is Required.

Get The Total Number Of Distinct Viewers A Piece Of Content Has.

Get The Total Number Of Views A Piece Of Content Has.

Returns The Watches For A Page. A User That Watches A Page Will Receive Receive Notifications When The Page Is Updated. If You Want To Manage Watches For A Page, Use The Following User Methods - Get Content Watch Status For User, Add Content Watch, Remove Content Watch. Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns All Space Watches For The Space That The Content Is In. A User That Watches A Space Will Receive Receive Notifications When Any Content In The Space Is Updated. If You Want To Manage Watches For A Space, Use The Following User Methods - Get Space Watch Status For User, Add Space Watch, Remove Space Watch. Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Returns A Specific Whiteboard. Permission To View The Whiteboard And Its Corresponding Space.

Returns The Classification Level For A Specific Whiteboard.

Returns All User Groups. The Returned Groups Are Ordered Alphabetically In Ascending Order By Group Name.

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.

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.

Returns All Tasks. The Number Of Results Is Limited By The Limit Parameter And Additional Results Will Be Available Through The Next URL Present In The Link Response Header.

Get All Available Themes For Confluence Spaces, Showing Pre-Built And Custom Theme Options For UI Customization. Returns All Themes, Not Including The Default Theme.

Move A Page To A New Location Relative To A Target Page. Position Options - 'Before' (Move The Page Under The Same Parent As The Target, Before The Target In The List Of Children), 'After' (Move The Page Under The Same Parent As The Target, After The Target In The List Of Children), 'Append' (Move The Page To Be A Child Of The Target). Caution - This API Can Move Pages To The Top Level Of A Space. Top-Level Pages Are Difficult To Find In The UI Because They Do Not Show Up In The Page Tree Display. To Avoid This, Never Use 'Before' Or 'After' Positions When The TargetId Is A Top-Level Page.

Publishes A Legacy Draft Of A Page Created From A Blueprint. Legacy Drafts Will Eventually Be Removed In Favor Of Shared Drafts. For Now, This Method Works The Same As Publish Shared Draft. By Default, The Following Objects Are Expanded (Body.Storage, History, Space, Version, Ancestors). Permission To View The Draft And 'Add' Permission For The Space That The Content Will Be Created In Is Required.

Publishes A Shared Draft Of A Page Created From A Blueprint. By Default, The Following Objects Are Expanded (Body.Storage, History, Space, Version, Ancestors). Permission To View The Draft And 'Add' Permission For The Space That The Content Will Be Created In Is Required.

Redacts Sensitive Content In A Confluence Blog Post By Replacing Specified Text Ranges With Redaction Markers. Each Redaction In The Response Includes A Unique UUID For Restoration (Except Code Block Redactions). The Response Metadata Items Maintain The Same Order As The Input Redaction Pointers, And Completely Overlapping Redactions Are Merged Into A Single Redaction With One UUID. This Endpoint Can Be Accessed Using Basic Authentication (Email And API Token). Note - This Endpoint Requires Atlassian Guard Premium.

Redacts Sensitive Content In A Confluence Page By Replacing Specified Text Ranges With Redaction Markers. Each Redaction In The Response Includes A Unique UUID For Restoration (Except Code Block Redactions). The Response Metadata Items Maintain The Same Order As The Input Redaction Pointers, And Completely Overlapping Redactions Are Merged Into A Single Redaction With One UUID. This Endpoint Can Be Accessed Using Basic Authentication (Email And API Token). Note - This Endpoint Requires Atlassian Guard Premium.

Registers A List Of Modules. For The List Of Modules That Support Dynamic Registration, See Dynamic Modules. Only Connect Apps Can Make This Request.

Remove A Label From A Specific Content Item In Confluence.

Removes The Content State Of The Content Specified And Creates A New Version (Publishes The Content Without Changing The Body) Of The Content With The New Status. Permission To Edit The Content Is Required.

Removes A User As A Watcher From A Piece Of Content. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Removes A Group From A Content Restriction. That Is, Remove Read Or Update Permission For The Group For A Piece Of Content. Permission To Edit The Content Is Required.

Removes A Label From A Piece Of Content. Labels Can'T Be Deleted From Archived Content. This Is Similar To Remove Label From Content Using Query Parameter Except That The Label Name Is Specified Via A Path Parameter. Use This Method If The Label Name Does Not Have '/' Characters, As The Path Parameter Does Not Accept '/' Characters For Security Reasons. Otherwise, Use Remove Label From Content Using Query Parameter. Permission To Update The Content Is Required.

Removes A Label From A Piece Of Content. Labels Can'T Be Deleted From Archived Content. This Is Similar To Remove Label From Content Except That The Label Name Is Specified Via A Query Parameter. Use This Method If The Label Name Has '/' Characters, As Remove Label From Content Using Query Parameter Does Not Accept '/' Characters For The Label Name. Permission To Update The Content Is Required.

Removes A User As A Watcher From A Label. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Remove User As A Member From A Group.

Remove All Or A List Of Modules Registered By The Calling App. Nonexistent Keys Are Ignored. Only Connect Apps Can Make This Request.

Removes A User As A Watcher From A Space. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.

Deletes A Template. This Results In Different Actions Depending On The Type Of Template. If The Template Is A Content Template, It Is Deleted. If The Template Is A Modified Space-Level Blueprint Template, It Reverts To The Template Inherited From The Global-Level Blueprint Template. If The Template Is A Modified Global-Level Blueprint Template, It Reverts To The Default Global-Level Blueprint Template. Note, Unmodified Blueprint Templates Cannot Be Deleted. 'Admin' Permission For The Space To Delete A Space Template Or 'Confluence Administrator' Global Permission To Delete A Global Template Is Required.

Removes A User From A Content Restriction. That Is, Remove Read Or Update Permission For The User For A Piece Of Content. Permission To Edit The Content Is Required.

Resets The Classification Level For A Specific Blog Post To The Space Default Classification Level.

Resets The Classification Level For A Specific Database To The Space Default Classification Level.

Resets The Custom Look And Feel Settings For The Site Or A Single Space. This Changes The Values Of The Custom Settings To Be The Same As The Default Settings. It Does Not Change Which Settings (Default Or Custom) Are Selected. Note, The Default Space Settings Are Inherited From The Current Global Settings.

Resets The Classification Level For A Specific Page To The Space Default Classification Level.

Reset Space Theme To Default, Removing Custom Styling And Reverting To Instance-Wide Theme Settings. Resets The Space Theme. This Means That The Space Will Inherit The Global Look And Feel Settings.

Resets The Classification Level For A Specific Whiteboard To The Space Default Classification Level.

Restores A Historical Version To Be The Latest Version. That Is, A New Version Is Created With The Content Of The Historical Version. Permission To Update The Content Is Required.

Search For Content In Confluence Using CQL (Confluence Query Language). Returns Paginated Results With Next And Prev URLs For Navigation.

Returns The List Of Content That Matches A Confluence Query Language (CQL) Query. For Information On CQL, See Advanced Searching Using CQL. When Additional Results Are Available, Returns Next And Prev URLs To Retrieve Them In Subsequent Calls. The URLs Each Contain A Cursor That Points To The Appropriate Set Of Results. Use Limit To Specify The Number Of Results Returned In Each Call. If The Expand Query Parameter Is Used With The Body.Export_view And/Or Body.Styled_view Properties, Then The Query Limit Parameter Will Be Restricted To A Maximum Value Of 25. Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required. Only Content That The User Has Permission To View Will Be Returned.

Get Search Results Of Groups By Partial Query Provided.

Search For Users In Confluence Using User-Specific CQL Queries. Only Supports User-Specific Fields Like User, User.Fullname, User.Accountid, And User.Userkey.

Sets The Look And Feel Settings To The Default (Global) Settings, The Custom Settings, Or The Current Theme'S Settings For A Space. The Custom And Theme Settings Can Only Be Selected If There Is Already A Theme Set For A Space. Note, The Default Space Settings Are Inherited From The Current Global Settings.

Sets The Content State Of The Content Specified And Creates A New Version (Publishes The Content Without Changing The Body) Of The Content With The New State. You May Pass In Either An Id Of A State, Or The Name And Color Of A Desired New State. If All 3 Are Passed In, Id Will Be Used. If The Name And Color Passed In Already Exist Under The Current User'S Existing Custom States, The Existing State Will Be Reused. If Custom States Are Disabled In The Space Of The Content (Which Can Be Determined By Getting The Content State Space Settings Of The Content'S Space) Then This Set Will Fail. You May Not Remove A Content State Via This PUT Request. You Must Use The DELETE Method. A Specified State Is Required In The Body Of This Request. Permission To Edit The Content Is Required.

Sets The Retention Period For Records In The Audit Log. The Retention Period Can Be Set To A Maximum Of 1 Year.

Sets Space Role Assignments As Specified In The Payload. Permission To Manage Roles In The Space Is Required. Direct API Access Using OAuth 2.0 Or Basic Auth (Email + API Token) Is Supported.

Apply A Theme To A Space, Customizing The Look And Feel With Colors, Fonts, And Styling Configuration. Sets The Theme For A Space. Note, If You Want To Reset The Space Theme To The Default Confluence Theme, Use The 'Reset Space Theme' Method Instead Of This Method.

Update A Space Role. User Must Be An Organization Or Site Admin. Connect And Forge App Users Are Not Authorized To Access This Resource. Direct API Access Using OAuth 2.0 Or Basic Auth (Email + API Token) Is Supported For Admin Users.

Updates The Binary Data Of An Attachment, Given The Attachment ID, And Optionally The Comment And The Minor Edit Field. This Method Is Essentially The Same As Create Or Update Attachments, Except That It Matches The Attachment ID Rather Than The Name. Note, You Must Set A X-Atlassian-Token Nocheck Header On The Request For This Method, Otherwise It Will Be Blocked. This Protects Against XSRF Attacks, Which Is Necessary As This Method Accepts Multipart/Form-Data. Permission To Update The Content Is Required.

Updates The Attachment Properties, I.E. The Non-Binary Data Of An Attachment Like The Filename, Media-Type, Comment, And Parent Container. Permission To Update The Content Is Required.

Update A Blog Post By Id.

Updates The Classification Level For A Specific Blog Post.

Updates Restrictions For A Piece Of Content. This Removes The Existing Restrictions And Replaces Them With The Restrictions In The Request. Permission To Edit The Content Is Required.

Updates A Content Template. Note, Blueprint Templates Cannot Be Updated Via The REST API. 'Admin' Permission For The Space To Update A Space Template Or 'Confluence Administrator' Global Permission To Update A Global Template Is Required.

Updates The Classification Level For A Specific Database.

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.

Updates The Classification Level For A Specific Page.

Updates The Title Of A Specified Page.

Update The Default Classification Level For A Specific Space.

Update A Space Property By Its Id.

Updates The Settings For A Space. Currently Only The `RouteOverrideEnabled` Setting Can Be Updated.

Update A Task By Id. This Endpoint Currently Only Supports Updating Task Status. Permission To Edit The Containing Page Or Blog Post And View Its Corresponding Space Is Required.

Updates A Property For The Given User. Note, You Cannot Update The Key Of A User Property, Only The Value. These Properties Stored Against A User Are On A Confluence Site Level And Not Space Or Content Level. Permission To Access The Confluence Site Is Required.

Updates The Classification Level For A Specific Whiteboard.