The external upload destination setting contains information to generate an external S3 upload destination connected with Synapse. For details on how to create a custom S3 storage location in the web client, see Custom Storage Locations

Field Type Description
concreteType STRING Indicates which implementation this object represents.
storageLocationId INTEGER The unique ID for this storage location
uploadType UploadType The enumeration of possible upload types.
banner STRING The banner text to display to a user every time a file is uploaded. This field is optional.
description STRING A description of the storage location. This description is shown when a user has to choose which upload destination to use.
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time a Project Setting is updated it is used to detect when a client's current representation of a Project Setting is out-of-date.
createdOn STRING The date this storage location setting was created.
createdBy INTEGER The ID of the user that created this storage location setting.
bucket STRING The bucket name
baseKey STRING the optional base key, which acts as a prefix or a base folder
stsEnabled BOOLEAN Enables STS on this Storage Location
endpointUrl STRING the optional s3 endpoint URL for uploading to (default: https://s3.amazonaws.com)