StorageConnectionService

GetDownloadCredentials

Get temporary, read-only S3 credentials scoped to a storage connection. Use these for bulk or repeated downloads via the AWS CLI or SDK instead of per-object presigned URLs.

get/v1/storage-connections/{storage_connection_id}/credentials

Request

  • Base URL: https://cloud-api.usw2.elembio.io
  • URL: https://cloud-api.usw2.elembio.io/v1/storage-connections/{storage_connection_id}/credentials
  • Auth: API key in header x-api-key

Path parameters

storage_connection_idstring required

The storage connection ID

Query parameters

prefixstring

Prefix to scope credentials to a subdirectory, relative to the storage connection's configured root. Matches the --prefix semantics of ListFiles: optional for an unrestricted key (omitted ⇒ connection root), but required and bounded to scope for a key scoped to a path prefix — omitting it or naming one outside the scope returns PermissionDenied with the allowed prefix(es) (allowed_prefixes metadata).

expirationSecondsinteger

Lifetime of the returned credentials, in seconds. Optional; defaults to 1 hour (when 0 or unset). Minimum 900s. Capped by AWS: up to 36h (129600s) for federation-token connections, or the role's MaxSessionDuration (12h typical) for role-backed connections. Values below the minimum or above the cap are rejected.

Response

Success

Example response

{
  "s3": {
    "expiration": "2023-01-15T01:30:15.01Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.