# checkly status-pages - Checkly Docs

> List and inspect status pages in your Checkly account.

Source: https://www.checklyhq.com/docs/cli/checkly-status-pages/

---

- Usage
- Subcommands
- checkly status-pages list List Options
- List Examples

- checkly status-pages get Get Options
- Get Examples

- Related Commands

CLI Commands

# checkly status-pages

List and inspect status pages in your Checkly account.

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.

Prerequisites

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](https://www.checklyhq.com/docs/cli/overview).

## ​ Usage

Terminal

```
npx checkly status-pages [arguments] [options]
```

## ​ Subcommands

Subcommand Description

`list` List all status pages in your account.

`get` Get 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:**
Option Required Description

`--limit, -l` - Number of status pages to return (1-100). Default: `25`.

`--cursor` - Cursor for next page (from previous output).

`--compact` - Show one row per status page instead of per service.

`--output, -o` - Output format: `table`, `json`, or `md`. Default: `table`.

### ​ List Options

​

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
```

​

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=
```

​

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
```

​

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=
```

## ​ `checkly status-pages get`

Get details of a specific status page, including its cards and services.
**Usage:**
Terminal

```
npx checkly status-pages get [options]
```

**Arguments:**
Argument Description

`id` The ID of the status page to retrieve.

**Options:**
Option Required Description

`--output, -o` - Output format: `detail`, `json`, or `md`. Default: `detail`.

### ​ Get Options

​

string

default: "detail"

Set the output format. Use `json` for programmatic access or `md` for markdown. **Usage:** Terminal

```
npx checkly status-pages get --output=json
npx checkly status-pages get -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
```

## ​ Related Commands

- [`checkly checks`](https://www.checklyhq.com/docs/cli/checkly-checks) - List and inspect checks

- [`checkly whoami`](https://www.checklyhq.com/docs/cli/checkly-whoami) - Display current account information

Was this page helpful?

[Suggest edits](https://github.com/checkly/docs/edit/main/cli/checkly-status-pages.mdx)[Raise issue](https://github.com/checkly/docs/issues/new?title=Issue%20on%20docs&body=Path:%20/cli/checkly-status-pages)

[checkly skills Previous](https://www.checklyhq.com/docs/cli/checkly-skills)[checkly switch Next](https://www.checklyhq.com/docs/cli/checkly-switch)

[x](https://x.com/checklyhq)[github](https://github.com/checkly)[linkedin](https://linkedin.com/company/checkly)

[Powered by This documentation is built and hosted on Mintlify, a developer documentation platform](https://www.mintlify.com/?utm_campaign=poweredBy&utm_medium=referral&utm_source=checkly-422f444a)