Files
supabase/apps/reference/_storage/usage.mdx
2022-08-03 21:51:50 +02:00

638 lines
4.6 KiB
Plaintext

---
id: usage
title: Usage
toc_max_heading_level: 2
---
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" -->
## Create a bucket {#create-a-bucket}
```
/bucket/
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Gets all buckets {#gets-all-buckets}
```
/bucket/
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Empty a bucket {#empty-a-bucket}
```
/bucket/{bucketId}/empty
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Get details of a bucket {#get-details-of-a-bucket}
```
/bucket/{bucketId}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Update properties of a bucket {#update-properties-of-a-bucket}
```
/bucket/{bucketId}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Delete a bucket {#delete-a-bucket}
```
/bucket/{bucketId}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Delete an object {#delete-an-object}
```
/object/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Deprecated (use GET /object/authenticated/{bucketName} instead): Retrieve an object {#deprecated-use-get-objectauthenticatedbucketname-instead-retrieve-an-object}
```
/object/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Update the object at an existing key {#update-the-object-at-an-existing-key}
```
/object/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Upload a new object {#upload-a-new-object}
```
/object/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Delete multiple objects {#delete-multiple-objects}
```
/object/{bucketName}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Retrieve an object {#retrieve-an-object}
```
/object/authenticated/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Generate a presigned url to retrieve an object {#generate-a-presigned-url-to-retrieve-an-object}
```
/object/sign/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Retrieve an object via a presigned URL {#retrieve-an-object-via-a-presigned-url}
```
/object/sign/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Generate presigned urls to retrieve objects {#generate-presigned-urls-to-retrieve-objects}
```
/object/sign/{bucketName}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Moves an object {#moves-an-object}
```
/object/move
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Search for objects under a prefix {#search-for-objects-under-a-prefix}
```
/object/list/{bucketName}
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Copies an object {#copies-an-object}
```
/object/copy
```
### Responses
<Tabs>
<TabItem value="200">
```
200
```
</TabItem>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />
## Retrieve an object from a public bucket {#retrieve-an-object-from-a-public-bucket}
```
/object/public/{bucketName}/{wildcard}
```
### Responses
<Tabs>
<TabItem value="400">
```
400
```
</TabItem>
</Tabs>
<br />