Remove-ConfluenceSpace¶
SYNOPSIS¶
Permanently delete a Confluence space (delete:space and read:content.metadata).
SYNTAX¶
__AllParameterSets¶
Remove-ConfluenceSpace [-Key] <string> [[-Context] <Object>] [-WhatIf] [-Confirm]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION¶
Permanently deletes a space and all of its content - the space is NOT sent to the trash and cannot be restored. The call is asynchronous: Confluence returns HTTP 202 with a long-running task descriptor. Deleting a space is a v1-only operation reached over the API gateway; it needs the granular delete:space scope (Atlassian also requires read:content.metadata on this endpoint) plus Admin permission on the space. Because deletion is irreversible, confirm the key belongs to a space you own before calling it.
EXAMPLES¶
EXAMPLE 1¶
Remove-ConfluenceSpace -Key 'DOCS'
Permanently deletes the 'DOCS' space and returns the long-running task descriptor.
PARAMETERS¶
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Context¶
The context to use: an object, a context name, or $null for the default.
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Key¶
The key of the space to delete.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-WhatIf¶
Runs the command in a mode that only reports what would happen without performing the actions.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.