---
sidebar_position: 1
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Put object
 Uploads the file to the bucket



`Function PutObject(Val Name, Val Bucket, Val Entity, Val BasicData, Val Headers = Undefined) Export`

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | Name | --name | String | ✔ | Name of the object in the bucket |
  | Bucket | --bucket | String | ✔ | Name of the bucket to put the object |
  | Entity | --data | String, BinaryData | ✔ | File path or binary data of the object |
  | BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
  | Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |

  
  Returns:  Structure of KeyAndValue - serialized JSON response from storage

<br/>

:::tip
Method at AWS documentation (default): [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)<br/>Method at AWS documentation (multipart): [Multipart upload](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html)

You can use the `ChunkSize` field in the basic data to specify the minimum file and chunk size for a chunked upload For example, `ChunkSize=X` means that all files larger than `X` (in bytes) will be downloaded in chunks, where one chunk will be of size `X`. Chunk upload is used for large files. Default `ChunkSize` - 20971520 bytes (20 MB)

Parameters with Binary data type can also accept file paths on disk and URLs
:::
<br/>


```bsl title="1C:Enterprise/OneScript code example"
    URL       = "storage-155.s3hoster.by";
    AccessKey = "BRN5RKJE67...";
    SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
    Region    = "BTC";

    BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);

    Name   = "picture.jpg";
    Bucket = "opi-gpbucket3";
    Entity = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data

    Result = OPI_S3.PutObject(Name, Bucket, Entity, BasicData);

    Name   = "fileChunked.mp3";
    Bucket = "opi-gpbucket3";
    Entity = "https://api.athenaeum.digital/test_data/song.mp3"; // URL, Path or Binary Data

    BasicData.Insert("ChunkSize", 5242880);

    Result = OPI_S3.PutObject(Name, Bucket, Entity, BasicData);
```
 

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            # JSON data can also be passed as a path to a .json file
            
            oint s3 PutObject \
             --name "pictureSmall.jpg" \
             --bucket "opi-gpbucket3" \
             --data "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            :: JSON data can also be passed as a path to a .json file
            
            oint s3 PutObject ^
             --name "pictureSmall.jpg" ^
             --bucket "opi-gpbucket3" ^
             --data "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
</Tabs>


```json title="Result"
{
 "status": 200,
 "response": {},
 "headers": {
  "Accept-Ranges": "bytes",
  "Content-Length": "0",
  "Content-Type": "text/plain; charset=utf-8",
  "Date": "Fri, 22 Nov 2024 10:12:02 GMT",
  "Etag": "\"9e0176f87f6565a22f78e0f9b39a4d78\"",
  "Server": "MinIO",
  "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
  "Vary": "Origin,Accept-Encoding",
  "X-Amz-Id-2": "e602da57d0c30b8c7034fcfe129917205f80f7bab979408e71da5d1441c85e79",
  "X-Amz-Request-Id": "180A42ADF0E73AFC",
  "X-Content-Type-Options": "nosniff",
  "X-Xss-Protection": "1; mode=block"
 }
}
```