Buckets
A Bucket is one customer object store: bytes, size, and SHA-256 kept exact, with versions, delete markers, retention, multipart, and…
A Bucket is one customer object store: bytes, size, and SHA-256 kept exact, with versions, delete markers, retention, multipart, and per-object visibility (private by default). Silo: each has its own store, access keys, backup, region, and deletion.
Service Sylphx Data · Resource type data.sylphx.com/Bucket · Name pattern orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket}. |
uid | string | bkt_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | BucketSpec | Desired state. Required. |
status | BucketStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a bucket. |
GET | list | Lists buckets in a environment. |
POST | create | Creates a bucket. The Operation is done when the controller settles it. |
PATCH | update | Updates a bucket's spec.deletion_protection, spec.cors and spec.lifecycle; every other field is fixed at creation. A mask path replaces the whole field (spec.cors replaces every rule). |
DELETE | delete | Deletes a bucket. Fails while spec.deletion_protection is set. |
POST | connect | Returns where to reach the bucket: the Data API address, and, once the bucket is served over S3, an S3 endpoint with keys scoped to this one bucket (s3). It carries no username or password; each call mints new S3 keys, and a client signs with those. |
POST | rotate_credentials | Revokes every S3 key :connect minted for the bucket, at once; connect again for new ones. Keys of other buckets are untouched. |
get
Gets a bucket.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket · scope data:read · effect read · Request, response and examples
list
Lists buckets in a environment.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets · scope data:read · effect read · paginated · Request, response and examples
create
Creates a bucket. The Operation is done when the controller settles it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets · scope data:write · effect write · long-running · Request, response and examples
update
Updates a bucket's spec.deletion_protection, spec.cors and spec.lifecycle; every other field is fixed at creation. A mask path replaces the whole field (spec.cors replaces every rule).
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket · scope data:write · effect write · long-running · Request, response and examples
delete
Deletes a bucket. Fails while spec.deletion_protection is set.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket · scope data:write · effect destructive · long-running · Request, response and examples
connect
Returns where to reach the bucket: the Data API address, and, once the bucket is served over S3, an S3 endpoint with keys scoped to this one bucket (s3). It carries no username or password; each call mints new S3 keys, and a client signs with those.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket:connect · scope data:write · effect read · Request, response and examples
rotate_credentials
Revokes every S3 key :connect minted for the bucket, at once; connect again for new ones. Keys of other buckets are untouched.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket:rotateCredentials · scope data:write · effect write · validate_only · long-running · Request, response and examples