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

Download Open API Spec

BucketOwnerStorageLocationSetting <INTERFACE>


A storage location that defines an external bucket that needs to be verified for ownership. For this type of storage location, upon creation there is a process of verification that will check that a owner.txt file is uploaded to the bucket (and if present within the baseKey folder) and that contains a line separated list of user identifiers. Valid user identifiers for verifications are: user id or id of a team the user is part of.

Known Implementations:
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