s3.bucket-access.set-website

Serve the bucket as a static website on https://<bucket>.s3-website.<root>

PUT /s3/api/buckets/{name}/websiteIAM s3:PutBucketWebsiteChanges state

Only objects the bucket policy makes public are served; anything else answers 403.

Request syntax

PUT /s3/api/buckets/{name}/website
{
  "indexDocument": "string",
  "redirectAllRequestsTo": "object",
  "routingRules": "array of json",
  "errorDocument": "string"
}

Path parameters

  • nameRequired

    string

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

Request body

  • indexDocumentOptional

    string

    Index document suffix, e.g. index.html; required unless redirectAllRequestsTo

    Constraints: 1-255 chars

  • redirectAllRequestsToOptional

    object

    { hostName, protocol? }: send every request, path and query kept, to another host

    Constraints: JSON

  • routingRulesOptional

    array of json

    AWS RoutingRules: [{ condition?: { keyPrefixEquals?, httpErrorCodeReturnedEquals? }, redirect: { hostName?, protocol?, replaceKeyPrefixWith? | replaceKeyWith?, httpRedirectCode? } }]

  • errorDocumentOptional

    string

    Key served with 404 for a missing page, e.g. 404.html

    Constraints: 1-1024 chars

    May be null.

Response

200; data is the bucket as get returns it, with websiteUrl set.

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:PutBucketWebsite 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 set-website 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_set-website.