Sign in

v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-065499150.5 KB
uploads

Rename an upload

Updates the file's display name. Metadata only: storage is keyed by id, so the object never moves and existing URLs keep working, and past deliveries keep the name they were sent under. Downloads cannot be renamed — a captured file's name is part of its provenance.

patch/uploads/{upload_id}

Path parameters

upload_idstring uuid required

upload identifier to rename

upload identifier to rename

Request body

$schemastring uri

A URL to the JSON Schema for this object.

filenamestring required

New display name for the file.

Example request

{
  "$schema": "/api/v1/FileRenameRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "/api/v1/RenameFileOutputBody.json"
}