---
title: "Rename objects"
method: POST
path: "/bus/objects/rename"
tags: ["bus"]
---

# Rename objects

`POST /bus/objects/rename`

Renames a single object or multiple objects with a prefix.

## Request body

- object
  - `bucket` string — The name of the bucket.
  - `from` string — Source path/prefix
  - `to` string — Destination path/prefix
  - `mode` 'single' | 'multi' — Whether to rename a single object or multiple objects
  - `force` boolean — Whether to overwrite existing objects

## Response `200`

Successfully renamed objects

## Other responses

- `400` — Malformed request
- `500` — Internal server error

## Changes

- **2024-12-18** `922f156353c9` — 1 breaking, 1 info
  - removed the media type `text/plain` for the response with the status `500`
  - api tag `bus` added
- **2024-12-17** `d5dec74bd45a` — 1 info
  - endpoint added
- **2024-12-09** `f062c35d8f47` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/siafoundation/apis/renterd-api/changes/bus/objects/rename/post.md)

---

[API](https://skmtc.dev/siafoundation/apis/renterd-api.md) · [All operations](https://skmtc.dev/siafoundation/apis/renterd-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/siafoundation/renterd-api/revisions/184a3d5207da/schema)