Upload an Object

7min

POST /{appname}/storage/{bucket}
Adds an object to a storage service bucket using FormData
Parameters
Path Parameters
appname - string - the name of your hyper cloud application.
bucket - string- the name of your hyper cloud service. 
Request Body
When posting unstructured data to the storage service it is best to use a multipart/form-data Content-Type and the form-data should contain a file field. See the examples.
Form Data Fields
file - represents the unstructured file for storage
path - string - optional - contains additional path structure from bucket root. eg. if path equals directory1/directory2 then the object location will be /storage/bucket/directory1/directory2/hello.txt 
ReadbleStream with hyper-connect on Node?
hyper-connect's storage.upload accepts a Web ReadableStream as input. Starting with Node 17, Node provides toWeb and fromWeb apis to converts NodeJS.ReadableStream to Web ReadableStream
Example
Node.js
import { createReadStream } from 'node:fs'
import { Readable } from 'node:stream'
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

// Convert to a ReadbleStream from a NodeJS.ReadableStream
const result = await hyper.storage.upload(
  'foo.png',
  Readable.toWeb(createReadStream('foo.png'))
)

console.log(result)
import { createReadStream } from 'node:fs'
import { Readable } from 'node:stream'
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

// Convert to a ReadbleStream from a NodeJS.ReadableStream
const result = await hyper.storage.upload(
  'foo.png',
  Readable.toWeb(createReadStream('foo.png'))
)

console.log(result)
﻿
Responses
Status
Description
Example
201
Created
{"ok": true}
500
Server Error
{"ok": false, "msg": "..."}
Need Help?
You can always reach out to our support team for any additional assistance on slack.
﻿

Updated 20 Nov 2023

Did this page help you?

Storage API

Get Object

Docs powered by Archbee

TABLE OF CONTENTS

POST /{appname}/storage/{bucket}

ReadbleStream with hyper-connect on Node?

Example

Responses

Need Help?

Status	Description	Example
201	Created	{"ok": true}
500	Server Error	{"ok": false, "msg": "..."}