Skip to content

Get Upload URL

Retrieve a url for uploading a file to S3. Note that you MUST rename your file to the requiredFileName in the response for the upload to succeed. The link expires in one hour.

Verb POST
Endpoint {base-url}/files/generate-put-url
Max Page Size N/A

Request Body

{
  "routeFilter": {
    "nameOfFileToUpload": "test.xls"
  }
}

Returns

On Success

Response Body

{
  "url": "a lengthy s3 url",
  "expiry": "2022-10-19T19:52:44.4462602+00:00",
  "requiredFileName": "6d02305c-81a5-4763-a51d-b91b41371487_test.xls"
}

On Error

HTTP Code Error Code Definition
400 BUCKET_NAME_INVALID The provided bucket name is not in the list of accepted buckets.