---
title: "Rename a cluster"
method: POST
path: "/v1/clusters/{id}/rename"
tags: ["clusters"]
---

# Rename a cluster

`POST /v1/clusters/{id}/rename`

## Request

- Base URL: `https://api.publicwww.com`
- URL: `https://api.publicwww.com/v1/clusters/{id}/rename`
- Auth: HTTP bearer

## Path parameters

- `id` integer, required

## Request body

- RenameRequest
  - `name` string, required

## Response `200`

The cluster.

- Cluster
  - `id` integer, required
  - `name` string, required
  - `size` integer, required: Number of domains.
  - `created` string, date-time, required
  - `submitted` integer: From a list: how many names were sent.
  - `max_size` integer: The plan's cap on domains per cluster.
  - `query` string
  - `total` integer: From a search: results the search found.
  - `index_complete` boolean
  - `query_note` string
  - `operation` 'and' | 'or' | 'diff'
  - `from` integer[]

## Other responses

- `400`: The request cannot be served as asked: missing_query, unknown_format, unknown_column, format_not_available, per_page_too_large, page_too_deep, invalid_json.
- `401`: missing_key - no Authorization: Bearer header; invalid_key - the token does not name an account.
- `403`: No paid plan (plan_required).
- `404`: No such cluster on this account (cluster_not_found).
- `405`: This changes the cluster - use POST (method_not_allowed).
- `429`: Too many requests, or the daily search or extraction allowance is used up.

---

[API](https://skmtc.dev/publicwww/apis/publicwww-search-api.md) · [All operations](https://skmtc.dev/publicwww/apis/publicwww-search-api/llms.txt) · [OpenAPI document](https://skmtc.dev/publicwww/apis/publicwww-search-api/revisions/79d49d819de3?raw)