00mjk / confluenceps

Confluence REST API (including Cloud) via PowerShell

layout	permalink
module	/module/ConfluencePS/

ConfluencePS

Automate your documentation! ConfluencePS is a PowerShell module that interacts with Atlassian's Confluence wiki product.

Need to add 100 new pages based on some dumb CSV file? Are you trying to figure out how to delete all pages labeled 'deleteMe'? Are you sick of manually editing the same page every single day? ConfluencePS has you covered!

ConfluencePS communicates with Atlassian's actively supported REST API via basic authentication. The REST implementation is the only way to interact with their cloud-hosted instances via API, and will eventually be the only way to interact with server installations.

Join the conversation on AtlassianPS.Slack.com

---

Instructions

Installation

Install ConfluencePS from the PowerShell Gallery! Install-Module requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link)

# One time only install: (requires an admin PowerShell window)
Install-Module ConfluencePS

# Check for updates occasionally:
Update-Module ConfluencePS

# To use each session:
Import-Module ConfluencePS
Set-ConfluenceInfo -BaseURI 'https://YourCloudWiki.atlassian.net/wiki' -PromptCredentials

Usage

You can find the full documentation on our homepage and in the console.

# Review the help at any time!
Get-Help about_ConfluencePS
Get-Command -Module ConfluencePS
Get-Help Get-ConfluencePage -Full   # or any other command

For first steps to get up and running, check out the Getting Started page.

Contribute

Want to contribute to AtlassianPS? Great! We appreciate everyone who invests their time to make our modules the best they can be.

Check out our guidelines on Contributing to our modules and documentation.

Tested on

Configuration	Status
Windows Powershell v3
Windows Powershell v4
Windows Powershell v5.1
Powershell Core (latest) on Windows
Powershell Core (latest) on Ubuntu
Powershell Core (latest) on MacOS

Acknowledgements

• Thanks to brianbunke for getting this module on it's feet
• Thanks to thomykay for his PoshConfluence SOAP API module, which provided enough of a starting point to feel comfortable undertaking this project.
• Thanks to everyone (Our Contributors) that helped with this module

Useful links

• Source Code
• Latest Release
• Submit an Issue
• How you can help us: List of Issues

Disclaimer

Hopefully this is obvious, but:

This is an open source project (under the MIT license), and all contributors are volunteers. All commands are executed at your own risk. Please have good backups before you start, because you can delete a lot of stuff if you're not careful.