hosting_generateUploadURLV1
Generate an authenticated upload URL for direct resumable file uploads to a website's public_html directory using TUS protocol.
Instructions
Generate a file browser upload URL with authentication credentials for uploading files directly to a website's file storage.
Returns url, auth_key and rest_auth_key. Use these to upload a file to the
website's public_html directory via the TUS resumable upload protocol (TUS 1.0.0).
Send X-Auth: {auth_key} and X-Auth-Rest: {rest_auth_key} headers on every request
below.
Create the upload:
POSTto{url}/{relative_file_path}?override=truewith headersupload-length: {file size in bytes}andupload-offset: 0. Expect201 Created.Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or
PATCHrequests with anupload-offsetheader tracking progress) until complete.
relative_file_path is the destination path inside public_html, e.g. app.zip.
Instead of a TUS client, plain curl also works:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when doneInput Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | Website domain | |
| username | Yes | Account username |