Skip to Content
We are live but in Staging 🎉
Object StorageAPI ReferencePolicy

Bucket Policy

S3-style access control on a bucket. See Core Concepts → Policy for the BucketPolicy type signature. Applying a non-empty policy implies BucketAccessMode.CUSTOM on the bucket.

RPCHTTP
SetBucketPolicyPUT /admin/buckets/:name/policy
GetBucketPolicyGET /admin/buckets/:name/policy
DeleteBucketPolicyDELETE /admin/buckets/:name/policy

gRPC setup — grpcurl, endpoints, reflection, and field-name casing — is covered once in Conventions → Using gRPC.

SetBucketPolicy

The HTTP body is the BucketPolicy value (the proto’s body: "policy" mapping makes the policy the top-level body, not a wrapper).

Request

curl -sS -X PUT "https://k3.dev.dodil.io/admin/buckets/kb-prod/policy" \
  -H "Authorization: Bearer $DODIL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "2024-01-01",
    "statements": [
      {
        "sid": "allow-public-read",
        "effect": "POLICY_EFFECT_ALLOW",
        "principal": { "aws": ["*"] },
        "actions": ["s3:GetObject"],
        "resources": ["arn:aws:s3:::kb-prod/public/*"]
      }
    ]
  }'

Response

A BucketPolicy — see Core Concepts → Policy.

GetBucketPolicy

Request

curl -sS "https://k3.dev.dodil.io/admin/buckets/kb-prod/policy" \
  -H "Authorization: Bearer $DODIL_TOKEN"

Response

A BucketPolicy — see Core Concepts → Policy.

DeleteBucketPolicy

Request

curl -sS -X DELETE "https://k3.dev.dodil.io/admin/buckets/kb-prod/policy" \
  -H "Authorization: Bearer $DODIL_TOKEN"

Response

Empty (DeleteBucketPolicyResponse {}).

See also

BucketsCORS