Skip to main content
GET
Get S3 Upload Parameters

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

filename
string
required

A file name including file extension.

Example:

"document.xliff"

type
string
required

The content-type or mime-type of the file to upload.

Example:

"video/mp4"

metadata.size
integer

The size of the file to upload in bytes.

Required range: x >= 0
Example:

1024

metadata.category
string

File category metadata.

Example:

"documents"

metadata.uuid
string

File UUID metadata.

Example:

"123e4567-e89b-12d3-a456-426614174000"

metadata.labels
string

Comma-separated list of label names to be added to the file after upload completes.

Example:

"important,review-needed"

Response

Upload initialization information.

url
string

Pre-signed URL for file upload

Example:

"https://storage.googleapis.com/bucket/uploads/user123/file456.json?..."

key
string

Upload key identifier

Example:

"uploads/user123/file456.json"

method
string

HTTP method to use for upload

Example:

"PUT"