Help Center> ServiceStage> API Reference> Git Repository Access APIs> Obtaining a Repository File Directory
Updated on 2023-07-19 GMT+08:00
View PDF

Obtaining a Repository File Directory

Function

This API is used to obtain a repository file directory.

URI

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

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.
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 or format.

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.

X-Repo-Auth

Yes

String

Authorization name. See Obtaining a Git Repository Authorization List.

Response

Table 4 Response parameters

Parameter

Type

Description

paths

Array<String>

File path.

Example Request

None

Example Response

{
  "paths": [
    "files/whitespace"
  ]
}

Status Code

Table 5 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

Error Code

The error code format is SVCSTG.REPO.[Error_ID], for example, SVCSTG.REPO.0401. For details, see ServiceStage Error Codes.