< Back
Get-ConfluenceSpace
Post
NAME Get-ConfluenceSpace
SYNOPSIS
Retrieve a listing of spaces in your Confluence instance.
SYNTAX
Get-Space [[-SpaceKey] <String[]>] -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return all Confluence spaces, optionally filtering by Key.
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[]>
Filter results by key.
Supports wildcard matching on partial input.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <Int32>
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.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
> 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many objects will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
> NOTE: Not yet implemented.
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
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
ConfluencePS.Space
NOTES
Piped output into other cmdlets is generally tested and supported.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceSpace
Display the info of all spaces on the server.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluenceSpace -SpaceKey HOTH | Format-List *
Return only the space with key "HOTH" (case-insensitive).
`Format-List *` displays all of the object's properties.
-------------------------- EXAMPLE 3 --------------------------
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.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... Get-Space/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Retrieve a listing of spaces in your Confluence instance.
SYNTAX
Get-Space [[-SpaceKey] <String[]>] -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return all Confluence spaces, optionally filtering by Key.
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[]>
Filter results by key.
Supports wildcard matching on partial input.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <Int32>
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.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
> 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many objects will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
> NOTE: Not yet implemented.
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
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
ConfluencePS.Space
NOTES
Piped output into other cmdlets is generally tested and supported.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceSpace
Display the info of all spaces on the server.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluenceSpace -SpaceKey HOTH | Format-List *
Return only the space with key "HOTH" (case-insensitive).
`Format-List *` displays all of the object's properties.
-------------------------- EXAMPLE 3 --------------------------
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.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... Get-Space/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS