添加公钥¶

POST /api/v5/user/keys

用户调用此接口，进行添加一个公钥操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`access_token`	query	string	是	用户授权码

Request Body:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "key": {
      "description": "公钥内容",
      "type": "string"
    },
    "title": {
      "description": "公钥名称",
      "type": "string"
    }
  },
  "required": ["key", "title"]
}

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	—	公钥 ID
`title`	string	是	—	公钥名称
`key`	string	是	—	公钥内容
`created_at`	string	是	—	公钥创建时间
`url`	string	是	—	公钥链接

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 title 不能为空",
  "field": "title"
}

401 未认证

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

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）

请求示例¶

参数说明¶

示例中的占位符说明：

<token> — 替换为你的 AtomGit 用户访问令牌； <title> — 替换为公钥名称； <key> — 替换为公钥内容（如 ssh-ed25519 AAAA... user@host）。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/user/keys?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "<title>",
    "key": "<key>"
  }'

JavaScript¶

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

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

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

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/user/keys",
    params={"access_token": "<token>"},
    json={"title": "<title>", "key": "<key>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": 311915,
  "title": "555555",
  "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIa6IyTGuI8V5wrhANDFyezQqL73dY9ctLGHgpOggp7E Gitee",
  "created_at": "2024-11-14T03:34:40.318+00:00",
  "url": "https://api.atomgit.com/v5/user/keys/311915"
}

错误码¶

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

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