< Back
Get-ConfluencePage
Post
NAME Get-ConfluencePage
SYNOPSIS
Retrieve a listing of pages in your Confluence instance.
SYNTAX
Get-Page [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-Title <String>] -SpaceKey
<String> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-Title <String>] -SpaceKey
<String> -Space <Space> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] -SpaceKey <String> -Space
<Space> -Label <String[]> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
Get-Page [-Query] <String> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-PageSize
<Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return Confluence pages, filtered by ID, Name, or Space.
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 to use for the authentication with the REST Api.
If no sessions is available, the request will be executed anonymously.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageID <Int32[]>
Filter results by page ID.
Best option if you already know the ID.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Title <String>
Filter results by page name (case-insensitive).
This supports wildcards (*) to allow for partial matching.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SpaceKey <String>
Filter results by space key (case-insensitive).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Space <Space>
Filter results by space object(s), typically from the pipeline.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Label <String[]>
Filter results to only pages with the specified label(s).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Query <String>
Use Confluences advanced search: CQL
(https://developer.atlassian.com/cloud/c ... using-cql/).
This cmdlet will always append a filter to only look for pages (`type=page`).
Required? true
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 things 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.Page
NOTES
Piped output into other cmdlets is generally tested and supported.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluencePage -SpaceKey HOTH
Get-ConfluenceSpace -SpaceKey HOTH | Get-ConfluencePage
Two different methods to return all wiki pages in space "HOTH". Both examples should return identical results.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -PageID 123456 | Format-List *
Returns the wiki page with ID 123456. `Format-List *` displays all of the object's properties, including the full
page body.
-------------------------- EXAMPLE 3 --------------------------
Get-ConfluencePage -Title 'luke*' -SpaceKey HOTH
Return all pages in HOTH whose names start with "luke" (case-insensitive). Wildcards (*) can be inserted to
support partial matching.
-------------------------- EXAMPLE 4 --------------------------
Get-ConfluencePage -Label 'skywalker'
Return all pages containing the label "skywalker" (case-insensitive). Label text must match exactly; no wildcards
are applied.
-------------------------- EXAMPLE 5 --------------------------
Get-ConfluencePage -Query "mention = jSmith and creator != jSmith"
Return all pages matching the query.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... /Get-Page/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Retrieve a listing of pages in your Confluence instance.
SYNTAX
Get-Page [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-Title <String>] -SpaceKey
<String> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-Title <String>] -SpaceKey
<String> -Space <Space> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
Get-Page -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] -SpaceKey <String> -Space
<Space> -Label <String[]> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
Get-Page [-Query] <String> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] [-PageSize
<Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return Confluence pages, filtered by ID, Name, or Space.
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 to use for the authentication with the REST Api.
If no sessions is available, the request will be executed anonymously.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageID <Int32[]>
Filter results by page ID.
Best option if you already know the ID.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Title <String>
Filter results by page name (case-insensitive).
This supports wildcards (*) to allow for partial matching.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SpaceKey <String>
Filter results by space key (case-insensitive).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Space <Space>
Filter results by space object(s), typically from the pipeline.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Label <String[]>
Filter results to only pages with the specified label(s).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Query <String>
Use Confluences advanced search: CQL
(https://developer.atlassian.com/cloud/c ... using-cql/).
This cmdlet will always append a filter to only look for pages (`type=page`).
Required? true
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 things 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.Page
NOTES
Piped output into other cmdlets is generally tested and supported.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluencePage -SpaceKey HOTH
Get-ConfluenceSpace -SpaceKey HOTH | Get-ConfluencePage
Two different methods to return all wiki pages in space "HOTH". Both examples should return identical results.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -PageID 123456 | Format-List *
Returns the wiki page with ID 123456. `Format-List *` displays all of the object's properties, including the full
page body.
-------------------------- EXAMPLE 3 --------------------------
Get-ConfluencePage -Title 'luke*' -SpaceKey HOTH
Return all pages in HOTH whose names start with "luke" (case-insensitive). Wildcards (*) can be inserted to
support partial matching.
-------------------------- EXAMPLE 4 --------------------------
Get-ConfluencePage -Label 'skywalker'
Return all pages containing the label "skywalker" (case-insensitive). Label text must match exactly; no wildcards
are applied.
-------------------------- EXAMPLE 5 --------------------------
Get-ConfluencePage -Query "mention = jSmith and creator != jSmith"
Return all pages matching the query.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... /Get-Page/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS