Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

Confluence Command Line Interface (CLI)
Results will update as you type.
  • addTopic
  • addTopicWatch
  • addUser
  • addUserPicture
  • addUserToGroup
  • addWatch
  • convertToStorageFormat
  • copyAttachment
  • copyAttachments
  • copyBlog
  • copyComments
  • copyLabels
  • copyPage
  • copyPageChildren
  • copyPageHierarchy
  • copyPermissions
  • copySpace
  • exportData
  • exportPage
  • exportSite
  • exportSpace
  • getApp
  • getApplicationLink
  • getApplicationLinkList
  • getAttachment
  • getAttachmentList
  • getAttachmentVersionList
  • getBlogList
  • getBlogSource
  • getClientInfo
  • getCommentList
  • getCommentSource
  • getComments
  • getContent
  • getContentHistoryList
  • getContentList
  • getGroupList
  • getLabelList
  • getPage
  • getPageHistoryList
  • getPageList
  • getPageSource
  • getPermissionList
  • getQuestion
  • getQuestionList
  • getReplacementVariableList
  • getServerInfo
  • getShortcutList
  • getSource
  • getSpace
  • getSpaceList
  • getSpacePermissionList
  • getTopic
  • getTopicList
  • getTrashList
  • getUser
  • getUserList
  • getWatchList
  • help
  • hideShortcut
  • installApp
  • loadFiles
  • login
  • logout
  • modifyBlog
  • modifyPage
  • movePage
  • moveShortcut
  • publishPage
  • removeAllPermissionsForGroup
  • removeApplicationLink
  • removeAttachment
  • removeAttachmentVersion
  • removeAttachmentVersions
  • removeBlog
  • removeComment
  • removeComments
  • removeContent
  • removeContentVersion
  • removeContentVersions
  • removeGroup
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    getPageList

    getPageList

    Dec 03, 2024

    See also: Actions

    Description

    Get list of pages with regex filtering on page title. Either use cql directly to define the page list or the various other parameters that combine to define the page list including labels, space, id, or title. When the cql parameter is specified, the labels, space, id, and parent parameters are ignored. Options for including ancestors, children, or descendents are available when a specific page is specified. For example, when space and labels are both used, pages are selected from the space that have at last one of the labels. Use regex2 to additionally filter by matching on the content. Content filtering takes significant resources and time. @all can be used as a special value for the space parameter.

    Required Parameters

    cql or labels or space or id

    Optional Parameters

    title, parent, ancestors, descendents, children, limit, regex, regex2, outputFormat, dateFormat, outputType, file, append, columns, select, options, encoding

    Type

    Get

    Category

    Pages

    Output Formats

    1 - simple, 2 - CSV, 3 - space, 998 - all fields excluding content, 999 - all

    Replacement Variables

    Hostingcloud,server,datacenter
    Since Version

    Examples

    getPageList

    Related How To's

    , multiple selections available, Use left or right arrow keys to navigate selected items
    cli-action
    cli-action-getpagelist
    cli-parameter-cql
    cli-parameter-labels
    cli-parameter-space
    cli-parameter-id
    cli-parameter-title
    cli-parameter-parent
    cli-parameter-ancestors
    cli-parameter-descendents
    cli-parameter-children
    cli-parameter-limit
    cli-parameter-regex
    cli-parameter-regex2
    cli-parameter-outputformat
    cli-parameter-dateformat
    cli-parameter-file
    cli-parameter-append
    cli-parameter-columns
    cli-parameter-encoding
    cli-parameter-action
    cli-parameter-dateformat2
    cli-parameter-help
    cli-parameter-outputtype
    cli-parameter-special
    cli-parameter-quiet
    cli-parameter-verbose
    cli-parameter-debug
    cli-action-category-pages
    cli-action-type-get
    cli-parameter-select
    cli-parameter-options
    cli-parameter-server
    cli-parameter-user
    cli-parameter-password
    cli-parameter-token

    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 15, "requestCorrelationId": "302240b0d22d44669696cc7d39bc49aa"}