git.files.archive

Download the tree at a ref as an archive

GET /git/api/repositories/{repoId}/archiveIAM git:PullRepositoryReadSensitive read, audited

Request syntax

GET /git/api/repositories/{repoId}/archive

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Query parameters

  • refRequired

    string

    The branch, tag or commit id whose files to pack

    Constraints: 1-255 chars

  • formatOptional

    enum

    The archive format; zip when absent

    One of: zip, tar.gz

Response

200 with a zip or tar.gz archive of every file at the ref, as an attachment named `<repository>-<ref>.<format>`.

The response is the raw content with its own content type, not 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 git:PullRepository 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 git files archive repoId --ref example

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