SMsmokeball
Files

Get upload url for a file

Changed on

Returns a presigned PUT URL for uploading a new version of an existing file. The URL is valid for 1 hour.

get/matters/{matterId}/documents/files/{fileId}/upload

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}/upload
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Unique identifier (GUID) of the matter.

fileIdstring required

Unique identifier (GUID) of the file.

Response

When request is successful. Returns an 'UploadFileInfo' object.

fileIdstring nullable

Unique identifier of the file.

uploadUrlstring nullable

Temporary presigned URL to upload the file content to. Send the raw file bytes with an HTTP PUT request. The URL is valid for 1 hour from the time of the API call (see Expiry).

Important note: When uploading to this URL, set the 'Content-Type' header to an empty value.

Example cURL: curl --location --request PUT 'URL_GOES_HERE' \ --header 'Content-Type: ""' \ --data '@/C:/dir/test.pdf'

expirystring date-time

UTC date/time when the upload link is no longer accessible (1 hour after issue).

Example response

{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "uploadUrl": "https://example-bucket.s3.amazonaws.com/apiuploads/2f1c9a3e-6b1d-4c7e-9a0f-1d2e3f4a5b6c?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=...",
  "expiry": "2022-04-23T14:30:00Z"
}

Changes