Atlassian Confluence Server

Use the Atlassian Confluence Server API integration to manage your Confluence spaces and content.

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

Configure Atlassian Confluence Server on Demisto

  1. Navigate to Settings > Integrations > Servers & Services .
  2. Search for Atlassian Confluence Server.
  3. Click Add instance to create and configure a new integration instance.
    • Name : a textual name for the integration instance.
    • Server URL (e.g. http://1.2.3.4:8090)
    • Username
    • Use system proxy settings
    • Trust any certificate (not secure)
  4. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Demisto 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.

  1. Create a space: confluence-create-space
  2. Create content for a space: confluence-create-content
  3. Get a list of all spaces: confluence-list-spaces
  4. Get content for a space: confluence-get-content
  5. Delete content: confluence-delete-content
  6. Update (overwrite) existing content: confluence-update-content
  7. Run a CQL query: confluence-search-content

1. Create a space


Creates a new Confluence space.

Base Command

confluence-create-space

Input
Argument Name Description Required
name Space name, for example: “Test Space”. Required
description A description for the space. Required
key Space key, which will be used as input when creating or updating child components from a space. Required

Context Output
Path Type Description
Confluence.Space.ID string Space ID.
Confluence.Space.Key string Space key.
Confluence.Space.Name string Space name.

Command Example
!confluence-create-space name=test description="testing space" key=TEST
Human Readable Output

image

2. Create content for a space


Creates Confluence content for a given space.

Base Command

confluence-create-content

Input
Argument Name Description Required
title Confluence page title. Required
type Confluence content type. Can be “page” or “blogpost”. Required
space Space key to add content to a specific space. Required
body Confluence page body to add. Optional

Context Output
Path Type Description
Confluence.Content.ID string Page content ID.
Confluence.Content.Title string Content title.
Confluence.Content.Type string Content type.
Confluence.Content.Body string Content body.

Command Example
!confluence-create-content space=DemistoContent title="test confluence integration" type=page body=testing
Human Readable Output

image

3. Get a list of all spaces


Returns a list of all Confluence spaces.

Base Command

confluence-list-spaces

Input
Argument Name Description Required
limit Maximum number of spaces to return. Optional
type Filter the returned list of spaces by type. Can be “global” or “personal”. Optional
status Filter the returned list of spaces by status. Can be “current” or “archived”. Optional

Context Output
Path Type Description
Confluence.Space.ID string Space ID.
Confluence.Space.Key string Space key.
Confluence.Space.Name string Space name.

Command Example
!confluence-list-spaces
Human Readable Output

image

4. Get content for a space


Returns Confluence content by space key and title.

Base Command

confluence-get-content

Input
Argument Name Description Required
key Space key. Required
title Content title. Required

Context Output
Path Type Description
Confluence.Content.ID string Content ID.
Confluence.Content.Title string Content title.
Confluence.Content.Type string Content type.
Confluence.Content.Version string Content version.
Confluence.Content.Body string Content body.

Command Example
!confluence-get-content key=DemistoContent title=“test confluence integration”
Human Readable Output

image

5. Delete content


Deletes Confluence content.

Base Command

confluence-delete-content

Input
Argument Name Description Required
id Content ID Required

Context Output
Path Type Description
Confluence.Content.Result string Content delete result.
Confluence.Content.ID string Content ID deleted.

Command Example
!confluence-delete-content id=172723162
Human Readable Output

image

6. Update (overwrite) existing content


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

Base Command

confluence-update-content

Input
Argument Name Description Required
pageid Page ID used to find and update the page. Required
currentversion The version number, extracted from a content search. The integration will increment by 1. Required
title Title of the page to update. Required
type Content type. Can be “page” or “blogpost”. Required
space Space key to update. Required
body Content body to replace (overwrite) existing content of a Confluence page. Optional

Context Output
Path Type Description
Confluence.Content.ID string Content ID.
Confluence.Content.Title string Content title.
Confluence.Content.Type string Content type.
Confluence.Content.Body string Content body.

Command Example
!confluence-update-content type=page pageid=172723162 currentversion=2 space=DemistoContent title="test confluence integration" body="new body"
Human Readable Output

image

7. Run a CQL query


Fetches a list of content using the Confluence Query Language (CQL). For more information about CQL syntax, see the Atlassian Confluence documentation .

Base Command

confluence-search-content

Input
Argument Name Description Required
cql A CQL query string to use to locate content, for example: “space = DEV order by created”. Required
cqlcontext The context in which to execute a CQL search. The context is the JSON serialized form of SearchContext. Optional
expand A CSV list of properties to expand on the content. Optional
start The start point of the collection to return. Optional
limit Maximum number of items to return. This can be restricted by fixed system limits. Default is 25. Optional

Context Output
Path Type Description
Confluence.Content.ID string Content ID.
Confluence.Content.Title string Content title.
Confluence.Content.Type string Content type.
Confluence.Content.Version string Content version.

Command Example
!confluence-search-content cql="title=\"test confluence integration\""
Human Readable Output

image