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

Download Open API Spec

POST /externalFileHandle

Create an ExternalFileHandle to represent an external URL. Synapse will attempt to generate a preview for any external URL that can be publicly read. The resulting preview file will be stored in Synapse and represented with a PrevewFileHandle. The creator of the ExternalFileHandle will be listed as the creator of the preview.

Resource URL

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

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