Connect a bucket
PUT/workspaces/:id/storage
Creates or replaces the workspace's connection. Formfeed writes the test object
<prefix>.formfeed/connection-test.txt first, with the credentials in the request, and stores
nothing unless that works: a wrong key or a missing bucket answers 422 storage_test_failed
with the provider's error. Formfeed only ever writes (PutObject); it never reads, lists or
deletes in the bucket. Leave out the credentials to keep the stored ones while the endpoint
stays the same. From then on every output of the workspace (renders, batch items and zips,
PDF tools, office renders) is copied to the bucket in the background; Formfeed keeps its own
copy for as long as the plan's and the workspace's retention say. Owners and admins in the
app only, on the Pro plan and above.
Request
Responses
- 200
- 201
- 403
- 422
- default
Replaced.
Connected.
An API key or a role other than owner and admin; forbidden with feature: byo_storage below the Pro plan.
storage_test_failed: the test object could not be written; error carries the provider's code.
Error (RFC 9457 problem details).