红帽全球峰会Red Hat Quay API 指南
前言
Red Hat Quay 应用程序编程接口(API)是一个 OAuth 2 RESTful API，它由一组用于添加、显示、更改和删除 Red Hat Quay 功能的端点组成。
Red Hat Quay 禁止 Semantic Versioning (SemVer)规格。每个主版本、次版本和补丁版本都满足以下条件：
- Red Hat Quay 的主版本可能包括不兼容的 API 更改。例如，Red Hat Quay 2.0 的 API 与 Red Hat Quay 3.0 不同。
- Red Hat Quay 的次版本（如 3.y）以向后兼容的方式添加功能。
- Red Hat Quay 的补丁版本（如 3.y.z）引入了向后兼容的程序错误修复。
目前，Red Hat Quay 将 api/v1 端点用于 3.y.z 版本。
本指南描述了 api/v1 端点以及用于访问这些端点的基于浏览器的示例。
第 1 章 使用 Red Hat Quay API
Red Hat Quay 提供了完整的 OAuth 2，RESTful API：
- 可从 URL https://<yourquayhost>/api/v1的每个 Red Hat Quay 实例的端点中找到
- 可让您通过浏览器连接到端点，通过启用 Swagger UI 获取、删除、发布和放置 Red Hat Quay 设置
- 可以被应用访问，这些应用发出 API 调用和使用 OAuth 令牌
- 以 JSON 形式发送和接收数据
以下文本描述了如何访问 Red Hat Quay API，并使用它来查看和修改 Red Hat Quay 集群中的设置。下一部分列出了和描述了 API 端点。
1.1. 从 Quay.io 访问 Quay API
如果您还没有运行自己的 Red Hat Quay 集群，您可以从 Web 浏览器浏览 Quay.io 提供的 Red Hat Quay API：
https://docs.quay.io/api/swagger/
https://docs.quay.io/api/swagger/出现的 API Explorer 显示 Quay.io API 端点。您将看到 Quay.io 上未启用的 Red Hat Quay 功能的超级用户 API 端点或端点（如 Repository Mirroring）。
在 API Explorer 中，您可以获得以下相关信息：
- 账单、订阅和计划
- 存储库构建和构建触发器
- 错误消息和全局消息
- 存储库镜像、清单、权限、通知、漏洞和镜像签名
- 使用日志
- 机构、成员和 OAuth 应用程序
- 用户和机器人帐户
- 更多…
选择以打开端点，以查看端点的每个部分的 Model Schema。打开端点，输入任何所需参数（如存储库名称或镜像），然后选择 Try it out! 按钮来查询或更改与 Quay.io 端点关联的设置。
1.2. 创建 OAuth 访问令牌
OAuth 访问令牌是凭证，允许您以安全的方式访问受保护的资源。使用 Red Hat Quay 时，您必须先创建一个 OAuth 访问令牌，然后才能访问机构的 API 端点。
使用以下步骤创建 OAuth 访问令牌。
先决条件
- 您已以管理员身份登录到 Red Hat Quay。
流程
- 在主页上，选择一个机构。
- 在导航窗格中，选择 Applications。
- 单击 Create New Application 并提供新应用程序名称，然后按 Enter 键。
- 在 OAuth Applications 页面中，选择应用程序的名称。
可选。输入以下信息：
- 应用程序名称
- 主页 URL
- 描述
- avatar E-mail
- redirect/Callback URL 前缀
- 在导航窗格中，选择 Generate Token。
选中以下选项的复选框：
- 管理机构
- 管理软件仓库
- 创建软件仓库
- 查看所有可见的存储库
- 对任何可访问的软件仓库的读/写
- 超级用户访问
- 管理用户
- 读取用户信息
- 单击 Generate Access Token。您将被重定向到新页面。
- 查看您允许的权限，然后点 授权应用程序。点 Authorize Application 确认您的决定。
您将被重定向到 Access Token 页面。复制并保存访问令牌。
重要这是复制并保存访问令牌的唯一机会。在离开此页面后，无法恢复它。
1.3. 从 Web 浏览器访问 Quay API
通过启用 Swagger，您可以通过 Web 浏览器访问您自己的 Red Hat Quay 实例的 API。此 URL 通过 Swagger UI 和这个 URL 公开 Red Hat Quay API explorer：
https://<yourquayhost>/api/v1/discovery.
https://<yourquayhost>/api/v1/discovery.通过这种方式，API 不包括 Red Hat Quay 安装中提供的超级用户端点。以下是通过运行 swagger-ui 容器镜像来访问本地系统中运行的 Red Hat Quay API 接口示例：
export SERVER_HOSTNAME=<yourhostname> sudo podman run -p 8888:8080 -e API_URL=https://$SERVER_HOSTNAME:8443/api/v1/discovery docker.io/swaggerapi/swagger-ui
# export SERVER_HOSTNAME=<yourhostname>
# sudo podman run -p 8888:8080 -e API_URL=https://$SERVER_HOSTNAME:8443/api/v1/discovery docker.io/swaggerapi/swagger-ui在 swagger-ui 容器运行时，打开 Web 浏览器到 localhost 端口 8888，以通过 swagger-ui 容器查看 API 端点。
为了避免日志中出现错误，如 "API 调用，则必须通过浏览器调用 X-Requested-With 标头调用，"在集群的所有节点上添加以下行到 config.yaml 中，并重启 Red Hat Quay：
BROWSER_API_CALLS_XHR_ONLY: false
BROWSER_API_CALLS_XHR_ONLY: false1.4. 从命令行访问 Red Hat Quay API
您可以使用 curl 命令通过 Red Hat Quay 集群的 API 获取 GET、PUT、POST 或 DELETE 设置。将 <token> 替换为您之前创建的 OAuth 访问令牌，以便在以下示例中获取或更改设置。
1.4.1. 获取超级用户信息
curl -X GET -H "Authorization: Bearer <token_here>" \
"https://<yourquayhost>/api/v1/superuser/users/"
$ curl -X GET -H "Authorization: Bearer <token_here>" \
"https://<yourquayhost>/api/v1/superuser/users/"例如：
1.4.2. 使用 API 创建超级用户
配置超级用户名称，如 Deploy Quay 书中所述：
- 使用配置编辑器 UI 或
-
直接编辑
config.yaml文件，使用配置 API 选项验证（并下载）更新的配置捆绑包
为超级用户名称创建用户帐户：
获取上述授权令牌，并使用
curl创建用户：curl -H "Content-Type: application/json" -H "Authorization: Bearer Fava2kV9C92p1eXnMawBZx9vTqVnksvwNm0ckFKZ" -X POST --data '{$ curl -H "Content-Type: application/json" -H "Authorization: Bearer Fava2kV9C92p1eXnMawBZx9vTqVnksvwNm0ckFKZ" -X POST --data '{ "username": "quaysuper", "email": "quaysuper@example.com" }' http://quay-server:8080/api/v1/superuser/users/ | jqCopy to Clipboard Copied! Toggle word wrap Toggle overflow 返回的内容包括为新用户帐户生成的密码：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
现在，当您请求用户列表时，它将以超级用户身份显示 quaysuper ：
1.4.3. 列出使用日志
intrnal API /api/v1/superuser/logs 可用于列出当前系统的使用日志。结果会被分页，在以下示例中，创建了超过 20 个仓库来显示如何使用多个调用来访问整个结果集。
1.4.3.1. 分页示例
第一个调用
curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs | jq
$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs | jq初始输出
第二个调用使用 next_page
curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs?next_page=gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5 | jq
$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs?next_page=gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5 | jq第二个调用的输出
1.4.4. 目录同步
要为机构 testadminorg 中的团队 newteam 启用目录同步，LDAP 中的对应组名称是 ldapgroup ：
curl -X POST -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
-H "Content-type: application/json" \
-d '{"group_dn": "cn=ldapgroup,ou=Users"}' \
http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing
$ curl -X POST -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
-H "Content-type: application/json" \
-d '{"group_dn": "cn=ldapgroup,ou=Users"}' \
http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing为同一团队禁用同步：
curl -X DELETE -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing
$ curl -X DELETE -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing1.4.5. 通过 API 创建存储库构建
要从指定的输入构建存储库并使用自定义标签标记构建，用户可以使用 requestRepoBuild 端点。它获取以下数据：
archive_url 参数应指向一个 tar 或 zip 存档，其中包括 Dockerfile 和其他构建所需的文件。file_id 参数是我们较旧的构建系统的一部分。它无法再使用。如果 Dockerfile 位于子目录中，则需要指定它。
该存档应该可以公开访问。OAuth 应用应具有 "Administer Organization" 范围，因为只有机构管理员有权访问机器人的帐户令牌。否则，某人可以通过仅授予机器人（无权访问自身）来获取机器人的权限，并使用它来获取镜像内容。如果出现错误，请检查 json 块返回，并确保正确传递存档位置、拉取机器的机器和其他参数。点单个构建页面右上角的"下载日志"检查日志以获得更详细的信息。
1.4.6. 创建机构机器人
curl -X PUT https://quay.io/api/v1/organization/{orgname}/robots/{robot shortname} \
-H 'Authorization: Bearer <token>''
$ curl -X PUT https://quay.io/api/v1/organization/{orgname}/robots/{robot shortname} \
-H 'Authorization: Bearer <token>''1.4.7. 触发构建
curl -X POST https://quay.io/api/v1/repository/YOURORGNAME/YOURREPONAME/build/ \ -H 'Authorization: Bearer <token>'
$ curl -X POST https://quay.io/api/v1/repository/YOURORGNAME/YOURREPONAME/build/ \
-H 'Authorization: Bearer <token>'带有请求的 Python
import requests
r = requests.post('https://quay.io/api/v1/repository/example/example/image', headers={'content-type': 'application/json', 'Authorization': 'Bearer <redacted>'}, data={[<request-body-contents>})
print(r.text)
import requests
r = requests.post('https://quay.io/api/v1/repository/example/example/image', headers={'content-type': 'application/json', 'Authorization': 'Bearer <redacted>'}, data={[<request-body-contents>})
print(r.text)1.4.8. 创建私有软件仓库
curl -X POST https://quay.io/api/v1/repository \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"namespace":"yournamespace", "repository":"yourreponame",
$ curl -X POST https://quay.io/api/v1/repository \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"namespace":"yournamespace", "repository":"yourreponame",
"description":"descriptionofyourrepo", "visibility": "private"}' | jq1.4.9. 创建已镜像的存储库
最小配置
curl -X POST
-H "Authorization: Bearer ${bearer_token}"
-H "Content-Type: application/json"
--data '{"external_reference": "quay.io/minio/mc", "external_registry_username": "", "sync_interval": 600, "sync_start_date": "2021-08-06T11:11:39Z", "root_rule": {"rule_kind": "tag_glob_csv", "rule_value": [ "latest" ]}, "robot_username": "orga+robot"}' https://${quay_registry}/api/v1/repository/${orga}/${repo}/mirror | jq
curl -X POST
-H "Authorization: Bearer ${bearer_token}"
-H "Content-Type: application/json"
--data '{"external_reference": "quay.io/minio/mc", "external_registry_username": "", "sync_interval": 600, "sync_start_date": "2021-08-06T11:11:39Z", "root_rule": {"rule_kind": "tag_glob_csv", "rule_value": [ "latest" ]}, "robot_username": "orga+robot"}' https://${quay_registry}/api/v1/repository/${orga}/${repo}/mirror | jq扩展的配置
curl -X POST
$ curl -X POST
-H "Authorization: Bearer ${bearer_token}"
-H "Content-Type: application/json"
--data '{"is_enabled": true, "external_reference": "quay.io/minio/mc", "external_registry_username": "username", "external_registry_password": "password", "external_registry_config": {"unsigned_images":true, "verify_tls": false, "proxy": {"http_proxy": "http://proxy.tld", "https_proxy": "https://proxy.tld", "no_proxy": "domain"}}, "sync_interval": 600, "sync_start_date": "2021-08-06T11:11:39Z", "root_rule": {"rule_kind": "tag_glob_csv", "rule_value": [ "*" ]}, "robot_username": "orga+robot"}' https://${quay_registry}/api/v1/repository/${orga}/${repo}/mirror | jq此 API 允许您执行处理 Red Hat Quay 存储库、用户和机构所需的许多操作。
2.1. 授权
oauth2_implicit
范围
以下范围用于控制对 API 端点的访问：
| 影响范围 | 描述 |
|---|---|
| repo:read | 此应用能够查看和拉取对授予用户或机器人帐户可见的所有存储库 |
| repo:write | 此应用能够查看、推送和拉取到授予用户或机器人帐户具有写入访问权限的所有存储库 |
| repo:admin | 此应用将具有授予用户或机器人帐户具有访问权限的所有存储库的管理员访问权限 |
| repo:create | 此应用能够在 中创建存储库到任何允许授予用户或机器人帐户创建存储库的命名空间 |
| user:read | 此应用程序将能够读取用户信息，如用户名和电子邮件地址。 |
| org:admin | 此应用程序将能够管理您的组织，包括创建机器人、创建团队、调整团队成员资格和更改计费设置。在授予此权限前，您应该在请求的应用程序中具有绝对信任。 |
| super:user | 此应用程序将能够管理您的安装，包括管理用户、管理机构和其他在超级用户面板中的功能。在授予此权限前，您应该在请求的应用程序中具有绝对信任。 |
| user:admin | 此应用程序将能够管理您的帐户，包括创建机器人，并将它们授予您的存储库的权限。在授予此权限前，您应该在请求的应用程序中具有绝对信任。 |
2.2. appspecifictokens
管理当前用户的特定于应用的令牌。
2.2.1. createAppToken
为用户创建新应用特定令牌。
POST /api/v1/user/apptoken
授权： oauth2_implicit (user:admin)
请求正文模式(application/json)
新令牌的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
标题 | 有助于识别令牌的友好名称 | 字符串 |
响应
2.2.2. listAppTokens
列出用户的特定应用令牌。
GET /api/v1/user/apptoken
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
过期 | 如果为 true，则只返回这些令牌过期 | 布尔值 |
响应
2.2.3. getAppToken
返回用户的特定应用令牌。
GET /api/v1/user/apptoken/{token_uuid}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
token_uuid | 特定于应用程序的 uuid | 字符串 |
响应
2.2.4. revokeAppToken
为用户撤销特定的应用令牌。
DELETE /api/v1/user/apptoken/{token_uuid}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
token_uuid | 特定于应用程序的 uuid | 字符串 |
响应
2.3. build
创建、列出、取消和获取存储库构建的 status/logs。
2.3.1. getRepoBuildStatus
返回由 build uuids 指定的构建的状态。
GET /api/v1/repository/{repository}/build/{build_uuid}/status
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
2.3.2. getRepoBuildLogs
返回由 build uuid 指定的构建的构建日志。
GET /api/v1/repository/{repository}/build/{build_uuid}/logs
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
2.3.3. getRepoBuild
返回有关构建的信息。
GET /api/v1/repository/{repository}/build/{build_uuid}
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
2.3.4. cancelRepoBuild
取消存储库构建。
DELETE /api/v1/repository/{repository}/build/{build_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
2.3.5. requestRepoBuild
请求构建存储库并从指定的输入推送。
POST /api/v1/repository/{repository}/build/
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
新存储库构建的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
file_id | 上传构建 spec 时生成的文件 ID | 字符串 |
|
archive_url | 要构建的 .tar.gz 的 URL。必须以 "http" 或 "https" 开头。 | 字符串 |
|
子目录 | 可在其中找到 Dockerfile 的子目录。您只能指定这个或 dockerfile_path | 字符串 |
|
dockerfile_path | 到 dockerfile 的路径。您只能指定此或子目录。 | 字符串 |
|
上下文 | 传递 dockerfile 的上下文。这是可选的。 | 字符串 |
|
pull_robot | 用作拉取凭证的 Quay 机器人帐户的用户名 | string |
|
标签 | 构建的镜像要推送到的标签。如果没有指定，则使用 "latest"。 |
string 数组 |
响应
2.3.6. getRepoBuilds
获取存储库构建列表。
GET /api/v1/repository/{repository}/build/
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
从 | 返回自给定的 unix 时间码后的所有构建 | 整数 |
| query |
限制 | 要返回的最大构建数 | 整数 |
响应
2.4. discovery
API 发现信息。
2.4.1. discovery
列出 swagger API 格式提供的所有 API 端点。
GET /api/v1/discovery
授权：
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
内部 | 是否包含内部 API。 | 布尔值 |
响应
2.5. 错误
错误详情 API。
2.5.1. getErrorDescription
获取错误的详细描述。
GET /api/v1/error/{error_type}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
error_type | 标识错误类型的错误代码。 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.6. globalmessages
消息 API.
2.6.1. createGlobalMessage
创建消息。
POST /api/v1/messages
授权： oauth2_implicit (超级：user)
请求正文模式(application/json)
创建新消息
| 名称 | 描述 | 模式 |
|---|---|---|
|
message | 单个消息 | 对象 |
响应
2.6.2. getGlobalMessages
返回超级用户消息。
GET /api/v1/messages
授权：
响应
2.6.3. deleteGlobalMessage
删除消息。
DELETE /api/v1/message/{uuid}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
UUID | 字符串 |
响应
2.7. logs
访问机构或存储库的使用情况日志。
2.7.1. getAggregateUserLogs
返回当前用户的聚合日志。
GET /api/v1/user/aggregatelogs
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
执行 | 过滤日志的用户名。 | 字符串 |
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.7.2. exportUserLogs
返回当前用户的聚合日志。
POST /api/v1/user/exportlogs
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
请求正文模式(application/json)
配置导出日志操作
| 名称 | 描述 | 模式 |
|---|---|---|
|
callback_url | 使用到导出日志的链接调用的回调 URL | 字符串 |
|
callback_email | 通过电子邮件发送到导出日志的链接的电子邮件地址 | 字符串 |
响应
2.7.3. listUserLogs
列出当前用户的日志。
GET /api/v1/user/logs
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页面的页面令牌 | 字符串 |
| query |
执行 | 过滤日志的用户名。 | 字符串 |
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.7.4. getAggregateOrgLogs
获取指定机构的聚合日志。
GET /api/v1/organization/{orgname}/aggregatelogs
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
执行 | 过滤日志的用户名。 | 字符串 |
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.7.5. exportOrgLogs
导出指定机构的日志。
POST /api/v1/organization/{orgname}/exportlogs
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
请求正文模式(application/json)
配置导出日志操作
| 名称 | 描述 | 模式 |
|---|---|---|
|
callback_url | 使用到导出日志的链接调用的回调 URL | 字符串 |
|
callback_email | 通过电子邮件发送到导出日志的链接的电子邮件地址 | 字符串 |
响应
2.7.6. listOrgLogs
列出指定机构的日志。
GET /api/v1/organization/{orgname}/logs
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页面的页面令牌 | 字符串 |
| query |
执行 | 过滤日志的用户名。 | 字符串 |
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.7.7. getAggregateRepoLogs
返回指定存储库的聚合日志。
GET /api/v1/repository/{repository}/aggregatelogs
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.7.8. exportRepoLogs
对指定存储库的日志导出排队。
POST /api/v1/repository/{repository}/exportlogs
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
请求正文模式(application/json)
配置导出日志操作
| 名称 | 描述 | 模式 |
|---|---|---|
|
callback_url | 使用到导出日志的链接调用的回调 URL | 字符串 |
|
callback_email | 通过电子邮件发送到导出日志的链接的电子邮件地址 | 字符串 |
响应
2.7.9. listRepoLogs
列出指定存储库的日志。
GET /api/v1/repository/{repository}/logs
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页面的页面令牌 | 字符串 |
| query |
ENDTIME | 日志的最新时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
| query |
startTime | 日志的最早时间。格式： UTC 为 "%m/%d/%Y"。 | 字符串 |
响应
2.8. 清单(Inventory)
管理存储库的清单。
2.8.1. getManifestLabel
使用清单下特定 ID 检索标签。
GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | 字符串 |
| path |
labelid | 标签的 ID | string |
响应
2.8.2. deleteManifestLabel
从清单中删除现有标签。
DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | 字符串 |
| path |
labelid | 标签的 ID | string |
响应
2.8.3. addManifestLabel
将新标签添加到标签清单中。
POST /api/v1/repository/{repository}/manifest/{manifestref}/labels
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | string |
请求正文模式(application/json)
为清单添加标签
| 名称 | 描述 | 模式 |
|---|---|---|
|
key | 标签的密钥 | string |
|
需要 的值 | 标签的值 | string |
|
media_type | 此标签的介质类型 |
响应
2.8.4. listManifestLabels
GET /api/v1/repository/{repository}/manifest/{manifestref}/labels
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | string |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
过滤 | 如果指定，则仅返回与给定前缀匹配的标签 | 字符串 |
响应
2.8.5. getRepoManifest
GET /api/v1/repository/{repository}/manifest/{manifestref}
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | string |
响应
2.9. mirror
2.9.1. syncCancel
为给定 Repository 的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-cancel
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.9.2. syncNow
为给定 Repository 的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-now
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.9.3. getRepoMirrorConfig
返回一个给定存储库的 Mirror 配置。
GET /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.9.4. changeRepoMirrorConfig
允许用户修改存储库的镜像配置。
PUT /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更新存储库镜像配置。
| 名称 | 描述 | 模式 |
|---|---|---|
|
is_enabled | 用于启用或禁用同步。 | 布尔值 |
|
external_reference | 外部存储库的位置。 | 字符串 |
|
external_registry_username | 用于与外部 registry 进行身份验证的用户名。 | |
|
external_registry_password | 用于与外部 registry 进行身份验证的密码。 | |
|
sync_start_date | 决定此存储库下次准备同步的时间。 | 字符串 |
|
sync_interval | next_start_date 开始同步后的秒数。 | 整数 |
|
robot_username | 用于镜像推送的机器人的用户名。 | 字符串 |
|
root_rule | 用于决定应同步哪些标签的 glob-patterns 列表。 | 对象 |
|
external_registry_config | 对象 |
响应
2.9.5. createRepoMirrorConfig
为给定存储库创建一个 RepoMirrorConfig。
POST /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
创建存储库镜像配置。
| 名称 | 描述 | 模式 |
|---|---|---|
|
is_enabled | 用于启用或禁用同步。 | 布尔值 |
|
external_reference | 外部存储库的位置。 | 字符串 |
|
external_registry_username | 用于与外部 registry 进行身份验证的用户名。 | |
|
external_registry_password | 用于与外部 registry 进行身份验证的密码。 | |
|
sync_start_date | 决定此存储库下次准备同步的时间。 | 字符串 |
|
sync_interval | next_start_date 开始同步后的秒数。 | 整数 |
|
robot_username | 用于镜像推送的机器人的用户名。 | 字符串 |
|
root_rule | 用于决定应同步哪些标签的 glob-patterns 列表。 | 对象 |
|
external_registry_config | 对象 |
响应
2.10. namespacequota
2.10.1. listUserQuota
GET /api/v1/user/quota
授权： oauth2_implicit (user:admin)
响应
2.10.2. getOrganizationQuotaLimit
GET /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
limit_id | 字符串 | |
| path |
需要OrgName | 字符串 |
响应
2.10.3. changeOrganizationQuotaLimit
PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
limit_id | 字符串 | |
| path |
需要OrgName | 字符串 |
请求正文模式(application/json)
更改机构配额限制的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
type | 配额限制类型："Warning"或"Reject" | 字符串 |
|
threshold_percent | 配额阈值，以百分比为单位 | 整数 |
响应
2.10.4. deleteOrganizationQuotaLimit
DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
limit_id | 字符串 | |
| path |
需要OrgName | 字符串 |
响应
2.10.5. createOrganizationQuotaLimit
POST /api/v1/organization/{orgname}/quota/{quota_id}/limit
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
需要OrgName | 字符串 |
请求正文模式(application/json)
新机构配额限制的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
type | 配额限制类型："Warning"或"Reject" | string |
|
threshold_percent | 配额阈值，以百分比为单位 | 整数 |
响应
2.10.6. listOrganizationQuotaLimit
GET /api/v1/organization/{orgname}/quota/{quota_id}/limit
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
需要OrgName | 字符串 |
响应
2.10.7. getUserQuotaLimit
GET /api/v1/user/quota/{quota_id}/limit/{limit_id}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
limit_id | 字符串 |
响应
2.10.8. listUserQuotaLimit
GET /api/v1/user/quota/{quota_id}/limit
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 |
响应
2.10.9. getOrganizationQuota
GET /api/v1/organization/{orgname}/quota/{quota_id}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
需要OrgName | 字符串 |
响应
2.10.10. changeOrganizationQuota
PUT /api/v1/organization/{orgname}/quota/{quota_id}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
需要OrgName | 字符串 |
请求正文模式(application/json)
新机构配额的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
2.10.11. deleteOrganizationQuota
DELETE /api/v1/organization/{orgname}/quota/{quota_id}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 | |
| path |
OrgName | 字符串 |
响应
2.10.12. createOrganizationQuota
创建新的机构配额。
POST /api/v1/organization/{orgname}/quota
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 字符串 |
请求正文架构(application/json)
新机构配额的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
2.10.13. listOrganizationQuota
GET /api/v1/organization/{orgname}/quota
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 字符串 |
响应
2.10.14. getUserQuota
GET /api/v1/user/quota/{quota_id}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
quota_id | 字符串 |
响应
2.11. 机构
管理机构、成员和 OAuth 应用。
2.11.1. createOrganization
创建新机构。
POST /api/v1/organization/
授权： oauth2_implicit (user:admin)
请求正文模式(application/json)
新组织的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 机构用户名 | 字符串 |
|
email | 机构联系电子邮件 | 字符串 |
|
recaptcha_response | （可以禁用）recaptcha 响应代码进行验证 | 字符串 |
响应
2.11.2. validateProxyCacheConfig
POST /api/v1/organization/{orgname}/validateproxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 字符串 |
请求正文模式(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
2.11.3. getOrganizationCollaborators
列出指定机构的外部协作者。
GET /api/v1/organization/{orgname}/collaborators
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.4. getOrganizationApplication
使用指定组织下的指定 client_id 检索应用。
GET /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.5. updateOrganizationApplication
更新此机构下的应用程序。
PUT /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
更新的应用程序的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用程序的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 电子邮件地址 | 字符串 |
响应
2.11.6. deleteOrganizationApplication
删除此机构下的应用程序。
DELETE /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.7. createOrganizationApplication
在此组织下创建新应用。
POST /api/v1/organization/{orgname}/applications
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
新组织应用的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用程序的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 电子邮件地址 | 字符串 |
响应
2.11.8. getOrganizationApplications
列出指定机构的应用程序。
GET /api/v1/organization/{orgname}/applications
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.9. getProxyCacheConfig
检索组织的代理缓存配置。
GET /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.10. deleteProxyCacheConfig
删除机构的代理缓存配置。
DELETE /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.11. createProxyCacheConfig
为机构创建代理缓存配置。
POST /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
2.11.12. getOrganizationMember
检索组织成员的详细信息。
GET /api/v1/organization/{orgname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 memberName | 机构成员的用户名 | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.13. removeOrganizationMember
从机构中删除成员，撤销其所有存储库的权限，并将其从机构中的所有团队中删除。
DELETE /api/v1/organization/{orgname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 memberName | 机构成员的用户名 | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.14. getOrganizationMembers
列出指定机构的人员。
GET /api/v1/organization/{orgname}/members
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.15. getOrganization
获取指定机构的详细信息。
GET /api/v1/organization/{orgname}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.16. changeOrganizationDetails
更改指定机构的详情。
PUT /api/v1/organization/{orgname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
现有机构的更新描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
email | 机构联系电子邮件 | 字符串 |
|
invoice_email | 机构是否希望接收发票的电子邮件 | 布尔值 |
|
invoice_email_address | 要接收发票的电子邮件地址 | |
|
tag_expiration_s | 标签过期的秒数 | 整数 |
响应
2.11.17. deleteAdminedOrganization
删除指定的机构。
DELETE /api/v1/organization/{orgname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.11.18. getApplicationInformation
获取指定应用程序的信息。
GET /api/v1/app/{client_id}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
响应
2.12. 权限
管理存储库权限。
2.12.1. getUserTransitivePermission
获取指定用户的获取权限。
GET /api/v1/repository/{repository}/permissions/user/{username}/transitive
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 的用户名 | 权限应用到的用户的用户名 | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.12.2. getUserPermissions
获取指定用户的权限。
GET /api/v1/repository/{repository}/permissions/user/{username}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 的用户名 | 权限应用到的用户的用户名 | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.12.3. changeUserPermissions
更新现有仓库的 perimsions。
PUT /api/v1/repository/{repository}/permissions/user/{username}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 的用户名 | 权限应用到的用户的用户名 | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
用户权限的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 角色 | 用户使用的角色 | 字符串 |
响应
2.12.4. deleteUserPermissions
删除用户权限。
DELETE /api/v1/repository/{repository}/permissions/user/{username}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 的用户名 | 权限应用到的用户的用户名 | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.12.5. getTeamPermissions
获取指定团队的权限。
GET /api/v1/repository/{repository}/permissions/team/{teamname}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
TeamName | 权限应用到的团队的名称 | string |
响应
2.12.6. changeTeamPermissions
更新现有团队权限。
PUT /api/v1/repository/{repository}/permissions/team/{teamname}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
TeamName | 权限应用到的团队的名称 | string |
请求正文模式(application/json)
团队权限的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 角色 | 用于团队的角色 | 字符串 |
响应
2.12.7. deleteTeamPermissions
删除指定团队的权限。
DELETE /api/v1/repository/{repository}/permissions/team/{teamname}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
TeamName | 权限应用到的团队的名称 | string |
响应
2.12.8. listRepoTeamPermissions
列出所有团队权限。
GET /api/v1/repository/{repository}/permissions/team/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.12.9. listRepoUserPermissions
列出所有用户权限。
GET /api/v1/repository/{repository}/permissions/user/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.13. policy
2.13.1. createOrganizationAutoPrunePolicy
为机构创建一个自动修剪策略
POST /api/v1/organization/{orgname}/autoprunepolicy/
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
所需 方法 | 用于修剪标签的方法(number_of_tags、create_date) | string |
|
需要 的值 | 用于修剪方法的值（标签数量（如 10 个，时间 delta，如 7d (7 天)） |
响应
2.13.2. listOrganizationAutoPrunePolicies
列出机构的自动修剪策略
GET /api/v1/organization/{orgname}/autoprunepolicy/
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.13.3. getOrganizationAutoPrunePolicy
获取机构的自动修剪策略
GET /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.13.4. deleteOrganizationAutoPrunePolicy
删除机构的自动修剪策略
DELETE /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.13.5. updateOrganizationAutoPrunePolicy
更新机构的自动修剪策略
PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要OrgName | 机构名称 | 字符串 |
| path |
policy_uuid | 策略的唯一 ID | string |
请求正文模式(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
所需 方法 | 用于修剪标签的方法(number_of_tags、create_date) | string |
|
需要 的值 | 用于修剪方法的值（标签数量（如 10 个，时间 delta，如 7d (7 天)） |
响应
2.13.6. createRepositoryAutoPrunePolicy
为存储库创建一个自动修剪策略
POST /api/v1/repository/{repository}/autoprunepolicy/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
方法 | 用于修剪标签的方法(number_of_tags、create_date) | string |
|
value | 用于修剪方法的值（标签数量（如 10 个，时间 delta，如 7d (7 天)） |
响应
2.13.7. listRepositoryAutoPrunePolicies
列出存储库的自动修剪策略
GET /api/v1/repository/{repository}/autoprunepolicy/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.13.8. getRepositoryAutoPrunePolicy
获取存储库的自动修剪策略
GET /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.13.9. deleteRepositoryAutoPrunePolicy
删除存储库的自动修剪策略
DELETE /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.13.10. updateRepositoryAutoPrunePolicy
更新存储库的自动修剪策略
PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
方法 | 用于修剪标签的方法(number_of_tags、create_date) | string |
|
value | 用于修剪方法的值（标签数量（如 10 个，时间 delta，如 7d (7 天)） |
响应
2.13.11. createUserAutoPrunePolicy
为当前登录的用户创建自动修剪策略
POST /api/v1/user/autoprunepolicy/
授权： oauth2_implicit (user:admin)
请求正文模式(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
所需 方法 | 用于修剪标签的方法(number_of_tags、create_date) | string |
|
需要 的值 | 用于修剪方法的值（标签数量（如 10 个，时间 delta，如 7d (7 天)） |
响应
2.13.12. listUserAutoPrunePolicies
列出当前登录用户的自动修剪策略
GET /api/v1/user/autoprunepolicy/
授权： oauth2_implicit (user:admin)
响应
2.13.13. getUserAutoPrunePolicy
获取当前登录用户的自动修剪策略
GET /api/v1/user/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
响应
2.13.14. deleteUserAutoPrunePolicy
删除当前登录的用户的自动修剪策略
DELETE /api/v1/user/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
响应
2.13.15. updateUserAutoPrunePolicy
为当前登录的用户更新自动修剪策略
PUT /api/v1/user/autoprunepolicy/{policy_uuid}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
policy_uuid | 策略的唯一 ID | string |
请求正文架构(application/json)
要应用到用户命名空间的策略配置
| Name | 描述 | 模式 |
|---|---|---|
|
方法 | 用于修剪标签的方法(number_of_tags、creation_date) | string |
|
| 用于修剪方法的值（标签数，如 10, time delta，如 7d (7 天)） |
响应
2.14. prototype
管理添加到存储库的默认权限。
2.14.1. updateOrganizationPrototypePermission
更新现有权限原型的角色。
PUT /api/v1/organization/{orgname}/prototypes/{prototypeid}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要原型 | 原型的 ID | string |
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
新原型角色的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
角色 | 应该应用到权限的角色 | 字符串 |
响应
2.14.2. deleteOrganizationPrototypePermission
删除现有的权限原型。
DELETE /api/v1/organization/{orgname}/prototypes/{prototypeid}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要原型 | 原型的 ID | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.14.3. createOrganizationPrototypePermission
创建新的权限原型。
POST /api/v1/organization/{orgname}/prototypes
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
新原型的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 角色 | 应该应用到委派的角色 | 字符串 |
|
activating_user | 创建规则应应用到的用户的存储库 | object |
|
需要 委托 | 规则授予访问权限的用户或团队的信息 | 对象 |
响应
2.14.4. getOrganizationPrototypePermissions
列出此组织的现有原型。
GET /api/v1/organization/{orgname}/prototypes
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.15. 软件仓库
列出、创建和管理存储库。
2.15.1. createRepo
创建新存储库。
POST /api/v1/repository
授权： oauth2_implicit (repo:create)
请求正文架构(application/json)
新存储库的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 仓库 | 仓库名称 | string |
|
所需 可见性 | 可见性存储库将以什么开头 | 字符串 |
|
namespace | 应该在其中创建存储库的命名空间。如果省略，则使用调用者的用户名 | string |
|
描述 | 用于仓库的 Markdown 编码描述 | 字符串 |
|
repo_kind | 仓库的类型 |
响应
2.15.2. listRepos
在各种情况下，获取当前用户对当前用户可见的存储库列表。
GET /api/v1/repository
授权： oauth2_implicit (存储库：read)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页面的页面令牌 | 字符串 |
| query |
repo_kind | 要返回的仓库类型 | 字符串 |
| query |
popularity | 是否包含存储库的流行度指标。 | 布尔值 |
| query |
last_modified | 是否包含存储库最后一次修改的时间。 | 布尔值 |
| query |
public | 通过 virtue public 来添加用户可见的任何软件仓库 | 布尔值 |
| query |
starred | 过滤用户返回到这些存储库的存储库 | 布尔值 |
| query |
namespace | 过滤返回到此命名空间的存储库 | 字符串 |
响应
2.15.3. changeRepoVisibility
更改存储库的可见性。
POST /api/v1/repository/{repository}/changevisibility
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的可见性。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 可见性 | 存储库开始的可见性 | 字符串 |
响应
2.15.4. changeRepoState
更改存储库的状态。
PUT /api/v1/repository/{repository}/changestate
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更改存储库的状态。
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 状态 | 确定是否允许推送。 | 字符串 |
响应
2.15.5. getRepo
获取指定的存储库。
GET /api/v1/repository/{repository}
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
IncludeTags | 是否包含存储库标签 | 布尔值 |
| query |
includeStats | 是否包含操作统计信息 | 布尔值 |
响应
2.15.6. updateRepo
更新指定存储库中的描述。
PUT /api/v1/repository/{repository}
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
可以在存储库中更新的字段。
| 名称 | 描述 | 模式 |
|---|---|---|
|
描述 | Markdown 编码的仓库描述 | 字符串 |
响应
2.15.7. deleteRepository
删除存储库。
DELETE /api/v1/repository/{repository}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.16. repositorynotification
列出、创建和管理存储库事件/通知。
2.16.1. testRepoNotification
将测试通知排队此存储库。
POST /api/v1/repository/{repository}/notification/{uuid}/test
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
UUID | 通知的 UUID | string |
响应
2.16.2. getRepoNotification
获取指定通知的信息。
GET /api/v1/repository/{repository}/notification/{uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
UUID | 通知的 UUID | string |
响应
2.16.3. deleteRepoNotification
删除指定的通知。
DELETE /api/v1/repository/{repository}/notification/{uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
UUID | 通知的 UUID | string |
响应
2.16.4. resetRepositoryNotificationFailures
将存储库通知重置为 0 个失败。
POST /api/v1/repository/{repository}/notification/{uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
UUID | 通知的 UUID | string |
响应
2.16.5. createRepoNotification
POST /api/v1/repository/{repository}/notification/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
在仓库中创建通知的信息
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 事件 | 通知将响应的事件 | string |
|
所需 方法 | 通知方法（如电子邮件或 Web 回调） | string |
|
需要配置 | 特定通知方法的 JSON 配置信息 | object |
|
eventConfig | 特定通知事件的 JSON 配置信息 | 对象 |
|
title | 通知的人类可读标题 | 字符串 |
响应
2.16.6. listRepoNotifications
列出指定存储库的通知。
GET /api/v1/repository/{repository}/notification/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.17. repotoken
管理存储库访问令牌(DEPRECATED)。
2.17.1. getTokens
获取指定的存储库令牌信息。
GET /api/v1/repository/{repository}/tokens/{code}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 代码 | 令牌代码 | 字符串 |
响应
2.17.2. changeToken
更新指定存储库令牌的权限。
PUT /api/v1/repository/{repository}/tokens/{code}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 代码 | 令牌代码 | 字符串 |
请求正文模式(application/json)
令牌权限的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
角色 | 用于令牌的角色 | 字符串 |
响应
2.17.3. deleteToken
删除存储库令牌。
DELETE /api/v1/repository/{repository}/tokens/{code}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 代码 | 令牌代码 | 字符串 |
响应
2.17.4. createToken
创建新存储库令牌。
POST /api/v1/repository/{repository}/tokens/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
新令牌的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
friendlyName | 有助于识别令牌的友好名称 | 字符串 |
响应
2.17.5. listRepoTokens
列出指定存储库的令牌。
GET /api/v1/repository/{repository}/tokens/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
2.18. 机器人
管理用户和组织机器人帐户。
2.18.1. getUserRobots
列出该用户的可用机器人。
GET /api/v1/user/robots
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
限制 | 如果指定，则要返回的机器人数。 | 整数 |
| query |
令牌 | 如果为 false，则不会返回机器人的令牌。 | 布尔值 |
| query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
2.18.2. getOrgRobotPermissions
返回组织机器人的存储库权限列表。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.18.3. regenerateOrgRobotToken
为机构机器人重新生成令牌。
POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
需要OrgName | 机构名称 | 字符串 |
响应
2.18.4. getUserRobotPermissions
返回用户机器人的存储库权限列表。
GET /api/v1/user/robots/{robot_shortname}/permissions
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
2.18.5. regenerateUserRobotToken
为用户的机器人重新生成令牌。
POST /api/v1/user/robots/{robot_shortname}/regenerate
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
2.18.6. getOrgRobot
使用指定名称返回机构的机器人。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.18.7. createOrgRobot
在组织中创建一个新的机器人。
PUT /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
创建机器人的可选数据
| 名称 | 描述 | 模式 |
|---|---|---|
|
description | 机器人的可选文本描述 | 字符串 |
|
unstructured_metadata | 机器人的可选非结构元数据 | 对象 |
响应
2.18.8. deleteOrgRobot
删除现有的机构机器人。
DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.18.9. getOrgRobots
列出机构的机器人。
GET /api/v1/organization/{orgname}/robots
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
限制 | 如果指定，要返回的机器人数。 | 整数 |
| query |
令牌 | 如果为 false，则不会返回机器人的令牌。 | 布尔值 |
| query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
2.18.10. getUserRobot
使用指定名称返回用户的机器人。
GET /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
2.18.11. createUserRobot
使用指定名称创建新用户 robot。
PUT /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
请求正文架构(application/json)
创建机器人的可选数据
| 名称 | 描述 | 模式 |
|---|---|---|
|
description | 机器人的可选文本描述 | 字符串 |
|
unstructured_metadata | 机器人的可选非结构元数据 | 对象 |
响应
2.18.12. deleteUserRobot
删除现有的机器人。
DELETE /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
2.19. search
对所有 registry 上下文执行搜索。
2.19.1. conductRepoSearch
获取与指定查询匹配的应用程序和存储库列表。
GET /api/v1/find/repositories
授权：
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
includeUsage | 是否包含使用元数据 | 布尔值 |
| query |
页 | 该页面。 | 整数 |
| query |
query | 搜索查询。 | 字符串 |
响应
2.19.2. conductSearch
获取与指定查询匹配的实体和资源列表。
GET /api/v1/find/all
授权： oauth2_implicit (repo:read)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
query | 搜索查询。 | 字符串 |
响应
2.19.3. getMatchingEntities
获取与指定前缀匹配的实体列表。
GET /api/v1/entities/{prefix}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
所需 前缀 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
includeOrgs | 是否包含机构名称。 | 布尔值 |
| query |
includeTeams | 是否包含团队名称。 | 布尔值 |
| query |
namespace | 在查询机构实体时要使用的命名空间。 | 字符串 |
响应
2.20. secscan
列出和管理存储库漏洞和其他安全信息。
2.20.1. getRepoManifestSecurity
GET /api/v1/repository/{repository}/manifest/{manifestref}/security
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
manifestref | 清单摘要 | string |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
漏洞 | 包括漏洞信息 | 布尔值 |
响应
2.21. 超级用户
超级用户 API。
2.21.1. createInstallUser
创建新用户。
POST /api/v1/superuser/users/
授权： oauth2_implicit (超级：user)
请求正文模式(application/json)
创建用户的数据
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要 用户名 | 正在创建的用户的用户名 | 字符串 |
|
email | 正在创建的用户的电子邮件地址 | 字符串 |
响应
2.21.2. listAllUsers
返回系统中所有用户的列表。
GET /api/v1/superuser/users/
授权： oauth2_implicit (super:user)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页的页面令牌 | 字符串 |
| query |
限制 | 限制为每个页面要返回的结果数。最大 100。 | 整数 |
| query |
禁用 | 如果为 false，则仅返回启用的用户。 | 布尔值 |
响应
2.21.3. listAllLogs
列出当前系统的使用情况日志。
GET /api/v1/superuser/logs
授权： oauth2_implicit (super:user)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页的页面令牌 | 字符串 |
| query |
页 | 日志的页面号 | 整数 |
| query |
ENDTIME | 获取日志的最新时间(%m/%d/%Y %Z) | 字符串 |
| query |
startTime | 从中获取日志的最早时间(%m/%d/%Y %Z) | 字符串 |
响应
部分 I. listAllOrganizations
列出当前系统的机构。
GET /api/v1/superuser/organizations
授权： oauth2_implicit (super:user)
查询参数
| 类型 | 名称 | 描述 | 模式 |
|---|---|---|---|
| path |
name | 受管机构的名称 | 字符串 |
响应
示例命令
curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"1. createServiceKey
POST /api/v1/superuser/keys
授权： oauth2_implicit (super:user)
请求正文架构(application/json)
创建服务密钥的描述
| Name | 描述 | 模式 |
|---|---|---|
|
服务 | 使用此密钥进行身份验证的服务 | string |
|
name | 服务键的友好名称 | string |
|
元数据 | 此键元数据的键/值对 | 对象 |
|
notes | 如果指定，密钥的额外备注 | 字符串 |
|
过期 | 过期日期作为 unix 时间戳 |
响应
2. listServiceKeys
GET /api/v1/superuser/keys
授权： oauth2_implicit (super:user)
响应
3. changeUserQuotaSuperUser
PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 | |
| path |
quota_id | 字符串 |
请求正文架构(application/json)
新机构配额的描述
| Name | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
4. deleteUserQuotaSuperUser
DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 | |
| path |
quota_id | 字符串 |
响应
5. createUserQuotaSuperUser
POST /api/v1/superuser/organization/{namespace}/quota
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 |
请求正文架构(application/json)
新机构配额的描述
| Name | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
6. listUserQuotaSuperUser
GET /api/v1/superuser/organization/{namespace}/quota
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 |
响应
7. changeOrganizationQuotaSuperUser
PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 | |
| path |
quota_id | 字符串 |
请求正文架构(application/json)
新机构配额的描述
| Name | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
8. deleteOrganizationQuotaSuperUser
DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 | |
| path |
quota_id | 字符串 |
响应
9. createOrganizationQuotaSuperUser
POST /api/v1/superuser/users/{namespace}/quota
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 |
请求正文架构(application/json)
新机构配额的描述
| Name | 描述 | 模式 |
|---|---|---|
|
limit_bytes | 允许机构的字节数 | 整数 |
响应
10. listOrganizationQuotaSuperUser
GET /api/v1/superuser/users/{namespace}/quota
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 |
响应
11. changeOrganization
更新有关指定用户的信息。
PUT /api/v1/superuser/organizations/{name}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
name | 受管机构的的名称 | 字符串 |
请求正文模式(application/json)
现有机构的更新描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
email | 机构联系电子邮件 | 字符串 |
|
invoice_email | 机构是否希望接收发票的电子邮件 | 布尔值 |
|
invoice_email_address | 接收发票的电子邮件地址 | |
|
tag_expiration_s | 标签过期的秒数 | 整数 |
响应
12. deleteOrganization
删除指定的机构。
DELETE /api/v1/superuser/organizations/{name}
授权： oauth2_implicit (super:user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
name | 受管机构的的名称 | 字符串 |
响应
13. approveServiceKey
POST /api/v1/superuser/approvedkeys/{kid}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
kid | 服务密钥的唯一标识符 | 字符串 |
请求正文模式(application/json)
批准服务密钥的信息
| 名称 | 描述 | 模式 |
|---|---|---|
|
notes | 可选的批准备注 | 字符串 |
响应
14. deleteServiceKey
DELETE /api/v1/superuser/keys/{kid}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
kid | 服务密钥的唯一标识符 | 字符串 |
响应
15. updateServiceKey
PUT /api/v1/superuser/keys/{kid}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
kid | 服务密钥的唯一标识符 | 字符串 |
请求正文模式(application/json)
服务密钥更新的描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 服务密钥的友好名称 | 字符串 |
|
元数据 | 此键元数据的键/值对 | 对象 |
|
过期 | 过期日期为 unix 时间戳 |
响应
16. getServiceKey
GET /api/v1/superuser/keys/{kid}
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
kid | 服务密钥的唯一标识符 | 字符串 |
响应
17. getRepoBuildStatusSuperUser
返回由 build uuids 指定的构建的状态。
GET /api/v1/superuser/{build_uuid}/status
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
18. getRepoBuildSuperUser
返回有关构建的信息。
GET /api/v1/superuser/{build_uuid}/build
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
19. getRepoBuildLogsSuperUser
返回由 build uuid 指定的构建的构建日志。
GET /api/v1/superuser/{build_uuid}/logs
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
build_uuid | 构建的 UUID | 字符串 |
响应
20. getRegistrySize
GET /api/v1/superuser/registrysize/
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | string |
镜像 registry 大小的描述
| Name | 描述 | 模式 |
|---|---|---|
|
size_bytes* | 允许机构的字节数 | 整数 |
| last_ran | 整数 | |
| Queued | 布尔值 | |
| running | 布尔值 |
响应
21. postRegistrySize
POST /api/v1/superuser/registrysize/
授权： oauth2_implicit (超级：user)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
namespace | 字符串 |
请求正文模式(application/json)
镜像 registry 大小的描述
| Name | 描述 | 模式 |
|---|---|---|
| last_ran | 整数 | |
| Queued | 布尔值 | |
| running | 布尔值 |
响应
22. tag
管理存储库的标签。
22.1. restoreTag
将存储库标签恢复回存储库中以前的镜像。
POST /api/v1/repository/{repository}/tag/{tag}/restore
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 标签 | 标签的名称 | string |
请求正文模式(application/json)
将标签恢复到特定镜像
| 名称 | 描述 | 模式 |
|---|---|---|
|
manifest_digest | 如果指定，应使用的清单摘要 | 字符串 |
响应
22.2. changeTag
更改标签指向或创建新标签的镜像。
PUT /api/v1/repository/{repository}/tag/{tag}
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 标签 | 标签的名称 | string |
请求正文模式(application/json)
更改特定标签
| 名称 | 描述 | 模式 |
|---|---|---|
|
manifest_digest | （如果指定）标签应指向的清单摘要 | |
|
过期 | （如果指定）镜像的过期时间 |
响应
22.3. deleteFullTag
删除指定的存储库标签。
DELETE /api/v1/repository/{repository}/tag/{tag}
授权： oauth2_implicit (存储库：写)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
| path |
需要 标签 | 标签的名称 | string |
响应
22.4. listRepoTags
GET /api/v1/repository/{repository}/tag/
授权： oauth2_implicit (存储库：read)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
onlyActiveTags | 仅过滤为活动的标签。 | 布尔值 |
| query |
页 | 结果的页面索引。默认 1。 | 整数 |
| query |
限制 | 限制为每个页面要返回的结果数。最大 100。 | 整数 |
| query |
filter_tag_name | 语法：<op>:<name> 根据操作过滤标签名称。<op> 可以是 'like' 或 'eq'。 | 字符串 |
| query |
specificTag | 过滤标签到特定标签。 | 字符串 |
响应
23. 团队
创建、列出和管理机构的团队。
23.1. getOrganizationTeamPermissions
返回机构团队的存储库权限列表。
GET /api/v1/organization/{orgname}/team/{teamname}/permissions
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
23.2. updateOrganizationTeamMember
向现有团队添加或邀请成员。
PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | 字符串 |
| path |
memberName | 团队成员的用户名 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
23.3. deleteOrganizationTeamMember
删除团队的成员。
If the user is merely invited to join the team, then the invite is removed instead.
If the user is merely invited to join the team, then the invite is removed instead.DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | 字符串 |
| path |
memberName | 团队成员的用户名 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
23.4. getOrganizationTeamMembers
检索指定团队的成员列表。
GET /api/v1/organization/{orgname}/team/{teamname}/members
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | string |
| path |
OrgName | 机构名称 | string |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
includePending | 是否包含待处理的成员 | 布尔值 |
响应
23.5. inviteTeamMemberEmail
邀请到现有团队的电子邮件地址。
PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 电子邮件 | string | |
| path |
团队名称 | string | |
| path |
OrgName | 字符串 |
响应
23.6. deleteTeamMemberEmailInvite
删除一个邀请加入团队的电子邮件地址。
DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 电子邮件 | 字符串 | |
| path |
团队名称 | 字符串 | |
| path |
OrgName | 字符串 |
响应
23.7. updateOrganizationTeam
更新指定团队的机构范围权限。
PUT /api/v1/organization/{orgname}/team/{teamname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
团队描述
| Name | 描述 | 模式 |
|---|---|---|
|
需要 角色 | 机构应该应用到团队的权限 | 字符串 |
|
description | 团队的 Markdown 描述 | 字符串 |
响应
23.8. deleteOrganizationTeam
删除指定的团队。
DELETE /api/v1/organization/{orgname}/team/{teamname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
团队名称 | 团队的名称 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
24. trigger
创建、列出和管理构建触发器。
24.1. activateBuildTrigger
激活指定的构建触发器。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文架构(application/json)
| Name | 描述 | 模式 |
|---|---|---|
|
配置 | 任意 json。 | 对象 |
|
pull_robot | 用于拉取镜像的机器人名称。 | 字符串 |
响应
24.2. listTriggerRecentBuilds
列出由指定触发器启动的构建。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
限制 | 要返回的构建的最大数量 | 整数 |
响应
24.3. manuallyStartBuildTrigger
从指定的触发器手动启动构建。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文架构(application/json)
用于激活构建触发器的可选运行参数
| Name | 描述 | 模式 |
|---|---|---|
|
branch_name | （仅限 SCM）如果指定，则构建分支的名称。 | 字符串 |
|
commit_sha | （仅限自定义）如果指定，则使用 ref/SHA1 来签出 git 存储库。 | 字符串 |
|
Refs | （仅限 SCM）如果指定，则构建 ref。 |
响应
24.4. getBuildTrigger
获取指定构建触发器的信息。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
24.5. updateBuildTrigger
更新指定的构建触发器。
PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文架构(application/json)
更新构建触发器的选项
| Name | 描述 | 模式 |
|---|---|---|
|
需要启用 | 是否启用构建触发器 | 布尔值 |
响应
24.6. deleteBuildTrigger
删除指定的构建触发器。
DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
24.7. listBuildTriggers
列出指定存储库的触发器。
GET /api/v1/repository/{repository}/trigger/
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | 名称 | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | string |
响应
25. user
管理当前用户。
25.1. createStar
星级存储库。
POST /api/v1/user/starred
授权： oauth2_implicit (repo:read)
请求正文架构(application/json)
| Name | 描述 | 模式 |
|---|---|---|
|
namespace | 仓库所属的命名空间 | 字符串 |
|
需要 仓库 | 仓库名称 | 字符串 |
响应
25.2. listStarredRepos
列出所有星级存储库。
GET /api/v1/user/starred
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
next_page | 下一页的页面令牌 | 字符串 |
响应
25.3. getLoggedInUser
获取经过身份验证的用户的用户信息。
GET /api/v1/user/
授权： oauth2_implicit (user:read)
响应
25.4. deleteStar
从存储库中删除星号。
DELETE /api/v1/user/starred/{repository}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
25.5. getUserInformation
获取指定用户的用户信息。
GET /api/v1/users/{username}
授权：
路径参数
| 类型 | 名称 | 描述 | 模式 |
|---|---|---|---|
| path |
需要 用户名 | 字符串 |
响应
26. 定义
26.1. ApiError
| 名称 | 描述 | 模式 |
|---|---|---|
|
status | 响应的状态代码。 | 整数 |
|
type | 引用错误的类型。 | 字符串 |
|
详情 | 有关错误的特定实例的详情。 | 字符串 |
|
title | 用于标识错误类型的唯一错误代码。 | 字符串 |
|
error_message | 弃用；详细信息的别名 | 字符串 |
|
error_type | 弃用；详细信息的别名 | 字符串 |
26.2. UserView
| 名称 | 描述 | 模式 |
|---|---|---|
|
验证 | 是否验证用户的电子邮件地址 | 布尔值 |
|
匿名 | 如果此用户数据代表一个客户机用户，则为 true | 布尔值 |
|
email | 用户电子邮件地址 | 字符串 |
|
avatar | 代表用户的图标的 avatar 数据 | 对象 |
|
机构 | 有关用户所属的机构的信息 |
对象数组 |
|
登录 | 用户通过身份验证的外部登录供应商列表 |
对象数组 |
|
can_create_repo | 用户是否有创建存储库的权限 | 布尔值 |
|
preferred_namespace | 如果为 true，则用户的命名空间是要显示的首选命名空间 | 布尔值 |
26.3. ViewMirrorConfig
| 名称 | 描述 | 模式 |
|---|---|---|
|
is_enabled | 用于启用或禁用同步。 | 布尔值 |
|
external_reference | 外部存储库的位置。 | 字符串 |
|
external_registry_username | 用于与外部 registry 进行身份验证的用户名。 | |
|
external_registry_password | 用于与外部 registry 进行身份验证的密码。 | |
|
sync_start_date | 决定此存储库下次准备同步的时间。 | 字符串 |
|
sync_interval | next_start_date 开始同步后的秒数。 | 整数 |
|
robot_username | 用于镜像推送的机器人的用户名。 | 字符串 |
|
root_rule | 用于决定应同步哪些标签的 glob-patterns 列表。 | 对象 |
|
external_registry_config | 对象 |
26.4. ApiErrorDescription
| 名称 | 描述 | 模式 |
|---|---|---|
|
type | 对错误类型资源的引用 | 字符串 |
|
title | 错误的标题。可用于唯一标识错误类型。 | 字符串 |
|
description | 有关错误的详细描述，其中包括修复此问题的帮助信息。 | 字符串 |
第 3 章 API 配置示例
3.1. external_registry_config object reference
3.2. rule_rule 对象引用
{
"root_rule": {"rule_kind": "tag_glob_csv", "rule_value": ["latest", "foo", "bar"]},
}
{
"root_rule": {"rule_kind": "tag_glob_csv", "rule_value": ["latest", "foo", "bar"]},
}
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}