git.files.blob

Read one file as raw text

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

Request syntax

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

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Query parameters

  • refOptional

    string

    Branch, tag or commit id; the default branch when absent

    Constraints: 1-255 chars

  • pathRequired

    string

    The file's path from the repository root, e.g. src/index.ts

    Constraints: 1-1000 chars

Response

200 with oid, size in bytes, isBinary, and `text`, the content as UTF-8 (null for a binary file). 404 when there is no such file.

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

Fields of data

  • oidAlways

    string

    The object id of the file content
  • sizeAlways

    number

    Size in bytes
  • isBinaryAlways

    boolean

    true when the file is not text
  • textAlways

    string, may be null

    The content as UTF-8; null for a binary file

Checked against the handlers: every route test validates their answers against this schema.

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 blob repoId --path 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_blob.