s3.bucket-objects.list

One page (200) of objects and folders under a prefix

GET /s3/api/buckets/{name}/objectsIAM s3:ListObjectsRead

Folders are common prefixes by "/". Pass nextContinuationToken back for the next page. Any S3 client does the same with ListObjectsV2.

Request syntax

GET /s3/api/buckets/{name}/objects

Path parameters

  • nameRequired

    string

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

Query parameters

  • prefixOptional

    string

    The folder to list, e.g. photos/2026/; absent: the top level of the bucket

    Constraints: max 1024 chars

  • continuationTokenOptional

    string

    nextContinuationToken from the previous page; absent: the first page

    Constraints: max 2048 chars

Response

200; data is { prefix, prefixes, objects: [{ key, size, lastModified }], nextContinuationToken }: the folders (each ending in /) and objects directly under the prefix; nextContinuationToken is null on the last page.

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:ListObjects 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-objects list 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-objects_list.