pages

pages channel

Get channel details by channel ID

Usage

pega pages channel <channelID> [flags]

Source endpoint: GET /channels/{channelID} — view command source

Arguments

Argument	Required	Description
channelID	Yes	Channel ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega pages channel MyChannel

pages dashboard

Get page details for displaying a Dashboard

Usage

pega pages dashboard <dashboardID> [flags]

Source endpoint: GET /dashboard/{dashboardID} — view command source

Arguments

Argument	Required	Description
dashboardID	Yes	Dashboard ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega pages dashboard MyDashboard

pages get

Get page details by page ID

Usage

pega pages get <pageID> [flags]

Source endpoint: GET /pages/{pageID} — view command source

Arguments

Argument	Required	Description
pageID	Yes	Page ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--page-class	option	No		Class in which the page lives (→ ?pageClass=)

Examples

pega pages get MyPage

pega pages get MyPage --page-class CW-Work

pages get-with-context

Get page details with a data context (POST /pages/{pageID})

Usage

pega pages get-with-context <pageID> [flags]

Source endpoint: POST /pages/{pageID} — view command source

Arguments

Argument	Required	Description
pageID	Yes	Page ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--data-context	option	Yes		Data context string → request body

Examples

pega pages get-with-context MyPage --data-context "ContextValue"

pages insight

Get page details for displaying an Insight

Usage

pega pages insight <insightID> [flags]

Source endpoint: GET /insight/{insightID} — view command source

Arguments

Argument	Required	Description
insightID	Yes	Insight ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega pages insight MyInsight

pages localization

Get locale bundle by locale name

Usage

pega pages localization <locale> [flags]

Source endpoint: GET /localizations/{locale} — view command source

Arguments

Argument	Required	Description
locale	Yes	Locale bundle name (e.g. en_US)

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega pages localization en_US

pages portal

Get portal details by portal ID

Usage

pega pages portal <portalID> [flags]

Source endpoint: GET /portals/{portalID} — view command source

Arguments

Argument	Required	Description
portalID	Yes	Portal ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega pages portal MyPortal