Pipe Confluence Data to CSV in PowerShell

The CData Cmdlets Module for Confluence is a standard PowerShell module offering straightforward integration with Confluence. Below, you will find examples of using our Confluence Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Confluence Data

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.

$conn = Connect-Confluence  -User "$User" -APIToken "$APIToken" -Url "$Url" -Timezone "$Timezone"

Selecting Data

Follow the steps below to retrieve data from the Pages table and pipe the result into to a CSV file:

Select-Confluence -Connection $conn -Table Pages | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myPagesData.csv -NoTypeInformation

You will notice that we piped the results from Select-Confluence into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.