Uploads

Completes a direct external upload

POST

https://discourse.example.com/uploads/complete-external-upload.json

Completes an external upload initialized with /get-presigned-put. The file will be moved from its temporary location in external storage to a final destination in the S3 bucket. An Upload record will also be created in the database in most cases.

If a sha1-checksum was provided in the initial request it will also be compared with the uploaded file in storage to make sure the same file was uploaded. The file size will be compared for the same reason.

You must have the correct permissions and CORS settings configured in your external provider. We support AWS S3 as the default. See:

https://meta.discourse.org/t/-/210469#s3-multipart-direct-uploads-4.

An external file store must be set up and enable_direct_s3_uploads must be set to true for this endpoint to function.

Completes a direct external upload

curl -X POST 'https://discourse.example.com/uploads/complete-external-upload.json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "unique_identifier": "66e86218-80d9-4bda-b4d5-2b6def968705",
  "for_private_message": "true",
  "for_site_setting": "true",
  "pasted": "true"
}'

const body = `{
  "unique_identifier": "66e86218-80d9-4bda-b4d5-2b6def968705",
  "for_private_message": "true",
  "for_site_setting": "true",
  "pasted": "true"
}`;

const response = await fetch('https://discourse.example.com/uploads/complete-external-upload.json', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "unique_identifier": "66e86218-80d9-4bda-b4d5-2b6def968705",
  "for_private_message": "true",
  "for_site_setting": "true",
  "pasted": "true"
}'''

response = requests.post(
    'https://discourse.example.com/uploads/complete-external-upload.json',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "unique_identifier": "66e86218-80d9-4bda-b4d5-2b6def968705",
  "for_private_message": "true",
  "for_site_setting": "true",
  "pasted": "true"
}

200

{
  "id": 0,
  "url": "string",
  "original_filename": "string",
  "filesize": 0,
  "width": 0,
  "height": 0,
  "thumbnail_width": 0,
  "thumbnail_height": 0,
  "extension": "string",
  "short_url": "string",
  "short_path": "string",
  "retain_hours": "string",
  "human_filesize": "string",
  "dominant_color": "string",
  "thumbnail": {
    "id": 0,
    "upload_id": 0,
    "url": "string",
    "extension": "string",
    "width": 0,
    "height": 0,
    "filesize": 0
  },
  "optimized_video": {
    "id": 0,
    "upload_id": 0,
    "url": "string",
    "extension": "string",
    "filesize": 0,
    "sha1": "string",
    "original_filename": "string"
  }
}

Body

application/json

unique_identifierstringrequired

The unique identifier returned in the original /generate-presigned-put request.

Example

66e86218-80d9-4bda-b4d5-2b6def968705

for_private_messagestring

Optionally set this to true if the upload is for a private message.

Example

true

for_site_settingstring

Optionally set this to true if the upload is for a site setting.

Example

true

pastedstring

Optionally set this to true if the upload was pasted into the upload area. This will convert PNG files to JPEG.

Example

true

Response

200OKany

external upload initialized

Response fields application/json

idintegerrequired

urlstringrequired

original_filenamestringrequired

filesizeintegerrequired

widthintegerrequired

heightintegerrequired

thumbnail_widthintegerrequired

thumbnail_heightintegerrequired

extensionstringrequired

short_urlstringrequired

short_pathstringrequired

retain_hoursstring | nullrequired

human_filesizestringrequired

dominant_colorstring | null

thumbnailobject | null

Show child attributes

idinteger

upload_idinteger

urlstring

extensionstring

widthinteger

heightinteger

filesizeinteger

optimized_videoobject | null

Show child attributes

idinteger

upload_idinteger

urlstring

extensionstring

filesizeinteger

sha1string

original_filenamestring

Docs by Sourcey