An S3 compatible object storage service that integrates with Postgres.
post/bucket/Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"avatars"
]
}
},
"required": [
"name"
]
}
}get/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"
}
]
}post/bucket/{bucketId}/emptySuccessful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully emptied"
]
}
}
}
}get/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"
}
}put/bucket/{bucketId}Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully updated"
]
}
},
"required": [
"message"
]
}
}delete/bucket/{bucketId}Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully deleted"
]
}
}
}
}delete/object/{bucketName}/{wildcard}Successful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully deleted"
]
}
}
}
}get/object/{bucketName}/{wildcard}use GET /object/authenticated/{bucketName} instead
Default Response
{
"schema": {
"$ref": "#/components/schemas/def-1"
}
}put/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"
]
}
}post/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"
]
}
}delete/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"
}
}
}get/object/authenticated/{bucketName}/{wildcard}Error response
{
"schema": {
"$ref": "#/components/schemas/def-1",
"description": "Error response"
}
}post/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"
]
}
}get/object/sign/{bucketName}/{wildcard}Error response
{
"schema": {
"$ref": "#/components/schemas/def-1",
"description": "Error response"
}
}post/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"
]
}
}
}post/object/moveSuccessful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Successfully moved"
]
}
},
"required": [
"message"
]
}
}post/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
}
}
]
}
}
}get/object/info/authenticated/{bucketName}/{wildcard}Error response
{
"schema": {
"$ref": "#/components/schemas/def-1",
"description": "Error response"
}
}post/object/copySuccessful response
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
"type": "string",
"examples": [
"folder/destination.png"
]
}
},
"required": [
"Key"
]
}
}get/object/public/{bucketName}/{wildcard}Error response
{
"schema": {
"$ref": "#/components/schemas/def-1",
"description": "Error response"
}
}get/object/info/public/{bucketName}/{wildcard}returns object info
Default Response
{
"schema": {
"$ref": "#/components/schemas/def-1"
}
}