s3.bucket-access.get

Block Public Access flags, the policy, whether the bucket is public, the website

GET /s3/api/buckets/{name}/public-accessIAM s3:GetBucketPolicyRead

Also needs s3:GetBucketPublicAccessBlock and s3:GetBucketWebsite; get-block, get-policy and get-website each need only their own read. `public` is true when a policy grants the public and Block Public Access does not stop it.

Request syntax

GET /s3/api/buckets/{name}/public-access

Path parameters

  • nameRequired

    string

    Constraints: 3-63 chars, /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Response

200; data is { publicAccessBlock, policy, public, website, websiteHost, domains }: the four flags, the policy JSON text (null when none), the website configuration with its url (null when off), and the custom domains.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow s3:GetBucketPolicy on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud s3 bucket-access get name

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_bucket-access_get.