Skip to content
Longport WhaleLongport Whale
Misc

Get File Upload URL

Obtains a temporary S3 remote upload URL for uploading a file directly to object storage.

Request parameters

  • This endpoint has no required parameters; see the field descriptions below for optional ones.
  • Use module to indicate the module the file belongs to so it can be stored by business category.

Business notes

The returned upload URL is a temporary, time-limited credential; the upload must complete before it expires.

Returns

On success, returns a temporary URL that can be used to upload the file directly. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/upload_url

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

wms.file_update

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

modulestringRequired

upload biz module

Responses

HTTP 200Success
urlstring

url to upload file. url to upload file

keystring

file key. file key

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs