GET

/{Bucket}/{Key}#torrent

http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}/{Key}#torrent

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Using BitTorrent with Amazon S3</a>. <note> You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key. </note> To use GET, you must have READ access to the object. This action is not supported by Amazon S3 on Outposts. The following action is related to <code>GetObjectTorrent</code>: <ul> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </li> </ul>

Access Token Required: API Key

Path Parameters

Bucketstringrequired

The name of the bucket containing the object for which to get the torrent files.

Keystringrequired

The object key for which to get the information.

Query Params

torrentbooleanrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}/{Key}#torrent' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}