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

Download Open API Spec

ExternalUploadDestination

org.sagebionetworks.repo.model.file.ExternalUploadDestination

This upload destination contains information to start an upload to an SFTP or HTTPS destination. The destination is mapped from an ExternalStorageLocationSetting.

Field Type Description
concreteType STRING Indicates which implementation this object represents.
storageLocationId INTEGER the unique id for the storage location, that points to the StorageLocationSetting
uploadType UploadType The enumeration of possible upload types.
banner STRING If set, the client should show this banner every time an upload is initiated
destinationProjectId STRING The ID of the project where this file will be uploaded.
projectStorageLocationUsage ProjectStorageLocationUsage Represent the current size and limits for a single project storage location.
url STRING the generated file URL for uploading to the external destination