AtlassianPS
A PowerShell community for Atlassian products
A PowerShell community for Atlassian products
Retrieve a listing of spaces in your Confluence instance.
Get-ConfluenceSpace -ApiUri <Uri> -Credential <PSCredential> [[-SpaceKey] <String[]>] [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
Return all Confluence spaces, optionally filtering by Key.
Get-ConfluenceSpace
Display the info of all spaces on the server.
Get-ConfluenceSpace -SpaceKey HOTH | Format-List *
Return only the space with key “HOTH” (case-insensitive).
Format-List * displays all of the object’s properties.
Get-ConfluenceSpace -ApiUri "https://myserver.com/wiki" -Credential $cred
Manually specifying a server and authentication credentials, list all
spaces found on the instance. Set-ConfluenceInfo usually makes this
unnecessary, unless you are actively maintaining multiple instances.
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
Confluence’s credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Certificate for authentication.
Type: X509Certificate
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Filter results by key.
Supports wildcard matching on partial input.
Type: String[]
Parameter Sets: (All)
Aliases: Key
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Maximum number of results to fetch per call.
This setting can be tuned to get better performance according to the load on the server.
Warning: too high of a PageSize can cause a timeout on the request.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 25
Accept pipeline input: False
Accept wildcard characters: False
NOTE: Not yet implemented.
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Controls how many objects will be skipped before starting output.
Defaults to 0.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
NOTE: Not yet implemented.
Indicates how many items to return.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 18446744073709551615
Accept pipeline input: False
Accept wildcard characters: False
Piped output into other cmdlets is generally tested and supported.