Beyrucket Partner API — v1

Integrate Beyrucket partner API.

A fast, predictable REST surface designed to stay out of your way. Ship robust integrations in a few lines of code.

01. Authentication

Authenticate every request.

Partner APIs use Basic Auth only. Send the header Authorization: Basic base64(ACCESS_KEY:SECRET_KEY) on each request.

Auth type

Basic Authentication

Auth header

Authorization: Basic base64(ACCESS_KEY:SECRET_KEY)

curl -X GET "https://apibeyrucket.cidevstudio.com/api/buckets/{BUCKET_ID}/objects" \
  -H "Authorization: Basic {BASE64_ACCESS_KEY_SECRET}"

02. Objects & files

Upload your data.

Send files to a bucket with a POST request using multipart/form-data. Bucket UUIDs keep routes opaque and non-guessable.

Post/api/buckets/:bucketUniqueId/objects/upload

Note: prefix is optional.

curl -X POST "https://apibeyrucket.cidevstudio.com/api/buckets/{BUCKET_ID}/objects/upload" \
  -H "Authorization: Basic {BASE64_ACCESS_KEY_SECRET}" \
  -F "file=@/local/path/to/file.png" \
  -F "prefix=partners/"

03. Reference API

POST/api/buckets/:bucketUniqueId/objects/upload

Upload one file to a bucket. Field 'prefix' is optional.

GET/api/buckets/:bucketUniqueId/objects

Retrieve uploaded files metadata (includes URL for each object).