跳至主要内容
GitHub 文档
版本:
免费、专业版和团队版
搜索 GitHub 文档
REST API
/
Codespaces
首页
REST API
API 版本:
2022-11-28 (最新)
快速入门
关于 REST API
关于 REST API
比较 GitHub 的 API
API 版本
重大变更
OpenAPI 描述
使用 REST API
入门
速率限制
分页
库
最佳实践
故障排除
时区
CORS 和 JSONP
问题事件类型
GitHub 事件类型
身份验证
身份验证
保护 API 凭据
GitHub App 安装令牌的端点
GitHub App 用户令牌的端点
细粒度 PAT 的端点
GitHub Apps 的权限
细粒度 PAT 的权限
指南
使用 JavaScript 的脚本
使用 Ruby 的脚本
发现用户的资源
交付部署
将数据渲染为图表
使用评论
构建 CI 服务器
入门 - Git 数据库
入门 - 检查
加密密钥
操作
工件
缓存
OIDC
权限
密钥
自托管运行器
变量
工作流作业
工作流运行
工作流
活动
事件
Feed
通知
加星
关注
应用
GitHub 应用
安装
市场
OAuth 授权
Webhook
计费
计费
分支
分支
受保护分支
检查
检查运行
检查套件
课堂
课堂
代码扫描
代码扫描
行为准则
行为准则
Codespaces
Codespaces
组织
组织机密
机器
仓库机密
用户机密
协作者
协作者
邀请
提交
提交
提交评论
提交状态
Copilot
Copilot 使用
Copilot 用户管理
Dependabot
警报
密钥
依赖关系图
依赖关系审查
依赖关系提交
软件物料清单 (SBOM)
部署密钥
部署密钥
部署
部署分支策略
部署
环境
保护规则
部署状态
表情符号
表情符号
Gists
Gists
评论
Git 数据库
Blob
提交
引用
标签
树
Gitignore
Gitignore
交互
组织
仓库
用户
问题
问题
指派人
评论
事件
标签
里程碑
时间线
许可证
许可证
Markdown
Markdown
元数据
元数据
指标
社区
统计数据
流量
迁移
组织
源端点
用户
组织
屏蔽用户
自定义属性
成员
组织角色
组织
外部协作者
个人访问令牌
规则套件
规则
安全管理员
Webhook
包
包
页面
页面
项目 (经典)
看板
卡片
协作者
列
拉取请求
拉取请求
审查评论
审查请求
审查
速率限制
速率限制
反应
反应
发布
发布
发布资产
仓库
自动链接
内容
自定义属性
分支
仓库
规则套件
规则
标签
Webhook
搜索
搜索
秘密扫描
秘密扫描
安全公告
全局安全公告
仓库安全公告
团队
团队
讨论评论
讨论
成员
用户
用户
屏蔽用户
电子邮件
关注者
GPG 密钥
Git SSH 密钥
SSH 签名密钥
社交账号
REST API 现在已版本化。
有关更多信息,请参阅“
关于 API 版本控制
”。
REST API
/
Codespaces
Codespaces 的 REST API 端点
使用 REST API 管理 GitHub Codespaces。
Codespaces 的 REST API 端点
列出经过身份验证的用户在存储库中的 Codespaces
在存储库中创建 Codespace
列出经过身份验证的用户在存储库中的 devcontainer 配置
获取 Codespace 的默认属性
检查经过身份验证的用户是否已接受 devcontainer 定义的权限
从拉取请求创建 Codespace
列出经过身份验证用户的 Codespaces
为经过身份验证的用户创建 Codespace
获取经过身份验证用户的 Codespace
更新经过身份验证用户的 Codespace
删除经过身份验证用户的 Codespace
导出经过身份验证用户的 Codespace
获取有关 Codespace 导出的详细信息
从未发布的 Codespace 创建存储库
启动经过身份验证用户的 Codespace
停止经过身份验证用户的 Codespace
Codespaces 机器 的 REST API 端点
列出存储库中可用的机器类型
列出 Codespace 的机器类型
Codespaces 组织机密 的 REST API 端点
列出组织机密
获取组织公钥
获取组织机密
创建或更新组织机密
删除组织机密
列出组织机密所选的存储库
设置组织机密所选的存储库
将所选存储库添加到组织机密
从组织机密中删除所选存储库
Codespaces 组织 的 REST API 端点
列出组织的 Codespaces
管理组织 Codespaces 的访问控制
将用户添加到组织的 Codespaces 访问权限
从组织的 Codespaces 访问权限中删除用户
列出组织中用户的 Codespaces
从组织中删除 Codespace
停止组织用户的 Codespace
Codespaces 仓库密钥的 REST API 端点
列出仓库密钥
获取仓库公钥
获取仓库密钥
创建或更新仓库密钥
删除仓库密钥
Codespaces 用户密钥的 REST API 端点
列出经过身份验证的用户的密钥
获取经过身份验证的用户的公钥
获取经过身份验证的用户的密钥
创建或更新经过身份验证的用户的密钥
删除经过身份验证的用户的密钥
列出用户密钥的选定仓库
设置用户密钥的选定仓库
将选定仓库添加到用户密钥
从用户密钥中删除选定仓库