---
title: "Preview rename"
method: POST
path: "/api/v1/projects/{projectUuid}/rename/preview"
tags: ["Projects"]
---

# Preview rename

`POST /api/v1/projects/{projectUuid}/rename/preview`

Preview which resources would be affected by a bulk rename

## Path parameters

- `projectUuid` string, required

## Request body

- ApiRenameBody
  - `model` string
  - `dryRun` boolean
  - `type` 'model' | 'field', required
  - `from` string, required
  - `to` string, required

## Response `200`

Success

- ApiRenameResponse
  - `results` object, required
    - `dashboardSchedulers` RenameChange[], required
      - `name` string, required
      - `uuid` string, required
    - `alerts` RenameChange[], required
      - `name` string, required
      - `uuid` string, required
    - `dashboards` RenameChange[], required
      - `name` string, required
      - `uuid` string, required
    - `charts` RenameChange[], required
      - `name` string, required
      - `uuid` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)