Blob Storage Quickstart: Upload and Serve Your First File

In five minutes you will upload a file, make it public, create a temporary link and delete it.

Create an API key

In the dashboard open Settings → API keys and create a key with the blob:write scope (it can also read your files through blob:read, which the full preset includes). Keep it in an environment variable:

export VERTRA_API_KEY="your_key"

Upload a file

The simple upload takes one request for files up to 100 MB. Files are private unless you ask for public.

curl -X POST "https://blob.vertracloud.app/v1/objects?path=images/logo.png&visibility=public" \
  -H "Authorization: Bearer $VERTRA_API_KEY" \
  -F "file=@./logo.png"

import { BlobClient } from "@vertracloud/blob";

const blob = new BlobClient({ apiKey: process.env.VERTRA_API_KEY });
const obj = await blob.put("images/logo.png", file, { visibility: "public" });
console.log(obj.url);

obj = client.blob.put("images/logo.png", open("logo.png", "rb"), visibility="public")
print(obj["url"])

f, err := os.Open("logo.png")
if err != nil {
    log.Fatal(err)
}
defer f.Close()
info, _ := f.Stat()

obj, err := client.Blob.Put(ctx, "images/logo.png", f, info.Size(),
    &vertracloud.BlobPutOptions{Visibility: "public"})
if err != nil {
    log.Fatal(err)
}
fmt.Println(*obj.URL)

The response is the file object: its id, size, content_type and, for public files, the url.

List your files

curl "https://blob.vertracloud.app/v1/objects?prefix=images/&delimiter=/" \
  -H "Authorization: Bearer $VERTRA_API_KEY"

for await (const obj of blob.list({ prefix: "images/" })) {
  console.log(obj.path, obj.size);
}

for obj in client.blob.list(prefix="images/"):
    print(obj["path"], obj["size"])

it := client.Blob.List(ctx, &vertracloud.BlobListOptions{Prefix: "images/"})
for it.Next(ctx) {
    o := it.Object()
    fmt.Println(o.Path, o.Size)
}
if err := it.Err(); err != nil {
    log.Fatal(err)
}

Open the public URL

A public file lives at https://blob.vertracloud.dev/<namespace>/images/logo.png; the url field of the object already has it. Open it in a browser or use it in an <img> tag.

Create a temporary link for a private file

curl "https://blob.vertracloud.app/v1/objects/$OBJECT_ID/download?expires_in=600&redirect=false" \
  -H "Authorization: Bearer $VERTRA_API_KEY"

const { url, expires_at } = await blob.downloadUrl(obj.id, { expiresIn: 600 });

link = client.blob.download_url(obj["id"], expires_in=600)

link, err := client.Blob.DownloadURL(ctx, obj.ID, &vertracloud.BlobDownloadOptions{ExpiresIn: 600})
if err != nil {
    log.Fatal(err)
}
fmt.Println(link.URL, link.ExpiresAt)

The link works for 10 minutes. See Links and visibility.

Delete the file

curl -X DELETE "https://blob.vertracloud.app/v1/objects/$OBJECT_ID" \
  -H "Authorization: Bearer $VERTRA_API_KEY"

await blob.delete(obj.id);

client.blob.delete(obj["id"])

err = client.Blob.Delete(ctx, obj.ID)
if err != nil {
    log.Fatal(err)
}

Where to go next

Large files and progress: Uploads.
Letting browsers upload directly: Serve user uploads.
Every route: Blob API reference.

​Where to go next

Where to go next