Call the S3 API

You list, read, write, copy, and sign files on the storage connector the API key belongs to.

On this page

List and read

GET https://core.orbitype.com/api/s3/v1 with X-API-KEY and a path lists that prefix. A path that ends in a file name returns the file.

Write, copy, delete, sign

PUT /api/s3/v1 writes an object.
POST /api/s3/v1/upload uploads a file.
POST /api/s3/v1/copy copies an object.
DELETE /api/s3/v1 deletes an object.
POST /api/s3/v1/signed-url returns a signed URL.

Send X-API-KEY from a key whose connector is the storage connector. A key on the SQL connector cannot read files.

List a folder

GET https://core.orbitype.com/api/s3/v1?path=folder/
X-API-KEY: YOUR_API_KEY

path is required. A path that ends with a file name returns the file. A path that is a folder lists it. The key must belong to the storage connector.

Write, copy, delete, and sign

Write text with PUT. path and body are required. An object body is stored as JSON.

PUT https://core.orbitype.com/api/s3/v1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json

{ "path": "notes/hello.txt", "body": "Hello" }

Copy with POST /api/s3/v1/copy. from and to are required. Delete with DELETE /api/s3/v1 and path. Sign a download with POST /api/s3/v1/signed-url and path. The URL expires after five minutes. Request a new one when it stops.

Upload a real file with POST /api/s3/v1/upload as multipart. The file field is file and path is the destination. A single file over the upload limit, or a bucket over its total limit, returns 422.

If this fails: The file call fails

Use a key created on the storage connector. A SQL key returns 401 or the wrong connector. path must include the folder. A path that ends in a file name reads the file. A path that is a folder lists it. Delete only the object you named. A signed URL expires. Request a new one when the link stops working.