仓库归档¶

PUT /api/v5/org/{org}/repo/{repo}/status

该接口用于更新指定仓库的归档状态，通过设置仓库状态为已归档或取消归档，实现对仓库的归档与恢复管理。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	仓库所属组织
`repo`	path	string	是	仓库路径（path）
`access_token`	query	string	是	用户授权码

Request Body:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "description": "仓库状态，0：开始（表示仓库未归档），2：关闭（表示仓库已归档）",
      "type": "integer",
      "enum": [0, 2]
    },
    "password": {
      "description": "用户密码",
      "type": "string"
    }
  },
  "required": ["status"]
}

响应参数¶

字段	类型	必返	可为空	说明
`code`	integer	是	否	状态码，`0` 表示成功
`msg`	string	是	否	返回信息，成功时为 `success`

失败响应¶

400 参数错误

{
  "code": 400,
  "msg": "参数错误或请求无法解析"
}

401 未认证

{
  "code": 401,
  "msg": "缺少或无效的访问令牌"
}

错误字段名与取值以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`404`	未找到（Not Found）

请求示例¶

参数说明¶

<org> 替换为仓库所属组织的路径；<repo> 替换为仓库路径（path）；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/org/<org>/repo/<repo>/status?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"status": 2}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/org/<org>/repo/<repo>/status?access_token=<token>", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({ status: 2 }),
});

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

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

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/org/<org>/repo/<repo>/status",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={"status": 2},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "code": 0,
  "msg": "success"
}

错误码¶

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

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