Skip to main content
Available since CLI v7.3.0.
The checkly status-pages command lets you list and inspect status pages in your Checkly account directly from the terminal. You can view status page configurations, cards, and services.
Before using checkly status-pages, ensure you have:
  • Checkly CLI installed
  • Valid Checkly account authentication (run npx checkly login if needed)
For additional setup information, see CLI overview.

​
Usage

Terminal
npx checkly status-pages <subcommand> [arguments] [options]

​
Subcommands

SubcommandDescription
listList all status pages in your account.
getGet details of a status page, including its cards and services.

​
checkly status-pages list

List all status pages in your account. Usage:
Terminal
npx checkly status-pages list [options]
Options:
OptionDescription
--limit, -lNumber of status pages to return (1-100). Default: 25.
--cursorCursor for next page (from previous output).
--compactShow one row per status page instead of per service.
--output, -oOutput format: table, json, or md. Default: table.

​
List Options

​
--limit, -l
number
default:"25"
Number of status pages to return per page, between 1 and 100.Usage:
Terminal
npx checkly status-pages list --limit=50
npx checkly status-pages list -l 10
​
--cursor
string
Cursor for paginating through results. The cursor value is provided in the output of a previous status-pages list command.Usage:
Terminal
npx checkly status-pages list --cursor=<cursor>
​
--compact
boolean
Show one row per status page instead of expanding services. Displays the number of cards and whether the status page is private.Usage:
Terminal
npx checkly status-pages list --compact
​
--output, -o
string
default:"table"
Set the output format. Use json for programmatic access or md for markdown.Usage:
Terminal
npx checkly status-pages list --output=json
npx checkly status-pages list -o md

​
List Examples

Terminal
# List all status pages with services expanded
npx checkly status-pages list

# Compact view with one row per status page
npx checkly status-pages list --compact

# Get results as JSON
npx checkly status-pages list --output=json

# Page through results
npx checkly status-pages list --limit=10 --cursor=<cursor>

​
checkly status-pages get

Get details of a specific status page, including its cards and services. Usage:
Terminal
npx checkly status-pages get <id> [options]
Arguments:
ArgumentDescription
IDThe ID of the status page to retrieve.
Options:
OptionDescription
--output, -oOutput format: detail, json, or md. Default: detail.

​
Get Options

​
--output, -o
string
default:"detail"
Set the output format. Use json for programmatic access or md for markdown.Usage:
Terminal
npx checkly status-pages get <id> --output=json
npx checkly status-pages get <id> -o md

​
Get Examples

Terminal
# View status page details with cards and services
npx checkly status-pages get 12345

# Get status page details as JSON
npx checkly status-pages get 12345 --output=json