Connecting custom scripts and tools via the S3-compatible API

Most Vouchio accounts connect through existing backup or NAS software, but if you're writing your own scripts, deploying from a CI pipeline, or integrating a custom application, you can talk to Vouchio directly through its S3-compatible API. If you haven't already, mainstream backup software is usually the faster path; see setting up automated backups. This guide is for when you specifically need programmatic access.

Before you start

From your Vouchio account, sent after your questionnaire is confirmed, you'll need:

• An access key ID and secret access key, scoped to your account
• Your account's storage endpoint URL
• The bucket or folder name you're reading from or writing to

Which tools work

Because the endpoint is S3-compatible, most tools and libraries built for S3 work without modification, you're typically just changing the endpoint URL and disabling any provider-specific assumptions.

Example: AWS CLI

Configure a profile with your Vouchio keys, then point commands at your endpoint:

aws configure --profile vouchio
# enter your access key ID and secret access key when prompted

aws s3 cp ./backup.zip s3://your-bucket/backup.zip \
  --endpoint-url https://your-endpoint.vouchio.net \
  --profile vouchio

Example: curl

For a quick connectivity check or a simple scripted upload without a full SDK, a signed request via curl works the same way it would against any S3-compatible endpoint:

# list objects in a bucket (using a pre-signed URL generated
# via the AWS CLI or an SDK, since S3-style auth requires
# request signing rather than a plain API key in the header)
aws s3 presign s3://your-bucket/backup.zip \
  --endpoint-url https://your-endpoint.vouchio.net \
  --profile vouchio

curl "https://your-endpoint.vouchio.net/your-bucket/backup.zip?X-Amz-..."

What's supported

Standard object operations, PUT, GET, LIST, DELETE, and multipart upload for large files, are supported, which covers the vast majority of backup, sync, and application storage use cases. If your integration depends on a less common or provider-specific API extension, confirm it's supported before building around it; mention it in the questionnaire and a specialist will give you a direct answer.

Retention Lock and the API

If an object has a Retention Lock period set, that lock is enforced at the storage layer, not just in a web console. A DELETE or overwrite request against a locked object through the API is rejected the same way it would be anywhere else, which is the point: no access path, including a script with valid keys, can bypass it before the retention period ends.