获取仓库设置¶

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

用户调用此接口，进行获取仓库设置操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

响应参数¶

字段	类型	必返	可为空	说明
`forbidden_developer_create_branch`	boolean	是	否	是否禁止开发者创建分支
`forbidden_developer_create_tag`	boolean	是	否	是否禁止开发者创建标签
`forbidden_committer_create_branch`	boolean	是	否	是否禁止提交者创建分支
`generate_pre_merge_ref`	boolean	是	否	是否生成预合并引用（pre-merge ref）
`forbidden_gitlab_access`	boolean	是	否	是否禁止 GitLab 访问
`rebase_disable_trigger_webhook`	boolean	是	否	变基（rebase）时是否禁用触发 Webhook
`action_pipeline_enabled`	boolean	是	否	是否启用 Actions 流水线
`block_cross_repo_pr_trigger`	boolean	是	否	是否阻止跨仓库 Pull Request 触发
`show_branch_creator`	boolean	是	否	是否显示分支创建者信息，与页面上「显示分支创建者信息」复选框对应
`disable_fork`	boolean	否	否	是否禁止 Fork
`include_lfs_objects`	boolean	否	否	是否包含 LFS 对象

Note: 响应字段集合可能随仓库而异，disable_fork、include_lfs_objects 等字段仅在部分响应中出现，以实际返回为准。

失败响应¶

该接口要求认证，未携带或携带无效的 access_token 时返回 401；错误字段名以后端实际返回为准。

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	仓库或资源不存在
`500`	系统内部错误

请求示例¶

参数说明¶

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

cURL¶

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

print(resp.json())

响应示例¶

状态码： 200

{
  "forbidden_developer_create_branch": true,
  "forbidden_developer_create_tag": true,
  "forbidden_committer_create_branch": true,
  "generate_pre_merge_ref": true,
  "forbidden_gitlab_access": true,
  "rebase_disable_trigger_webhook": true,
  "action_pipeline_enabled": true,
  "block_cross_repo_pr_trigger": true,
  "show_branch_creator": true
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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