1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-27 22:18:36 +02:00
Files
OpenIntegrations/docs/en/md/S3/Objects-management/Delete-object.mdx
Vitaly the Alpaca (bot) 347c900389 Main build (Jenkins)
2025-09-16 09:07:33 +03:00

96 lines
3.1 KiB
Plaintext
Vendored

---
sidebar_position: 9
description: Delete object and other functions to work with S3 in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, S3]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Delete object
Removes the object from the bucket
`Function DeleteObject(Val Name, Val Bucket, Val BasicData, Val Version = Undefined, Val Headers = Undefined, Val Directory = False) 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 |
| BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
| Version | --ver | String | ✖ | Token for deleting a specific version of an object |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
| Directory | --dir | Boolean | ✖ | True > Path style URL, False > Virtual hosted style URL |
Returns: Structure Of KeyAndValue - serialized JSON response from storage
<br/>
:::tip
Method at AWS documentation: [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
:::
<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";
Directory = True; // Formation URL in path-style
Bucket = "opi-dirbucket3";
Result = OPI_S3.DeleteObject(Name, Bucket, BasicData, , , Directory);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint s3 DeleteObject \
--name "picture.jpg" \
--bucket "opi-dirbucket3" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \
--dir true
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint s3 DeleteObject ^
--name "picture.jpg" ^
--bucket "opi-dirbucket3" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" ^
--dir true
```
</TabItem>
</Tabs>
```json title="Result"
{
"status": 204,
"response": {},
"headers": {
"Accept-Ranges": "bytes",
"Date": "Mon, 15 Sep 2025 23:18:39 GMT",
"Server": "MinIO",
"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
"Vary": "Origin, Accept-Encoding",
"X-Amz-Id-2": "e602da57d0c30b8c7034fcfe129917205f80f7bab979408e71da5d1441c85e79",
"X-Amz-Request-Id": "186597F7A964060A",
"X-Content-Type-Options": "nosniff",
"X-XSS-Protection": "1; mode=block",
"Content-Type": "text/plain; charset=utf-8"
}
}
```