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

Download Open API Spec

POST /externalFileHandle/s3

Create an S3FileHandle to represent an S3Object in a user's S3 bucket.

In order to use this method an ExternalS3StorageLocationSetting must first be created for the user's bucket. The ID of the resulting ExternalS3StorageLocationSetting must be set in the S3FileHandle.storageLocationId. Only the user that created to the ExternalS3StorageLocationSetting will be allowed to create S3FileHandle using that storageLocationId.

Resource URL

https://repo-prod.prod.sagebase.org/file/v1/externalFileHandle/s3

Resource Information
Authentication Required
Required OAuth Scopes view , modify
HTTP Method POST
Request Object S3FileHandle
(application/json)
Response Object S3FileHandle
(application/json)