The Open API specification for Synapse is now available for download!

Download Open API Spec



The external upload destination setting contains information to generate an upload destination for an S3 object storage NOT managed by Synapse. This is different from ExternalS3StorageLocationSetting, which contains information about an external S3 storage that is managed by Synapse

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
endpointUrl STRING endpoint URL of the S3 service (for example: '')