获取项目推送规则¶

GET /api/v5/repos/{owner}/{repo}/push_config

调用此接口获取指定仓库的项目推送规则配置。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

响应参数¶

字段	类型	必返	可为空	说明
`reject_not_signed_by_gpg`	integer	是	否	是否拒绝未由 GPG 签名的推送，取值 `0`/`1`
`deny_force_push`	integer	是	否	是否禁止强制推送，取值 `0`/`1`
`max_file_size`	integer	是	否	允许推送的最大文件大小
`skip_rule_for_owner`	integer	是	否	是否对仓库所有者跳过推送规则，取值 `0`/`1`

失败响应¶

以下为常见失败响应示例，具体错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数错误"
}

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_config?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>/push_config?access_token=<token>", {
  headers: {
    "Accept": "application/json",
  },
});

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

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

Python¶

import requests

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

print(resp.json())

响应示例¶

状态码： 200

{
  "reject_not_signed_by_gpg": 0,
  "deny_force_push": 0,
  "max_file_size": 0,
  "skip_rule_for_owner": 0
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`403`	禁止访问（Forbidden）
`404`	请求路径不存在

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