On this page

Set-Page

SYNOPSIS

Edit an existing Confluence page.

SYNTAX

byParameters (Default)

Set-ConfluencePage -apiURi <Uri> -Credential <PSCredential> -PageID <Int32> [-Title <String>] [-Body <String>] [-Convert] [-ParentID <Int32>] [-Parent <Page>] [-WhatIf] [-Confirm]

byObject

Set-ConfluencePage -apiURi <Uri> -Credential <PSCredential> -InputObject <Page> [-WhatIf] [-Confirm]

DESCRIPTION

For existing page(s): Edit page content, page title, and/or change parent page.

Content needs to be in “Confluence storage format”. Use -Convert if not preconditioned.

EXAMPLES

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

Set-ConfluencePage -PageID 123456 -Title 'Counting'

For existing wiki page 123456, change its name to “Counting”.

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

Set-ConfluencePage -PageID 123456 -Body 'Hello World!' -Convert

For existing wiki page 123456, update its page contents to “Hello World!” -Convert applies the “Confluence storage format” to your given string.

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

Set-ConfluencePage -PageID 123456 -ParentID 654321
Set-ConfluencePage -PageID 123456 -Parent (Get-ConfluencePage -PageID 654321)

Two different methods to set a new parent page. Parent page 654321 will now have child page 123456.

————————– EXAMPLE 4 ————————–

$page = Get-ConfluencePage -PageID 123456
$page.Title = "New Title"

Set-ConfluencePage -InputObject $page
$page | Set-ConfluencePage

Two different methods to set a new parent page using a ConfluencePS.Page object.

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

-InputObject

Page Object which will be used to replace the current content.

Type: Page
Parameter Sets: byObject
Aliases:

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

-PageID

The ID of the page to edit.

Type: Int32
Parameter Sets: byParameters
Aliases: ID

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Title

Name of the page; existing or new value can be used. Existing will be automatically supplied via Get-Page if not manually included.

Type: String
Parameter Sets: byParameters
Aliases:

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

-Body

The full contents of the updated body (existing contents will be overwritten). If not yet in “storage format”–or you don’t know what that is–also use -Convert.

Type: String
Parameter Sets: byParameters
Aliases:

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

-Convert

Optional switch flag for calling ConvertTo-ConfluenceStorageFormat against your Body.

Type: SwitchParameter
Parameter Sets: byParameters
Aliases:

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

-ParentID

Optionally define a new parent page. If unspecified, no change.

Type: Int32
Parameter Sets: byParameters
Aliases:

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

-Parent

Optionally define a new parent page. If unspecified, no change.

Type: Page
Parameter Sets: byParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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

ConfluencePS.Page

NOTES

https://github.com/AtlassianPS/ConfluencePS