2.17. 机器人


管理用户和组织机器人帐户。

2.17.1. getUserRobots

列出用户的可用机器。

GET /api/v1/user/robots

授权: oauth2_implicit (用户:admin)

查询参数
Expand
类型Name描述模式

query

limit
optional

如果指定,要返回的机器人数。

整数

query

Token
可选

如果为 false,则机器的令牌不会返回。

布尔值

query

权限
可选

是否包括机器人具有权限的存储库和团队。

布尔值

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.2. getOrgRobotPermissions

返回组织的机器机器的存储库权限列表。

GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.3. regenerateOrgRobotToken

为机构机器机器重新生成令牌。

POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate

授权: oauth2_implicit (机构:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.4. getUserRobotPermissions

返回用户机器机器的存储库权限列表。

GET /api/v1/user/robots/{robot_shortname}/permissions

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.5. regenerateUserRobotToken

为用户的机器重新生成令牌。

POST /api/v1/user/robots/{robot_shortname}/regenerate

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.6. getOrgRobot

使用指定名称返回组织的机器人。

GET /api/v1/organization/{orgname}/robots/{robot_shortname}

授权: oauth2_implicit (机构:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.7. createOrgRobot

在组织中创建一个新机器人。

PUT /api/v1/organization/{orgname}/robots/{robot_shortname}

授权: oauth2_implicit (机构:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

请求正文模式(application/json)

创建机器的可选数据

Expand
名称描述模式

description
可选

机器的可选文本描述

字符串

unstructured_metadata
optional

机器的可选非结构化元数据

对象

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.8. deleteOrgRobot

删除现有的机构机器机器。

DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}

授权: oauth2_implicit (机构:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.9. getOrgRobots

列出组织的机器人。

GET /api/v1/organization/{orgname}/robots

授权: oauth2_implicit (机构:admin)

路径参数
Expand
类型Name描述模式

path

OrgName
必需

机构的名称

字符串

查询参数
Expand
类型Name描述模式

query

limit
optional

如果指定,要返回的机器人数。

整数

query

Token
可选

如果为 false,则机器的令牌不会返回。

布尔值

query

权限
可选

是否包括机器人具有权限的存储库和团队。

布尔值

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.10. getUserRobot

使用指定名称返回用户机器人。

GET /api/v1/user/robots/{robot_shortname}

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.11. createUserRobot

使用指定名称创建一个新用户机器。

PUT /api/v1/user/robots/{robot_shortname}

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

请求正文模式(application/json)

创建机器的可选数据

Expand
名称描述模式

description
可选

机器的可选文本描述

字符串

unstructured_metadata
optional

机器的可选非结构化元数据

对象

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.17.12. deleteUserRobot

删除现有的机器机器。

DELETE /api/v1/user/robots/{robot_shortname}

授权: oauth2_implicit (用户:admin)

路径参数
Expand
类型Name描述模式

path

robot_shortname
required

机器机器的短名称,没有用户或机构前缀

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat