Handle POST request for TUS Resumable uploads
postapiv0/upload/resumable/
Responses
Default Response
API documentation for Supabase Storage
postapiv0/upload/resumable/
Default Response
optionsapiv0/upload/resumable/
Default Response
postapiv0/upload/resumable/{wildcard}
Default Response
putapiv0/upload/resumable/{wildcard}
Default Response
patchapiv0/upload/resumable/{wildcard}
Default Response
optionsapiv0/upload/resumable/{wildcard}
Default Response
deleteapiv0/object/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully deleted"
]
}
}
}
}
putapiv0/object/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Key": {
"type": "string",
"examples": [
"avatars/folder/cat.png"
]
}
},
"required": [
"Key"
]
}
}
postapiv0/object/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Key": {
"type": "string",
"examples": [
"avatars/folder/cat.png"
]
}
},
"required": [
"Key"
]
}
}
deleteapiv0/object/{bucketName}
Successful response
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bucket_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"version": {
"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"
},
"file_size_limit": {
"type": [
"null",
"integer"
]
},
"allowed_mime_types": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"examples": [
{
"id": "bucket2",
"name": "bucket2",
"public": false,
"file_size_limit": 1000000,
"allowed_mime_types": [
"image/png",
"image/jpeg"
],
"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,
"examples": [
{
"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
}
}
],
"title": "objectSchema"
}
}
}
getapiv0/object/authenticated/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
postapiv0/object/upload/sign/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"url": {
"type": "string",
"examples": [
"/object/sign/upload/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4"
]
}
},
"required": [
"url"
]
}
}
putapiv0/object/upload/sign/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"examples": [
"avatars/folder/cat.png"
]
}
},
"required": [
"Key"
]
}
}
postapiv0/object/sign/{bucketName}/{wildcard}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"signedURL": {
"type": "string",
"examples": [
"/object/sign/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4"
]
}
},
"required": [
"signedURL"
]
}
}
getapiv0/object/sign/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
postapiv0/object/sign/{bucketName}
Successful response
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"error": [
"string",
"null"
],
"examples": [
"Either the object does not exist or you do not have access to it"
]
},
"path": {
"type": "string",
"examples": [
"folder/cat.png"
]
},
"signedURL": {
"type": [
"null",
"string"
],
"examples": [
"/object/sign/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4"
]
}
},
"required": [
"error",
"path",
"signedURL"
]
}
}
}
postapiv0/object/move
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully moved"
]
}
},
"required": [
"message"
]
}
}
postapiv0/object/list/{bucketName}
Successful response
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bucket_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"version": {
"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"
},
"file_size_limit": {
"type": [
"null",
"integer"
]
},
"allowed_mime_types": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"examples": [
{
"id": "bucket2",
"name": "bucket2",
"public": false,
"file_size_limit": 1000000,
"allowed_mime_types": [
"image/png",
"image/jpeg"
],
"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,
"examples": [
{
"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
}
}
]
}
}
}
getapiv0/object/info/authenticated/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
postapiv0/object/copy
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"examples": [
"folder/destination.png"
]
}
},
"required": [
"Key"
]
}
}
getapiv0/object/public/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
getapiv0/object/info/public/{bucketName}/{wildcard}
Default Response
{
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
getapiv0/render/image/authenticated/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
getapiv0/render/image/sign/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
getapiv0/render/image/public/{bucketName}/{wildcard}
Error response
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
postapiv0/bucket/
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"avatars"
]
}
},
"required": [
"name"
]
}
}
getapiv0/bucket/
Successful response
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"file_size_limit": {
"type": [
"null",
"integer"
]
},
"allowed_mime_types": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"examples": [
{
"id": "bucket2",
"name": "bucket2",
"public": false,
"file_size_limit": 1000000,
"allowed_mime_types": [
"image/png",
"image/jpeg"
],
"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"
}
],
"title": "bucketSchema"
}
},
"example": [
{
"id": "avatars",
"name": "avatars",
"owner": "4d56e902-f0a0-4662-8448-a4d9e643c142",
"public": false,
"file_size_limit": 1000000,
"allowed_mime_types": [
"image/png",
"image/jpeg"
],
"created_at": "2021-02-17T04:43:32.770206+00:00",
"updated_at": "2021-02-17T04:43:32.770206+00:00"
}
]
}
postapiv0/bucket/{bucketId}/empty
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully emptied"
]
}
}
}
}
getapiv0/bucket/{bucketId}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"public": {
"type": "boolean"
},
"file_size_limit": {
"type": [
"null",
"integer"
]
},
"allowed_mime_types": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"example": {
"id": "bucket2",
"name": "bucket2",
"public": false,
"file_size_limit": 1000000,
"allowed_mime_types": [
"image/png",
"image/jpeg"
],
"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"
}
}
putapiv0/bucket/{bucketId}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully updated"
]
}
},
"required": [
"message"
]
}
}
deleteapiv0/bucket/{bucketId}
Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully deleted"
]
}
}
}
}
getapiv0/object/{bucketName}/{wildcard}
Default Response
{
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
getapiv0/object/info/{bucketName}/{wildcard}
Default Response
{
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "string"
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"statusCode",
"error",
"message"
],
"title": "errorSchema"
}
}
Need some help?
Contact supportLatest product updates?
See ChangelogSomething's not right?
Check system status