lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-07-05 05:14:21 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
b0a42fda531cfda48a1ea75c76dd98b7a4d3bf63
supabase/apps/reference/_storage/generated/usage.mdx
Inian 72c97195b6 update generated docs
2022-08-19 16:59:47 +08:00

3453 lines
64 KiB
Plaintext
Raw Blame History

---
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" -->
## Object {#object}
Object end-points
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete an object {#delete-an-object}
```
DELETE /object/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully deleted"
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"example": "projectref/avatars/folder/cat.png"
}
},
"required": [
"Key"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"example": "avatars/folder/cat.png"
}
},
"required": [
"Key"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/{bucketName}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"prefixes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"example": [
"folder/cat.png",
"folder/morecats.png"
]
}
},
"required": [
"prefixes"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bucket_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_accessed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"metadata": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"buckets": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"example": {
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
}
},
"required": [
"name"
],
"additionalProperties": false,
"title": "objectSchema",
"example": {
"name": "folder/cat.png",
"bucket_id": "avatars",
"owner": "317eadce-631a-4429-a0bb-f19a7a517b4a",
"id": "eaa8bdb5-2e00-4767-b5a9-d2502efe2196",
"updated_at": "2021-04-06T16:30:35.394674+00:00",
"created_at": "2021-04-06T16:30:35.394674+00:00",
"last_accessed_at": "2021-04-06T16:30:35.394674+00:00",
"metadata": {
"size": 1234
}
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/authenticated/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/sign/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"expiresIn": {
"type": "integer",
"minimum": 1,
"example": 60000
}
},
"required": [
"expiresIn"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"signedURL": {
"type": "string",
"example": "/object/sign/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4"
}
},
"required": [
"signedURL"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/sign/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</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="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/sign/{bucketName}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"expiresIn": {
"type": "integer",
"minimum": 1,
"example": 60000
},
"paths": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"example": [
"folder/cat.png",
"folder/morecats.png"
]
}
},
"required": [
"expiresIn",
"paths"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"error": [
"string",
"null"
],
"example": "Either the object does not exist or you do not have access to it"
},
"path": {
"type": "string",
"example": "folder/cat.png"
},
"signedURL": {
"type": [
"string",
"null"
],
"example": "/object/sign/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4"
}
},
"required": [
"error",
"path",
"signedURL"
]
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/move
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"bucketId": {
"type": "string",
"example": "avatars"
},
"sourceKey": {
"type": "string",
"example": "folder/cat.png"
},
"destinationKey": {
"type": "string",
"example": "folder/newcat.png"
}
},
"required": [
"bucketId",
"sourceKey",
"destinationKey"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully moved"
}
},
"required": [
"message"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/list/{bucketName}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"example": "folder/subfolder"
},
"limit": {
"type": "integer",
"minimum": 1,
"example": 10
},
"offset": {
"type": "integer",
"minimum": 0,
"example": 0
},
"sortBy": {
"type": "object",
"properties": {
"column": {
"type": "string",
"enum": [
"name",
"updated_at",
"created_at",
"last_accessed_at"
]
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"column"
]
},
"search": {
"type": "string"
}
},
"required": [
"prefix"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bucket_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"last_accessed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"metadata": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"buckets": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"example": {
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
}
},
"required": [
"name"
],
"additionalProperties": false,
"example": {
"name": "folder/cat.png",
"bucket_id": "avatars",
"owner": "317eadce-631a-4429-a0bb-f19a7a517b4a",
"id": "eaa8bdb5-2e00-4767-b5a9-d2502efe2196",
"updated_at": "2021-04-06T16:30:35.394674+00:00",
"created_at": "2021-04-06T16:30:35.394674+00:00",
"last_accessed_at": "2021-04-06T16:30:35.394674+00:00",
"metadata": {
"size": 1234
}
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/copy
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"sourceKey": {
"type": "string",
"example": "folder/source.png"
},
"bucketId": {
"type": "string",
"example": "avatars"
},
"destinationKey": {
"type": "string",
"example": "folder/destination.png"
}
},
"required": [
"sourceKey",
"bucketId",
"destinationKey"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"example": "folder/destination.png"
}
},
"required": [
"Key"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /object/public/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</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="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
</Tabs>
<br />
## Bucket {#bucket}
Bucket end-points
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a bucket {#create-a-bucket}
```
POST /bucket/
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "avatars"
},
"id": {
"type": "string",
"example": "avatars"
},
"public": {
"type": "boolean",
"example": false
}
},
"required": [
"name"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "avatars"
}
},
"required": [
"name"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /bucket/
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"title": "bucketSchema",
"example": {
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
},
"example": [
{
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
]
},
"example": [
{
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
]
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /bucket/{bucketId}/empty
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully emptied"
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /bucket/{bucketId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"example": {
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
},
"example": {
"id": "bucket2",
"name": "bucket2",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /bucket/{bucketId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"type": "object",
"properties": {
"public": {
"type": "boolean",
"example": false
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs>
<TabItem value="200">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully updated"
}
},
"required": [
"message"
]
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- 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 /bucket/{bucketId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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">
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully deleted"
}
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
<TabItem value="4XX">
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
</Tabs>
<br />
## Deprecated {#deprecated}
Deprecated end-points
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Get object {#get-object}
```
GET /object/{bucketName}/{wildcard}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
avatars
</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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
folder/cat.png
</span>
</h4>
<div class="method-list-item-description">
</div>
</li>
</ul>
#### Header 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">
</span>
</h4>
<h4 className="method-list-item-label">
Example:
<span className="method-list-item-label-badge">
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs
</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="4XX">
Default Response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabItem>
</Tabs>
<br />
Reference in New Issue View Git Blame Copy Permalink