OVHcloud Object Storage

OVHcloud Object Storage (High Performance S3) via the S3-compatible API. Endpoint derived from the region code.

Installation

@aws-sdk/client-s3, @aws-sdk/s3-presigned-post, and @aws-sdk/s3-request-presigner are optional peer dependencies of files-sdk - install alongside the SDK so the adapter’s imports resolve at runtime.

npm install files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

pnpm add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

yarn add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

bun add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

Usage

import { Files } from "files-sdk";
import { ovhcloud } from "files-sdk/ovhcloud";

const files = new Files({
  adapter: ovhcloud({
    bucket: "uploads",
    region: "gra", // or "sbg", "de", "uk", "waw", "sgp", "syd"
    // accessKeyId / secretAccessKey auto-loaded from
    // OVH_ACCESS_KEY_ID / OVH_SECRET_ACCESS_KEY
  }),
});

OVHcloud Object Storage (High Performance S3) via its S3-compatible API. A thin wrapper around the S3 adapter - endpoint derived from the region code (gra, sbg, bhs, de, uk, waw, sgp, syd), virtual-hosted-style addressing, errors relabelled. For the Standard (Swift-backed) tier, pass https://s3.<region>.cloud.ovh.net as the explicit endpoint. Auto-loads from OVH_ACCESS_KEY_ID and OVH_SECRET_ACCESS_KEY. Generate S3 credentials in the OVHcloud Control Panel under Public Cloud -> Object Storage -> S3 users.

Options

PropType

bucketstring

OVHcloud bucket name. The adapter scopes all operations to it.

Typestring

regionstring

OVHcloud Object Storage region code, e.g. `"gra"` (Gravelines), `"sbg"` (Strasbourg), `"bhs"` (Beauharnois), `"de"` (Frankfurt), `"uk"` (London), `"waw"` (Warsaw), `"sgp"` (Singapore), `"syd"` (Sydney). Drives the endpoint host (`https://s3.<region>.io.cloud.ovh.net`, the High Performance S3 API); there's no env-var fallback. Doubles as the SigV4 region.

Typestring

endpoint?string

Override the OVHcloud endpoint. When unset, defaults to `https://s3.${region}.io.cloud.ovh.net` — OVHcloud's High Performance S3 endpoint. For the Standard tier (Swift-backed), pass `https://s3.${region}.cloud.ovh.net` explicitly. OVHcloud routes by Host header — the SDK prepends the bucket subdomain for virtual-hosted style.

Typestring

accessKeyId?string

Static credentials. Falls back to `OVH_ACCESS_KEY_ID`; required if that env var isn't set.

Typestring

secretAccessKey?string

Static credentials. Falls back to `OVH_SECRET_ACCESS_KEY`; required if that env var isn't set.

Typestring

forcePathStyle?boolean

Use path-style addressing (`/<bucket>/<key>`) rather than virtual-hosted style. Defaults to `false` — virtual-hosted is canonical for OVHcloud.

Typeboolean

publicBaseUrl?string

Origin used to build URLs from `url()`. When set, `url(key)` returns `${publicBaseUrl}/${key}` and skips signing. For public containers the natural value is `https://${bucket}.s3.${region}.io.cloud.ovh.net`; a custom CNAME fronting the bucket also works. When unset, `url()` falls back to a presigned GetObject (default expiry: 1 hour).

Typestring

defaultUrlExpiresIn?number

Default expiry, in seconds, for the presigned URLs returned by `url()` when `publicBaseUrl` is not set. Defaults to 3600 (1 hour).

Typenumber

Compatibility

Method	Status	Notes
`upload`	✅
`download`	✅
`delete`	✅
`list`	✅
`search`	✅
`head`	✅
`exists`	✅
`copy`	✅
`url`	✅
`signedUploadUrl`	✅