@managed-api/confluence-cloud-core
v3.2.0
Published
Adaptavist Managed API for Confluence Cloud
Downloads
33
Keywords
Readme
Managed API for Confluence Cloud
Managed API for Confluence Cloud is an API Client for Confluence Cloud by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.
This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.
Platform specific ports
Supported API calls
- fetch
- Content
- createContent
- deleteContent
- getContent
- getContentById
- getContentHistory
- publishLegacyDraft
- publishSharedDraft
- searchContentByCQL
- updateContent
- Attachment
- Body
- Children
- Comment
- Copy
- Descendant
- Label
- Move
- Property
- Restriction
- Version
- DynamicModule
- InlineTask
- Label
- LongRunningTask
- Relation
- Search
- Setting
- Space
- Template
- Theme
- User
- UserGroup
- Watcher
Porting to other runtimes
While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.
You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:
{
buffer: {
encode(input: string): ArrayBuffer;
decode(input: ArrayBuffer): string;
},
performHttpCall(request: Request): Promise<Response>
}Here is an example how to create a Node port of the Managed API:
import { ConfluenceCloudApiCore } from "@managed-api/confluence-cloud-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class ConfluenceCloudApi extends ConfluenceCloudApiCore {
constructor(private baseUrl: string, private authToken: string) {
super();
}
protected getPlatformImplementation(): PlatformImplementation {
return {
buffer: {
encode: (input) => Buffer.from(input, 'utf-8'),
decode: (input) => Buffer.from(input).toString('utf-8')
},
performHttpCall: (request) => this.performHttpCall(request)
};
}
private async performHttpCall(request: Request): Promise<Response> {
const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
const response = await fetch(requestUrl, {
method: request.method,
headers: request.headers as any,
body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
});
const apiHeaders = new Headers();
response.headers.forEach((value, key) => apiHeaders.append(key, value));
const body = await response.arrayBuffer();
return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
}
}Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.
Contact
At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.
Changelog
3.1.0
- Removed non-empty body from HEAD requests.
3.0.0
Changed the following methods:
Content.Attachment.updateAttachmentProperties- Request body parameters got updated.Content.Move.movePageToNewLocationRelativeToTargetPage- Path got fixed.Content.Restriction.Group.getGroupStatus-groupNamegot replaced bygroupId.Content.Restriction.Group.addGroup-groupNamegot replaced bygroupId.Content.Restriction.Group.removeGroup-groupNamegot replaced bygroupId.UserGroup.deleteUserGroup-nameparameter got replaced byid.UserGroup.getUserGroupByName- Method was removed, alternative isUserGroup.getUserGroupById.UserGroup.Member.getMembersByName- Method was removed, alternative isUserGroup.Member.getMembersById.UserGroup.Member.getMembersById-expandparameter was added.UserGroup.Member.addMemberByName- Method was removed, alternative isUserGroup.Member.addMemberById.UserGroup.Member.removeMember- Method was removed, alternative isUserGroup.Member.removeMemberById.LongRunningTask.getLongRunningTasks-Keyparameter was added.Search.searchUsers-sitePermissionTypeFilterparameter was added.Template.getBlueprintTemplates-body.storageoption was added toexpand.Template.getContentTemplates-body.storageoption was added toexpand.User.getUsersWithIds-isExternalCollaboratoroption was added toexpand,limitwas removed.User.getUserAccountIds- Method was removed.
The following methods are deprecated:
- Convert content body that can be used as
Content.Body.convertBodyorAll.convertContentBody. - Get content descendants that can be used as
Content.Descendant.getDescendantsorAll.getContentDescendants. - Get content descendants by type that can be used as
Content.Descendant.getDescendantsByTypeorAll.getContentDescendantsByType.
- Convert content body that can be used as
The following methods are added:
- Asynchronously convert content body that can be used as
Content.Body.asyncConvertBodyorAll.asyncConvertContentBody. - Get asynchronously converted content body from the id or the current status of the task that can be used as
Content.Body.getAsyncConvertResultorAll.getAsyncConvertContentBodyResult.
- Asynchronously convert content body that can be used as
2.1.0
The following methods are deprecated:
- Get content properties that can be used as
Content.Property.getPropertiesorAll.getContentProperties. - Create content property that can be used as
Content.Property.createPropertyorAll.createContentProperty. - Get content property that can be used as
Content.Property.getPropertyorAll.getContentProperty. - Update content property that can be used as
Content.Property.updatePropertyorAll.updateContentProperty. - Create content property for key that can be used as
Content.Property.createPropertyForKeyorAll.createContentPropertyForKey. - Delete content property that can be used as
Content.Property.deletePropertyorAll.deleteContentProperty. - Get content restriction status for group that can be used as
Content.Restriction.Group.getGroupStatusorAll.getContentRestrictionGroupStatus. - Add group to content restriction that can be used as
Content.Restriction.Group.addGrouporAll.addContentRestrictionGroup. - Remove group from content restriction that can be used as
Content.Restriction.Group.removeGrouporAll.removeContentRestrictionGroup. - Delete user group that can be used as
UserGroup.deleteUserGrouporAll.deleteUserGroup. - Get group that can be used as
UserGroup.getUserGroupByNameorAll.getUserGroupByName. - Get group members that can be used as
UserGroup.Member.getMembersByNameorAll.getUserGroupMembersByName. - Add member to group that can be used as
UserGroup.Member.addMemberByNameorAll.addUserGroupMembersByName. - Remove member from group that can be used as
UserGroup.Member.removeMemberorAll.removeUserGroupMember. - Create space property that can be used as
Space.Property.createPropertyorAll.createSpaceProperty. - Get space property that can be used as
Space.Property.getPropertyorAll.getSpaceProperty. - Update space property that can be used as
Space.Property.updatePropertyorAll.updateSpaceProperty. - Create space property for key that can be used as
Space.Property.createPropertyForKeyorAll.createSpacePropertyForKey. - Delete space property that can be used as
Space.Property.deletePropertyorAll.deleteSpaceProperty.
- Get content properties that can be used as
2.0.0
Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.
0.11.0
The following methods are deprecated:
- Get content that can be used as
Content.getContentorAll.getContent. - Create Content that can be used as
Content.createContentorAll.createContent. - Get content by ID that can be used as
Content.getContentByIdorAll.getContentById. - Update content that can be used as
Content.updateContentorAll.updateContent. - Delete content that can be used as
Content.deleteContentorAll.deleteContent. - Get content history that can be used as
Content.getContentHistoryorAll.getContentHistory. - Get attachments that can be used as
Content.Attachment.getAttachmentsorAll.getContentAttachments. - Get content children that can be used as
Content.Children.getAttachmentsorAll.getContentChildren. - Get content children by type that can be used as
Content.Children.getChildrenByTypeorAll.getContentChildrenByType. - Get content comments that can be used as
Content.Comment.getCommentsorAll.getContentComments. - Get labels for content that can be used as
Content.Label.getLabelsorAll.getContentLabels. - Get content versions that can be used as
Content.Version.getVersionsorAll.getContentVersions. - Get content version that can be used as
Content.Version.getVersionorAll.getContentVersion. - Get inline tasks based on search parameters that can be used as
InlineTask.getInlineTasksBasedOnSearchParametersorAll.getInlineTasksBasedOnSearchParameters. - Get spaces that can be used as
Space.getSpacesorAll.getSpaces. - Get space that can be used as
Space.getSpaceorAll.getSpace. - Get content for space that can be used as
Space.Content.getContentorAll.getSpaceContent. - Get content by type for space that can be used as
Space.Content.getContentByTypeorAll.getSpaceContentByType. - Get space properties that can be used as
Space.Property.getPropertiesorAll.getSpaceProperties.
- Get content that can be used as
Copyright Adaptavist 2025 (c) All rights reserved
