mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 10:25:06 +03:00
1320 lines
31 KiB
Plaintext
1320 lines
31 KiB
Plaintext
---
|
|
id: usage
|
|
slug: /usage
|
|
title: Usage
|
|
toc_max_heading_level: 3
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs'
|
|
import TabItem from '@theme/TabItem'
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
API documentation for Supabase Storage
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Create a bucket {#create-a-bucket}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Gets all buckets {#gets-all-buckets}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Empty a bucket {#empty-a-bucket}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketId</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Get details of a bucket {#get-details-of-a-bucket}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketId</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Update properties of a bucket {#update-properties-of-a-bucket}
|
|
|
|
```
|
|
PUT
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Delete a bucket {#delete-a-bucket}
|
|
|
|
```
|
|
DELETE
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketId</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Delete an object {#delete-an-object}
|
|
|
|
```
|
|
DELETE
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Deprecated (use GET /object/authenticated/{bucketName} instead): Retrieve an object {#deprecated-use-get-objectauthenticatedbucketname-instead-retrieve-an-object}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Update the object at an existing key {#update-the-object-at-an-existing-key}
|
|
|
|
```
|
|
PUT
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Upload a new object {#upload-a-new-object}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Delete multiple objects {#delete-multiple-objects}
|
|
|
|
```
|
|
DELETE
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Retrieve an object {#retrieve-an-object}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Generate a presigned url to retrieve an object {#generate-a-presigned-url-to-retrieve-an-object}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Retrieve an object via a presigned URL {#retrieve-an-object-via-a-presigned-url}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">token</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Generate presigned urls to retrieve objects {#generate-presigned-urls-to-retrieve-objects}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Moves an object {#moves-an-object}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Search for objects under a prefix {#search-for-objects-under-a-prefix}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Copies an object {#copies-an-object}
|
|
|
|
```
|
|
POST
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">body</span>
|
|
<span className="method-list-item-label-badge">optional</span>
|
|
<span className="method-list-item-validation"></span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">authorization</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="200">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
## Retrieve an object from a public bucket {#retrieve-an-object-from-a-public-bucket}
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">bucketName</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">*</span>
|
|
<span className="method-list-item-label-badge">required</span>
|
|
<span className="method-list-item-validation">string</span>
|
|
</h4>
|
|
<div class="method-list-item-description"></div>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
### Responses
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="400">
|
|
|
|
Default Response
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
<br />
|