跳转至

删除分支

DELETE /api/v5/repos/{owner}/{repo}/branches/{name}

该接口用于删除指定仓库中指定的分支。调用成功后,目标分支将被移除,响应体为空。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
repo path string 是 仓库路径(path)
name path string 是 分支名称
access_token query string 是 用户授权码

响应参数

该接口成功时无响应体(HTTP 204/200,返回 ResponseEntity<Void>),不返回业务数据。

失败响应

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

404 资源不存在

{
  "error": "not_found",
  "message": "分支不存在"
}

错误字段名以后端实际返回为准,此处仅作示意。

HTTP 响应状态码

状态码 说明
204 无内容(No Content),删除成功
200 成功(OK)
401 需要认证(Requires authentication)
404 分支不存在(Not found)
403 禁止访问(Forbidden)

请求示例

参数说明

<owner> 替换为仓库所属空间地址(企业、组织或个人的地址 path); <repo> 替换为仓库路径(path); <name> 替换为要删除的分支名称; <token> 替换为你的 AtomGit 用户访问令牌。

cURL

curl -X DELETE 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>",
  {
    method: "DELETE",
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.text();
console.log(data);

Python

import requests

resp = requests.delete(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/branches/<name>?access_token=<token>",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.text)

响应示例

状态码: 204

删除成功时响应体为空(204 No Content),无返回内容。

错误码

错误码 说明
401 未认证或凭证无效(缺少/无效的访问凭证)
404 分支不存在或请求路径不存在
403 禁止访问(无权限)
400 参数错误或请求无法解析
429 请求过于频繁,触发限流
500 系统内部错误

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc