Automate Confluence Integration Tasks from PowerShell

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Confluence ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Confluence.



Are you looking for a quick and easy way to access Confluence data from PowerShell? We show how to use the Cmdlets for Confluence and the CData ADO.NET Provider for Confluence to connect to Confluence data and synchronize, automate, download, and more.

The CData Cmdlets for Confluence are standard PowerShell cmdlets that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Confluence.

Cmdlets or ADO.NET?

The cmdlets are not only a PowerShell interface to the Confluence API, but also an SQL interface; this tutorial shows how to use both to retrieve Confluence data. We also show examples of the ADO.NET equivalent, which is possible with the CData ADO.NET Provider for Confluence. To access Confluence data from other .NET applications, like LINQPad, use the CData ADO.NET Provider for Confluence.

After obtaining the needed connection properties, accessing Confluence data in PowerShell consists of three basic steps.

Obtaining an API Token

An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Connect Using a Confluence Cloud Account

To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

  • User: The user which will be used to authenticate with the Confluence server.
  • APIToken: The API Token associated with the currently authenticated user.
  • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Connect Using a Confluence Server Instance

To connect to a Server instance, provide the following:

  • User: The user which will be used to authenticate with the Confluence instance.
  • Password: The password which will be used to authenticate with the Confluence server.
  • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

PowerShell

  1. Install the module:

    Install-Module ConfluenceCmdlets
  2. Connect:

    $confluence = Connect-Confluence -User "$User" -APIToken "$APIToken" -Url "$Url" -Timezone "$Timezone"
  3. Search for and retrieve data:

    $id = "10000" $pages = Select-Confluence -Connection $confluence -Table "Pages" -Where "Id = `'$Id`'" $pages

    You can also use the Invoke-Confluence cmdlet to execute SQL commands:

    $pages = Invoke-Confluence -Connection $confluence -Query 'SELECT * FROM Pages WHERE Id = @Id' -Params @{'@Id'='10000'}

ADO.NET

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData ADO.NET Provider for Confluence\lib\System.Data.CData.Confluence.dll")
  2. Connect to Confluence:

    $conn= New-Object System.Data.CData.Confluence.ConfluenceConnection("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;") $conn.Open()
  3. Instantiate the ConfluenceDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Key, Name from Pages" $da= New-Object System.Data.CData.Confluence.ConfluenceDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { Write-Host $_.key $_.name }