DocsAPI ReferenceDrive/bff/drive/rename
postDriveAdmin BFF

/bff/drive/rename

Renames a file in the database only (the physical blob storage path is not changed). The file extension cannot be changed — it is validated against the original. The new name is sanitized to ASCII and must be unique within the same folder. The file is not moved to a different directory.

DrivepostBffDriveRename

Parameters

2 body

2 total
Body · 2
tokenstringRequired

Unique file token identifying the file to rename.

filenamestringRequired

New file name. Can be provided with or without extension. The original extension is always preserved — if a different extension is provided, the request is rejected. The name is automatically sanitized: converted to ASCII, lowercased, spaces replaced with hyphens, and invalid characters removed.

Length: 1

Request

POST /bff/drive/rename

post
curl -X POST "https://api.bizkithub.com/bff/drive/rename" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "token": "aB3xKm9pQ2wLn4Yz",
  "filename": "monthly-report"
}'

Response

Result of the rename operation.

{
  "token": "example_token",
  "filename": "example_filename",
  "changed": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key