Skip to navigation
Buckets

fileUpload

Return a storage-signed PUT link for a public or protected bucket, valid for at most 900 seconds. Complete PUT before it expires. A private upload reservation also requires ingest submission before that deadline; an unreserved public source remains ingestible after PUT expiry. Available even when file-access protection is disabled. Uses this deployment and its configured storage. Include the requested per-file fileAccess policy so it is checked before upload; non-null policies return 403 when protection is disabled. Returns 503 with Retry-After for temporary verification failures.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

bucketIdintegerRequired

Request

This endpoint expects an object.
fileNamestringRequired1-255 characters
fileTypeenumRequired

The type of document (one of the currently supported file types)

fileAccessobject or nullOptional

Requested initial file policy, also sent during ingest. Omit or send null to inherit. Validated before an upload URL is issued. Non-null policies return 403 when file protection is disabled, so a protected upload cannot be staged publicly.

Response

Private, no-store response

uploadIdstringformat: "uuid"
uploadUrlstringformat: "uri"
hostedUrlstringformat: "uri"
expiresAtstringformat: "date-time"
methodenum
Allowed values:
headersmap from strings to strings
effectiveFileAccessobjectOptional

Policy used when issuing this upload. Only protected uploads have a private ingest deadline. Missing policy metadata should retain existing protected-upload checks.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error