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

Download Open API Spec

GET /entity/{id}/sts

Gets the temporary S3 credentials from STS for the given entity. These credentials are only good for the bucket and base key specified by the returned credentials and expire 1 hour after this API is called.

The specified entity must be a folder with an STS-enabled storage location. If that storage location is external storage, you may request read-only or read-write permissions. If that storage location is Synapse storage, you must request read-only permissions.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}/sts

Resource URL Variables
{id} The ID of the entity to get credentials. This must be a folder with an STS-enabled storage location.
Parameters
permission

optional

Read-only or read-write permissions. See StsPermission.
Resource Information
Authentication Required
Required OAuth Scopes view , modify , download
HTTP Method GET
Request Object None
Response Object StsCredentials
(application/json)