--- id: usage slug: /usage title: Usage toc_max_heading_level: 3 --- import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' API documentation for Supabase Storage ## Object {#object} Object end-points ### Delete an object {#delete-an-object} ``` DELETE /object/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response Default Response
### Deprecated (use GET /object/authenticated/{bucketName} instead): Retrieve an object {#deprecated-use-get-objectauthenticatedbucketname-instead-retrieve-an-object} ``` GET /object/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response
### Update the object at an existing key {#update-the-object-at-an-existing-key} ``` PUT /object/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response Default Response
### Upload a new object {#upload-a-new-object} ``` POST /object/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response Default Response
### Delete multiple objects {#delete-multiple-objects} ``` DELETE /object/{bucketName} ``` #### Parameters #### Responses Default Response Default Response
### Retrieve an object {#retrieve-an-object} ``` GET /object/authenticated/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response
### Generate a presigned url to retrieve an object {#generate-a-presigned-url-to-retrieve-an-object} ``` POST /object/sign/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response Default Response
### Retrieve an object via a presigned URL {#retrieve-an-object-via-a-presigned-url} ``` GET /object/sign/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response
### Generate presigned urls to retrieve objects {#generate-presigned-urls-to-retrieve-objects} ``` POST /object/sign/{bucketName} ``` #### Parameters #### Responses Default Response Default Response
### Moves an object {#moves-an-object} ``` POST /object/move ``` #### Parameters #### Responses Default Response Default Response
### Search for objects under a prefix {#search-for-objects-under-a-prefix} ``` POST /object/list/{bucketName} ``` #### Parameters #### Responses Default Response Default Response
### Copies an object {#copies-an-object} ``` POST /object/copy ``` #### Parameters #### Responses Default Response Default Response
### Retrieve an object from a public bucket {#retrieve-an-object-from-a-public-bucket} ``` GET /object/public/{bucketName}/{wildcard} ``` #### Parameters #### Responses Default Response
## Bucket {#bucket} Bucket end-points ### Create a bucket {#create-a-bucket} ``` POST /bucket/ ``` #### Parameters #### Responses Default Response Default Response
### Gets all buckets {#gets-all-buckets} ``` GET /bucket/ ``` #### Parameters #### Responses Default Response Default Response
### Empty a bucket {#empty-a-bucket} ``` POST /bucket/{bucketId}/empty ``` #### Parameters #### Responses Default Response Default Response
### Get details of a bucket {#get-details-of-a-bucket} ``` GET /bucket/{bucketId} ``` #### Parameters #### Responses Default Response Default Response
### Update properties of a bucket {#update-properties-of-a-bucket} ``` PUT /bucket/{bucketId} ``` #### Parameters #### Responses Default Response Default Response
### Delete a bucket {#delete-a-bucket} ``` DELETE /bucket/{bucketId} ``` #### Parameters #### Responses Default Response Default Response