Help Center/ ServiceStage/ API Reference/ Git Repository Access APIs/ Deleting a Repository File
Updated on 2024-10-16 GMT+08:00
View PDF
Share

Deleting a Repository File

Function

This API is used to delete a repository file.

URI

DELETE /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.

message

Yes

String

Commit information.

sha

Yes

String

Blob SHA of a file, which can be obtained through Obtaining Repository File Contents.

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.

X-Repo-Auth

Yes

String

Authorization name. See Obtaining a Git Repository Authorization List.

Response

None

Example Request

None

Example Response

None

Status Code

Status Code

Description

204

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.