Obtaining Repository File Contents

Function

This API is used to obtain repository file contents.

Debugging

You can debug this API in API Explorer which supports automatic authentication. API Explorer automatically generates sample SDK code and provides the debug function.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v1/{project_id}/git/files/{namespace}/{project}/{path}

Table 1 describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
namespace	Yes	String	Namespace ID or URL code name. See Obtaining a Repository Namespace.
project	Yes	String	Repository project ID or URL code name. If the value contains a slash (/), replace it with a colon (:). See Obtaining All Projects in a Namespace.
path	Yes	String	File path. If the value contains a slash (/), replace it with a colon (:). See Obtaining a Repository File Directory.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
ref	Yes	String	Branch name, tag name, or commit SHA value.

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token Through Password Authentication.
X-Repo-Auth	Yes	String	Authorization name. See Obtaining a Git Repository Authorization List.

Response

**Table 4** Response parameters
Parameter	Type	Description
path	String	File path.
sha	String	Commit SHA value.
encoding	String	Encoding mode. Value: Base64 or text/plain.
content	String	File contents.

Example Request

None

Example Response

{
  "path": "app/models/key.rb",
  "sha": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
  "encoding": "base64",
  "content": "IyA9PSBTY2hlbWEgSW5mb3..."
}