---
title: "Add a page to a dashboard."
method: POST
path: "/v1/dashboards/{id}/pages"
tags: ["dashboards"]
---

# Add a page to a dashboard.

`POST /v1/dashboards/{id}/pages`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/v1/dashboards/{id}/pages`
- Auth: one of:
  - API key in cookie `dvt_session`
  - HTTP bearer

Appends an empty page (position = end, empty "lg" layout) to a decomposed,
multi-page dashboard. Granular structural writes are refused on legacy
(pre-decomposition) dashboards (409 legacy-dashboard) and on single-page
dashboards (409 single-page-dashboard) — convert via a whole-spec update.
Editor or above.

## Query parameters

- `reason` string

## Request body

- object
  - `title` string, required
  - `slug` string: Optional; generated from the title when omitted.
  - `kind` 'page' | 'modal' | 'popup' | 'drilldown'
  - `isHidden` boolean

## Response `201`

Page created (version 1).

- PageEnvelope
  - `data` Page, required: A single dashboard page header — identity and metadata plus the optimistic-concurrency version. Arrangement (layout) and membership live in the page's stored fields; this view is what page revision/restore operations return.
    - `pageId` string, uuid, required: Durable UUID primary key.
    - `slug` string, required: Readable, dashboard-scoped reference (the authored page id), e.g. "overview".
    - `dashboardId` string, uuid, required
    - `title` string
    - `kind` 'page' | 'modal' | 'popup' | 'drilldown', required
    - `isHidden` boolean, required
    - `position` integer, required: Ordering among sibling pages.
    - `version` integer, required
  - `meta` Meta, required: Response metadata.
    - `requestId` string, required: Correlates with the X-Request-Id header.
    - `total` integer: Item count, present on collection responses.
    - `nextCursor` string, nullable: Opaque keyset-pagination cursor, present on paginated responses (e.g. GET /v1/dashboards) when more rows exist beyond this page. Pass it back as the `cursor` query param to fetch the next page; absent or null on the last page.
    - `roleResolveDegraded` boolean: Snowflake mode only (DVT-2260), on GET /v1/dashboards: present and true when the caller's live Snowflake role resolution failed or was unavailable — role-shared dashboards may be missing from this page. Omitted (not merely false) whenever resolution succeeded or the role-share arm does not apply (off snowflake mode, an org admin/owner, or off the ingress listener).

## Other responses

- `400`: Malformed request.
- `401`: Missing, invalid, or expired session.
- `403`: The caller's role does not permit this action.
- `404`: Resource does not exist.
- `409`: Slug already in use (slug-taken), legacy dashboard, or single-page dashboard.

---

[API](https://skmtc.dev/dvt/apis/dvt-rest-api.md) · [All operations](https://skmtc.dev/dvt/apis/dvt-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dvt/apis/dvt-rest-api/revisions/00016f504165?raw)
