< Back
Remove-ConfluenceSpace
Post
NAME Remove-ConfluenceSpace
SYNOPSIS
Remove an existing Confluence space.
SYNTAX
Remove-Space [-SpaceKey] <String[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Delete an existing Confluence space, including child content.
> Note: The space is deleted in a long running task, so the space cannot be considered deleted when this resource
returns.
PARAMETERS
-ApiUri <Uri>
The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Certificate <X509Certificate>
Certificate for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SpaceKey <String[]>
The key (short code) of the space to delete. Accepts multiple keys via pipeline input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the deletion of the space without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Boolean
NOTES
-------------------------- EXAMPLE 1 --------------------------
Remove-ConfluenceSpace -SpaceKey ABC -WhatIf
Simulates the deletion of wiki space ABC and all child content. -WhatIf parameter prevents removal of content.
-------------------------- EXAMPLE 2 --------------------------
Remove-ConfluenceSpace -SpaceKey XYZ -Force
Delete wiki space XYZ and all child content below it.
By default, you will be prompted to confirm removal. ("Are you sure? Y/N") -Force suppresses all confirmation
prompts and carries out the deletion.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... ove-Space/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Remove an existing Confluence space.
SYNTAX
Remove-Space [-SpaceKey] <String[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Delete an existing Confluence space, including child content.
> Note: The space is deleted in a long running task, so the space cannot be considered deleted when this resource
returns.
PARAMETERS
-ApiUri <Uri>
The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Certificate <X509Certificate>
Certificate for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SpaceKey <String[]>
The key (short code) of the space to delete. Accepts multiple keys via pipeline input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the deletion of the space without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Boolean
NOTES
-------------------------- EXAMPLE 1 --------------------------
Remove-ConfluenceSpace -SpaceKey ABC -WhatIf
Simulates the deletion of wiki space ABC and all child content. -WhatIf parameter prevents removal of content.
-------------------------- EXAMPLE 2 --------------------------
Remove-ConfluenceSpace -SpaceKey XYZ -Force
Delete wiki space XYZ and all child content below it.
By default, you will be prompted to confirm removal. ("Are you sure? Y/N") -Force suppresses all confirmation
prompts and carries out the deletion.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... ove-Space/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS