On this page
Create a bucket
Creates a bucket.
Creates a bucket. The Operation is done when the controller settles it.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets - Scope
data:write - Effect
write— a successful call changes state. - Collection buckets
- Query
bucket_id,validate_only - Operation answers with an
Operation; the result isBucket
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to create in. Required. |
bucket | Bucket | The bucket to create; only spec and caller-writable metadata are read. Required. |
bucket_id | string | The id segment of the name; the server assigns one when unset. |
validate_only | bool | Validate and return the result without writing anything. |
Bucket
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket}. |
meta | ResourceMeta | Resource metadata. |
spec | BucketSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
BucketSpec
| Field | Type | What it is |
|---|---|---|
versioning_enabled | bool | Keep every version and write delete markers. |
retention | duration | Versions are kept at least this long; unset keeps no minimum. |
region | string | The region; default the project's home region. Changing it moves the data by signed export and import. |
deletion_protection | bool | While set, Delete fails with DELETION_PROTECTED. |
cors | BucketCorsRule[] | Browser access (CORS) rules for the bucket's S3 endpoint, in order; the first rule matching an origin and method answers. Empty answers no cross-origin request. At most 20 rules. |
lifecycle | BucketLifecycle | Rules that remove what a bucket no longer needs. Unset keeps everything. |
public_access | BucketPublicAccess | Who may read the bucket's objects without a key. Unset is OFF. Set at creation; the bucket serves it once its S3 endpoint does, and until then every object stays private. |
BucketCorsRule
| Field | Type | What it is |
|---|---|---|
allowed_origins | string[] | Origins as scheme://host[:port], for example https://app.example.com, with at most one * in the host (https://*.example.com), or a lone *. Required; at most 20. Required. |
allowed_methods | string[] | Any of GET, HEAD, PUT, POST, DELETE. Required. Required. |
allowed_headers | string[] | Request headers the browser may send, or *. A presigned PUT needs Content-Type; a multipart part needs none. |
expose_headers | string[] | Response headers the page may read. Data adds ETag to a rule that allows PUT or POST, because a browser multipart upload cannot complete without each part's ETag, so a read of the rule always lists it. |
max_age | duration | How long a browser may cache the preflight answer; default 3600s, at most 86400s. |
BucketLifecycle
| Field | Type | What it is |
|---|---|---|
abort_incomplete_multipart_days | int32 | Abort a multipart upload that has not completed this many days after it started, and free its parts: 1 to 365. 0 keeps incomplete uploads until someone aborts them (and they are billed as stored bytes until then). |
expiration_rules | BucketExpirationRule[] | Expire current objects by key prefix, at most 50 rules with distinct prefixes. On a versioned bucket an expiry writes a delete marker. |
BucketPublicAccess
| Field | Type | What it is |
|---|---|---|
mode | BucketPublicAccessMode | Which objects are public. One of off, read, read_prefixes. |
prefixes | string[] | Key prefixes whose objects are public when mode is READ_PREFIXES, at most 50, each at most 1024 bytes. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | {parent-of-target}/operations/{operation}. |
target | string | The name of the Resource being changed. |
target_generation | int64 | The generation this Operation waits for. |
verb | OperationVerb | What the Operation does. One of create, update, delete, custom. |
custom_verb | string | The custom method verb when verb is CUSTOM, for example revoke. |
done | bool | Whether the Operation has finished. |
create_time | timestamp | When the Operation started. |
end_time | timestamp | When the Operation finished. |
response | any | The settled Resource (or Empty for a delete). One of the result group. |
error | ProblemDetails | The failure, as the one error body. One of the result group. |
progress | OperationProgress | Progress while not done. |
ProblemDetails
| Field | Type | What it is |
|---|---|---|
type | string | https://sylphx.com/docs/errors/<code in kebab-case>. |
title | string | A short customer-safe summary of the problem class. |
status | int32 | The HTTP status, fixed by grpc_status. |
detail | string | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
instance | string | The request id (Sylphx-Request-Id). |
code | string | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
grpc_status | string | One of the 16 canonical gRPC status names, for example ABORTED. |
retryable | bool | Whether the same request may be retried. |
effect | ErrorEffect | What the failed call committed. One of none, applied, unknown. |
retry_after_ms | int64 | How long to wait before retrying, when the server knows. |
details | any[] | Typed details such as PreconditionFailure or EntitlementDenial. |
OperationProgress
| Field | Type | What it is |
|---|---|---|
percent | int32 | Percent complete, when the controller can tell. |
message | string | A customer-safe progress message. |
conditions | Condition[] | The target's conditions when this progress was read. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.SPEND_LIMIT_REACHED— The org's spend limit is reached.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spec":{}}'