REST API 现在已版本化。 有关更多信息，请参阅“关于 API 版本控制”。

用于存储库自动链接的 REST API 端点

使用 REST API 将自动链接添加到外部资源。

为了帮助简化您的工作流程，您可以使用 REST API 将自动链接添加到外部资源，例如 JIRA 问题和 Zendesk 工单。有关更多信息，请参阅“配置自动链接以引用外部资源”。

GitHub Apps 需要具有读写访问权限的存储库管理权限才能使用这些端点。

获取为存储库配置的所有自动链接。

有关自动链接的信息仅对存储库管理员可用。

用于“获取存储库的所有自动链接”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”存储库权限（读）

用于“获取存储库的所有自动链接”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不包含 .git 扩展名。名称不区分大小写。

获取仓库所有自动链接的 HTTP 响应状态码

状态码描述
200

OK

获取仓库所有自动链接的代码示例

请求示例

get/repos/{owner}/{repo}/autolinks
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks

响应

状态: 200
[ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true } ]

具有仓库管理员权限的用户可以创建自动链接。

为“为仓库创建自动链接引用”创建细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”仓库权限（写入）

为“为仓库创建自动链接引用”创建参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不包含 .git 扩展名。名称不区分大小写。

主体参数
key_prefix string 必需

此前缀附加某些字符将在问题、拉取请求或提交中找到时生成链接。

url_template string 必需

URL 必须包含 <num> 用于引用编号。<num> 匹配不同的字符，具体取决于 is_alphanumeric 的值。

is_alphanumeric boolean

此自动链接引用是否匹配字母数字字符。如果为真，则 url_template 的 <num> 参数匹配字母数字字符 A-Z（不区分大小写）、0-9 和 -。如果为假，则此自动链接引用仅匹配数字字符。

默认: true

为“为仓库创建自动链接引用”创建 HTTP 响应状态码

状态码描述
201

已创建

422

验证失败，或端点已被滥用。

“为仓库创建自动链接引用”的代码示例

请求示例

post/repos/{owner}/{repo}/autolinks
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks \ -d '{"key_prefix":"TICKET-","url_template":"https://example.com/TICKET?query=<num>","is_alphanumeric":true}'

响应

状态：201
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

这将返回为给定仓库配置的单个自动链接引用，通过 ID 识别。

有关自动链接的信息仅对存储库管理员可用。

“获取仓库的自动链接引用”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”存储库权限（读）

“获取仓库的自动链接引用”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不包含 .git 扩展名。名称不区分大小写。

autolink_id 整数 必需

自动链接的唯一标识符。

“获取仓库的自动链接引用”的 HTTP 响应状态代码

状态码描述
200

OK

404

资源未找到

“获取仓库的自动链接引用”的代码示例

请求示例

get/repos/{owner}/{repo}/autolinks/{autolink_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

响应

状态: 200
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

这将删除为给定仓库配置的单个自动链接引用，通过 ID 识别。

有关自动链接的信息仅对存储库管理员可用。

“从仓库中删除自动链接引用”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”仓库权限（写入）

“从仓库中删除自动链接引用”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不包含 .git 扩展名。名称不区分大小写。

autolink_id 整数 必需

自动链接的唯一标识符。

“从仓库中删除自动链接引用”的 HTTP 响应状态代码

状态码描述
204

无内容

404

资源未找到

“从仓库中删除自动链接引用”的代码示例

请求示例

delete/repos/{owner}/{repo}/autolinks/{autolink_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

响应

状态：204