On this page

Remove-Page

SYNOPSIS

Trash an existing Confluence page.

SYNTAX

Remove-ConfluencePage -apiURi <Uri> -Credential <PSCredential> [-PageID] <Int32[]> [-WhatIf] [-Confirm]

DESCRIPTION

Delete existing Confluence content by page ID.

This trashes most content, but will permanently delete “un-trashable” content.

Untested against non-page content.

EXAMPLES

————————– EXAMPLE 1 ————————–

Remove-ConfluencePage -PageID 123456 -Verbose -Confirm

Trash the wiki page with ID 123456. Verbose and Confirm flags both active; you will be prompted before removal.

————————– EXAMPLE 2 ————————–

Get-ConfluencePage -SpaceKey ABC -Title '*test*' | Remove-ConfluencePage -WhatIf

For all wiki pages in space ABC with “test” somewhere in the name, simulate the each page being trashed. -WhatIf prevents any removals.

————————– EXAMPLE 3 ————————–

Get-ConfluencePage -Label 'deleteMe' | Remove-ConfluencePage

For all wiki pages with the label “deleteMe” applied, trash each page.

PARAMETERS

-apiURi

The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.

Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Confluence’s credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageID

The page ID to delete. Accepts multiple IDs via pipeline input.

Type: Int32[]
Parameter Sets: (All)
Aliases: ID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

System.Boolean

NOTES

https://github.com/AtlassianPS/ConfluencePS