List remote API functions supported by the Confluence CLI
Remote API Specification documents the remote API capabilities support by Confluence. The table below indicates the current coverage provided by the Confluence Command Line Interface. See the CLI help text to determine how the CLI provides the equivalent functions as they do not map one to one. There are a few undocumented remote APIs also listed. If you need a function not currently supported, create an issue.
Support Matrix
| CLI | API Function |
|---|---|
Authentication Methods
|
|
 |
login |
| |
logout |
Administration
|
|
| |
exportSite |
| getClusterInformation | |
| getClusterNodeStatuses | |
General
|
|
| getServerInfo | |
Spaces
|
|
| |
getSpaces |
| |
getSpace |
| |
exportSpace |
Management
|
|
| |
addSpace |
| |
removeSpace |
| |
addPersonalSpace |
| convertToPersonalSpace | |
Pages
|
|
| |
getPages |
| |
getPage |
| getPageHistory | |
Page Dependents
|
|
| |
getAttachments |
| |
getAncestors |
| |
getChildren |
| |
getDescendents |
| getComments | |
| getComment | |
| |
addComment |
| removeComment | |
Page Management
|
|
| |
storePage |
| |
renderContent |
| |
removePage |
Page Attachments
|
|
| getAttachment | |
| |
getAttachmentData |
| |
addAttachment |
| |
removeAttachment |
| moveAttachment | |
News/Blog Entries
|
|
| |
getBlogEntries |
| |
getBlogEntry |
| |
storeBlogEntry |
| |
getBlogEntryByDayAndTitle |
Search
|
|
| search | |
Security
|
|
| |
getPermissions |
| |
getPermissionsForUser |
| |
getPagePermissions |
| |
getSpaceLevelPermissions |
| |
addPermissionToSpace |
| |
addPermissionsToSpace |
| |
removePermissionFromSpace |
| |
addAnonymousPermissionToSpace |
| |
addAnonymousPermissionsToSpace |
| |
removeAnonymousPermissionFromSpace |
| |
removeAllPermissionsForGroup |
| |
getContentPermissionSets |
| |
getContentPermissionSet |
| |
setContentPermissions |
User Management
|
|
| getUser | |
| |
addUser |
| |
addGroup |
| |
getUserGroups |
| |
addUserToGroup |
| |
removeUserFromGroup |
| |
removeUser |
| |
removeGroup |
| |
getGroups |
| hasUser | |
| hasGroup | |
| editUser | |
| deactivateUser | |
| reactivateUser | |
| |
getActiveUsers |
| setUserInformation | |
| getUserInformation | |
| changeMyPassword | |
| changeUserPassword | |
| addProfilePicture | |
Labels
|
|
| |
getLabelsById |
| |
getMostPopularLabels |
| |
getMostPopularLabelsInSpace |
| |
getRecentlyUsedLabels |
| |
getRecentlyUsedLabelsInSpace |
| |
getSpacesWithLabel |
| |
getRelatedLabels |
| |
getRelatedLabelsInSpace |
| getLabelsByDetail | |
| getLabelContentById | |
| getLabelContentByName | |
| getLabelContentByObject | |
| getSpacesContainingContentWithLabel | |
| |
addLabelByName |
| addLabelById | |
| addLabelByObject | |
| |
addLabelByNameToSpace |
| |
removeLabelByName |
| removeLabelById | |
| removeLabelByObject | |
| |
removeLabelByNameFromSpace |