s3.bucket-objects.download-url

A presigned GET for one object, valid 15 minutes, saved as a download

POST /s3/api/buckets/{name}/objects/download-urlIAM s3:GetObjectReadSensitive read, audited

Request syntax

POST /s3/api/buckets/{name}/objects/download-url
{
  "key": "string",
  "versionId": "string"
}

Path parameters

  • nameRequired

    string

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

Request body

  • keyRequired

    string

    Key of the object to download

    Constraints: min 1 chars

  • versionIdOptional

    string

    An older version; absent: the current one

    Constraints: 1-1024 chars, /^[A-Za-z0-9._\-+=/]+$/

Response

200; data is { url, expiresInSeconds }: a presigned URL that downloads the object (or the version asked for) with no further credentials, valid 900 seconds.

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:GetObject 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 download-url name --key example

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_download-url.