Atlassian Confluence Server

Details

ID	`Atlassian Confluence Server`
Provider	Atlassian
Category	Utilities
From Version	5.0.0
Docker Image	`demisto/python3:3.12.13.10116658`
Supported Modules	Agentix XSIAM

README

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

Configure Atlassian Confluence Server in Cortex

Parameter	Required
Server URL (e.g. http://1.2.3.4:8090)	True
Username	False
Password	False
Personal Access Token	False
Use system proxy settings	False
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 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.

confluence-create-content

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”. Possible values are: page, blogpost. Default is page.	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.

confluence-list-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. Default is 25.	Optional
type	Filter the returned list of spaces by type. Can be “global” or “personal”. Possible values are: global, personal.	Optional
status	Filter the returned list of spaces by status. Can be “current” or “archived”. Possible values are: current, 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.

confluence-get-content

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.

confluence-get-page-as-pdf

Returns Confluence Page as PDF by PageID.

Base Command

confluence-get-page-as-pdf

Input

Argument Name	Description	Required
pageid	ID of the Page to download as PDF.	Required

Context Output

Path	Type	Description
File.Size	number	File size.
File.SHA1	string	SHA1 hash of the file.
File.SHA256	string	SHA256 hash of the file.
File.Name	string	The sample name.
File.SSDeep	string	SSDeep hash of the file.
File.EntryID	string	War Room entry ID of the file.
File.Info	string	Basic information of the file.
File.Type	string	File type, e.g., “PE”.
File.MD5	string	MD5 hash of the file.
File.Extension	string	File extension.

confluence-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.

confluence-update-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”. Possible values are: page, blogpost. Default is page.	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.

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 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. Default is version.	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. 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.

Configuration parameters

url — Server URL (e.g. http://1.2.3.4:8090) (required)
credentials — Username
personal_access_token —
proxy — Use system proxy settings
unsecure — Trust any certificate (not secure)

Commands (8)

confluence-create-content
Creates Confluence content for a given space.
confluence-create-space
Creates a new Confluence space.
confluence-delete-content
Deletes Confluence content.
confluence-get-content
Returns Confluence content by space key and title.
confluence-get-page-as-pdf
Returns Confluence Page as PDF by PageID.
confluence-list-spaces
Returns a list of all Confluence spaces.
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/
confluence-update-content
Update (overwrite) the existing content of a Confluence page with new content.

Source

Confluence.py Confluence_test.py Confluence.yml Confluence_description.md command_examples.txt

Download History Raw

commonfields:
  id: Atlassian Confluence Server
  version: -1
name: Atlassian Confluence Server
display: Atlassian Confluence Server
category: Utilities
provider: Atlassian
sectionorder:
- Connect
description: Atlassian Confluence Server API.
configuration:
- display: Server URL (e.g. http://1.2.3.4:8090)
  name: url
  defaultvalue: ""
  type: 0
  required: true
  section: Connect
- display: Username
  name: credentials
  defaultvalue: ""
  type: 9
  required: false
  section: Connect
- display: ""
  name: personal_access_token
  type: 9
  required: false
  displaypassword: Personal Access Token
  hiddenusername: true
  section: Connect
- display: Use system proxy settings
  name: proxy
  defaultvalue: "false"
  type: 8
  required: false
  section: Connect
  advanced: true
- display: Trust any certificate (not secure)
  name: unsecure
  defaultvalue: "false"
  type: 8
  required: false
  section: Connect
  advanced: true
script:
  script: ''
  type: python
  subtype: python3
  commands:
  - name: confluence-create-space
    arguments:
    - name: name
      required: true
      description: 'Space name, for example: "Test Space".'
    - name: description
      required: true
      description: A description for the space.
    - name: key
      required: true
      description: Space key, which will be used as input when creating or updating child components from a space.
    outputs:
    - contextPath: Confluence.Space.ID
      description: Space ID.
      type: String
    - contextPath: Confluence.Space.Key
      description: Space key.
      type: String
    - contextPath: Confluence.Space.Name
      description: Space name.
      type: String
    description: Creates a new Confluence space.
  - name: confluence-create-content
    arguments:
    - name: title
      required: true
      description: Confluence page title.
    - name: type
      required: true
      auto: PREDEFINED
      predefined:
      - page
      - blogpost
      description: Confluence content type. Can be "page" or "blogpost".
      defaultValue: page
    - name: space
      required: true
      description: Space key to add content to a specific space.
    - name: body
      description: Confluence page body to add.
    outputs:
    - contextPath: Confluence.Content.ID
      description: Page content ID.
      type: String
    - contextPath: Confluence.Content.Title
      description: Content title.
      type: String
    - contextPath: Confluence.Content.Type
      description: Content type.
      type: String
    - contextPath: Confluence.Content.Body
      description: Content body.
      type: String
    description: Creates Confluence content for a given space.
  - name: confluence-list-spaces
    arguments:
    - name: limit
      defaultValue: 25
      description: Maximum number of spaces to return.
    - name: type
      auto: PREDEFINED
      predefined:
      - global
      - personal
      description: Filter the returned list of spaces by type. Can be "global" or "personal".
    - name: status
      auto: PREDEFINED
      predefined:
      - current
      - archived
      description: Filter the returned list of spaces by status. Can be "current" or "archived".
    outputs:
    - contextPath: Confluence.Space.ID
      description: Space ID.
      type: String
    - contextPath: Confluence.Space.Key
      description: Space key.
      type: String
    - contextPath: Confluence.Space.Name
      description: Space name.
      type: String
    description: Returns a list of all Confluence spaces.
  - name: confluence-get-content
    arguments:
    - name: key
      required: true
      description: Space key.
    - name: title
      required: true
      description: Content title.
    outputs:
    - contextPath: Confluence.Content.ID
      description: Content ID.
      type: String
    - contextPath: Confluence.Content.Title
      description: Content title.
      type: String
    - contextPath: Confluence.Content.Type
      description: Content type.
      type: String
    - contextPath: Confluence.Content.Version
      description: Content version.
      type: String
    - contextPath: Confluence.Content.Body
      description: Content body.
      type: String
    description: Returns Confluence content by space key and title.
  - name: confluence-get-page-as-pdf
    arguments:
    - name: pageid
      required: true
      description: ID of the Page to download as PDF.
    outputs:
    - contextPath: File.Size
      description: File size.
      type: number
    - contextPath: File.SHA1
      description: SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: SHA256 hash of the file.
      type: string
    - contextPath: File.Name
      description: The sample name.
      type: string
    - contextPath: File.SSDeep
      description: SSDeep hash of the file.
      type: string
    - contextPath: File.EntryID
      description: War Room entry ID of the file.
      type: string
    - contextPath: File.Info
      description: Basic information of the file.
      type: string
    - contextPath: File.Type
      description: File type, e.g., "PE".
      type: string
    - contextPath: File.MD5
      description: MD5 hash of the file.
      type: string
    - contextPath: File.Extension
      description: File extension.
      type: string
    description: Returns Confluence Page as PDF by PageID.
  - name: confluence-delete-content
    arguments:
    - name: id
      required: true
      description: Content ID.
    outputs:
    - contextPath: Confluence.Content.Result
      description: Content delete result.
      type: String
    - contextPath: Confluence.Content.ID
      description: Content ID deleted.
      type: String
    description: Deletes Confluence content.
    execution: true
  - name: confluence-update-content
    arguments:
    - name: pageid
      required: true
      description: 'Page ID used to find and update the page.'
    - name: currentversion
      description: The version number, extracted from a content search. The integration will increment by 1.
      required: true
    - name: title
      description: Title of the page to update.
      required: true
    - name: type
      description: Content type. Can be "page" or "blogpost".
      required: true
      auto: PREDEFINED
      predefined:
      - page
      - blogpost
      defaultValue: page
    - name: space
      description: Space key to update.
      required: true
    - name: body
      description: Content body to replace (overwrite) existing content of a Confluence page.
    outputs:
    - contextPath: Confluence.Content.ID
      description: Content ID.
      type: String
    - contextPath: Confluence.Content.Title
      description: Content title.
      type: String
    - contextPath: Confluence.Content.Type
      description: Content type.
      type: String
    - contextPath: Confluence.Content.Body
      description: Content body.
      type: String
    description: 'Update (overwrite) the existing content of a Confluence page with new content.'
    execution: true
  - name: confluence-search-content
    arguments:
    - name: cql
      required: true
      description: 'A CQL query string to use to locate content, for example: "space = DEV order by created".'
    - name: cqlcontext
      description: The context in which to execute a CQL search. The context is the JSON serialized form of SearchContext.
    - name: expand
      description: A CSV list of properties to expand on the content.
      defaultValue: version
    - name: start
      description: The start point of the collection to return.
    - name: limit
      description: Maximum number of items to return. This can be restricted by fixed system limits. Default is 25.
      defaultValue: "25"
    outputs:
    - contextPath: Confluence.Content.ID
      description: Content ID.
      type: String
    - contextPath: Confluence.Content.Title
      description: Content title.
      type: String
    - contextPath: Confluence.Content.Type
      description: Content type.
      type: String
    - contextPath: Confluence.Content.Version
      description: Content version.
      type: String
    description: '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/'
  dockerimage: demisto/python3:3.12.13.10116658
tests:
- No test - the test requires personal credentials to the confluence account
fromversion: 5.0.0