Class ConfluenceApiV2

The Confluence REST API V2 Client.

Hierarchy (view full)

BaseConfluenceApiV2Client
- ConfluenceApiV2

Index

Constructor

constructor

new ConfluenceApiV2(options): ConfluenceApiV2
Parameters
- options: ApiClientOptions<
      | ApiClientAceOptions
      | ApiClientApOptions
      | ApiClientForgeApiExternalOptions
      | ApiClientForgeApiOptions
      | ApiClientForgeApiWithProviderOptions
      | ApiClientForgeBridgeConfluenceOptions>
Returns ConfluenceApiV2
Overrides BaseConfluenceApiV2Client.constructor

Impersonalization

asApp

asApp: (() => ConfluenceApiV2) = ...

Switches the API client to the app context.

asUser

asUser: ((userAccountId?: string) => ConfluenceApiV2) = ...

Switches the API client to the user context.

Services

adminKey

get adminKey(): AdminKeyService
The Admin Key feature is only offered with Confluence Cloud Premium and Enterprise to organization or site admins.

NOTE: Users can only make calls to our public REST APIs using a valid Admin Key by adding the following HTTP header on their requests: Atl-Confluence-With-Admin-Key: true. Visit the Confluence Cloud Changelog for more details.

Returns AdminKeyService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-admin-key

Inherited from BaseConfluenceApiV2Client.adminKey

ancestors

get ancestors(): AncestorsService
Returns AncestorsService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

Inherited from BaseConfluenceApiV2Client.ancestors

appProperties

get appProperties(): AppPropertiesService
Returns AppPropertiesService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-app-properties

Inherited from BaseConfluenceApiV2Client.appProperties

attachment

get attachment(): AttachmentService
Returns AttachmentService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment

Inherited from BaseConfluenceApiV2Client.attachment

blogPost

get blogPost(): BlogPostService
Returns BlogPostService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post

Inherited from BaseConfluenceApiV2Client.blogPost

children

get children(): ChildrenService
Returns ChildrenService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children

Inherited from BaseConfluenceApiV2Client.children

classificationLevel

get classificationLevel(): ClassificationLevelService
Returns ClassificationLevelService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level

Inherited from BaseConfluenceApiV2Client.classificationLevel

comment

get comment(): CommentService
Returns CommentService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

Inherited from BaseConfluenceApiV2Client.comment

content

get content(): ContentService
Returns ContentService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content

Inherited from BaseConfluenceApiV2Client.content

contentProperties

get contentProperties(): ContentPropertiesService
Returns ContentPropertiesService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

Inherited from BaseConfluenceApiV2Client.contentProperties

customContent

get customContent(): CustomContentService
Returns CustomContentService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content

Inherited from BaseConfluenceApiV2Client.customContent

database

get database(): DatabaseService
Returns DatabaseService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database

Inherited from BaseConfluenceApiV2Client.database

dataPolicies

get dataPolicies(): DataPoliciesService
Returns DataPoliciesService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-data-policies

Inherited from BaseConfluenceApiV2Client.dataPolicies

descendants

get descendants(): DescendantsService
Returns DescendantsService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants

Inherited from BaseConfluenceApiV2Client.descendants

eap

get eap(): EapService
Returns EapService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap

Inherited from BaseConfluenceApiV2Client.eap

folder

get folder(): FolderService
Returns FolderService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder

Inherited from BaseConfluenceApiV2Client.folder

label

get label(): LabelService
Returns LabelService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label

Inherited from BaseConfluenceApiV2Client.label

like

get like(): LikeService
Returns LikeService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like

Inherited from BaseConfluenceApiV2Client.like

operation

get operation(): OperationService
Returns OperationService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation

Inherited from BaseConfluenceApiV2Client.operation

page

get page(): PageService
Returns PageService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page

Inherited from BaseConfluenceApiV2Client.page

redactions

get redactions(): RedactionsService
Returns RedactionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-redactions

Inherited from BaseConfluenceApiV2Client.redactions

smartLink

get smartLink(): SmartLinkService
Returns SmartLinkService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link

Inherited from BaseConfluenceApiV2Client.smartLink

space

get space(): SpaceService
Returns SpaceService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space

Inherited from BaseConfluenceApiV2Client.space

spacePermissions

get spacePermissions(): SpacePermissionsService
Returns SpacePermissionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions

Inherited from BaseConfluenceApiV2Client.spacePermissions

spaceProperties

get spaceProperties(): SpacePropertiesService
Returns SpacePropertiesService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties

Inherited from BaseConfluenceApiV2Client.spaceProperties

spaceRoles

get spaceRoles(): SpaceRolesService
Returns SpaceRolesService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles

Inherited from BaseConfluenceApiV2Client.spaceRoles

task

get task(): TaskService
Returns TaskService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task

Inherited from BaseConfluenceApiV2Client.task

user

get user(): UserService
Returns UserService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user

Inherited from BaseConfluenceApiV2Client.user

version

get version(): VersionService
Returns VersionService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version

Inherited from BaseConfluenceApiV2Client.version

whiteboard

get whiteboard(): WhiteboardService
Returns WhiteboardService
See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard

Inherited from BaseConfluenceApiV2Client.whiteboard