Skip to main content

Atlassian Confluence Server

This Integration is part of the Atlassian Confluence Server Pack.#

Atlassian Confluence Server API. This integration was integrated and tested with version 6.1 of Atlassian Confluence Server.

Configure Atlassian Confluence Server in Cortex#

ParameterRequired
Server URL (e.g. http://1.2.3.4:8090)True
UsernameFalse
PasswordFalse
Personal Access TokenFalse
Use system proxy settingsFalse
Trust any certificate (not secure)False

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

confluence-create-space#


Creates a new Confluence space.

Base Command#

confluence-create-space

Input#

Argument NameDescriptionRequired
nameSpace name, for example: "Test Space".Required
descriptionA description for the space.Required
keySpace key, which will be used as input when creating or updating child components from a space.Required

Context Output#

PathTypeDescription
Confluence.Space.IDStringSpace ID.
Confluence.Space.KeyStringSpace key.
Confluence.Space.NameStringSpace name.

confluence-create-content#


Creates Confluence content for a given space.

Base Command#

confluence-create-content

Input#

Argument NameDescriptionRequired
titleConfluence page title.Required
typeConfluence content type. Can be "page" or "blogpost". Possible values are: page, blogpost. Default is page.Required
spaceSpace key to add content to a specific space.Required
bodyConfluence page body to add.Optional

Context Output#

PathTypeDescription
Confluence.Content.IDStringPage content ID.
Confluence.Content.TitleStringContent title.
Confluence.Content.TypeStringContent type.
Confluence.Content.BodyStringContent body.

confluence-list-spaces#


Returns a list of all Confluence spaces.

Base Command#

confluence-list-spaces

Input#

Argument NameDescriptionRequired
limitMaximum number of spaces to return. Default is 25.Optional
typeFilter the returned list of spaces by type. Can be "global" or "personal". Possible values are: global, personal.Optional
statusFilter the returned list of spaces by status. Can be "current" or "archived". Possible values are: current, archived.Optional

Context Output#

PathTypeDescription
Confluence.Space.IDStringSpace ID.
Confluence.Space.KeyStringSpace key.
Confluence.Space.NameStringSpace name.

confluence-get-content#


Returns Confluence content by space key and title.

Base Command#

confluence-get-content

Input#

Argument NameDescriptionRequired
keySpace key.Required
titleContent title.Required

Context Output#

PathTypeDescription
Confluence.Content.IDStringContent ID.
Confluence.Content.TitleStringContent title.
Confluence.Content.TypeStringContent type.
Confluence.Content.VersionStringContent version.
Confluence.Content.BodyStringContent body.

confluence-get-page-as-pdf#


Returns Confluence Page as PDF by PageID.

Base Command#

confluence-get-page-as-pdf

Input#

Argument NameDescriptionRequired
pageidID of the Page to download as PDF.Required

Context Output#

PathTypeDescription
File.SizenumberFile size.
File.SHA1stringSHA1 hash of the file.
File.SHA256stringSHA256 hash of the file.
File.NamestringThe sample name.
File.SSDeepstringSSDeep hash of the file.
File.EntryIDstringWar Room entry ID of the file.
File.InfostringBasic information of the file.
File.TypestringFile type, e.g., "PE".
File.MD5stringMD5 hash of the file.
File.ExtensionstringFile extension.

confluence-delete-content#


Deletes Confluence content.

Base Command#

confluence-delete-content

Input#

Argument NameDescriptionRequired
idContent ID.Required

Context Output#

PathTypeDescription
Confluence.Content.ResultStringContent delete result.
Confluence.Content.IDStringContent ID deleted.

confluence-update-content#


Update (overwrite) the existing content of a Confluence page with new content.

Base Command#

confluence-update-content

Input#

Argument NameDescriptionRequired
pageidPage ID used to find and update the page.Required
currentversionThe version number, extracted from a content search. The integration will increment by 1.Required
titleTitle of the page to update.Required
typeContent type. Can be "page" or "blogpost". Possible values are: page, blogpost. Default is page.Required
spaceSpace key to update.Required
bodyContent body to replace (overwrite) existing content of a Confluence page.Optional

Context Output#

PathTypeDescription
Confluence.Content.IDStringContent ID.
Confluence.Content.TitleStringContent title.
Confluence.Content.TypeStringContent type.
Confluence.Content.BodyStringContent body.

confluence-search-content#


Fetches a list of content using the Confluence Query Language (CQL). For more information about CQL syntax, see https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/

Base Command#

confluence-search-content

Input#

Argument NameDescriptionRequired
cqlA CQL query string to use to locate content, for example: "space = DEV order by created".Required
cqlcontextThe context in which to execute a CQL search. The context is the JSON serialized form of SearchContext.Optional
expandA CSV list of properties to expand on the content. Default is version.Optional
startThe start point of the collection to return.Optional
limitMaximum number of items to return. This can be restricted by fixed system limits. Default is 25. Default is 25.Optional

Context Output#

PathTypeDescription
Confluence.Content.IDStringContent ID.
Confluence.Content.TitleStringContent title.
Confluence.Content.TypeStringContent type.
Confluence.Content.VersionStringContent version.