v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Cancel a file upload

Cancels a pending upload by transitioning the file to CANCELLED. Only files in PENDING status can be cancelled. Required scope: files:create

Rate limit category: Write

post/v1/files/{id}/cancel

Path parameters

idstring required

Unique identifier of the file to cancel.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Request body

object required

Response

OK

idstring required

Unique identifier for the file.

status'PENDING' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' required

Current upload status of the file.

filenamestring required

Original filename.

mimeTypestring required

MIME type of the file.

sizeBytesinteger required

File size in bytes.

createdAtstring required

When the file upload session was created.

completedAtstring nullable required

When the file upload was completed.

expiresAtstring nullable required

When the upload session expires. Null once completed, cancelled, or expired.