Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

7.18. robot

ユーザーおよび組織のロボットアカウントを管理します。

7.18.1. getUserRobots
リンクのコピー

ユーザーが利用可能なロボットをリスト表示します。

GET /api/v1/user/robots

認可: oauth2_implicit (user:admin)

クエリーパラメーター
Expand
タイプ名前説明スキーマ

query

limit
任意

これが指定されている場合には、返すべきロボットの数。

integer

query

token
任意

False の場合には、ロボットのトークンは返されません。

boolean

query

permissions
任意

ロボットのパーミッションがあるリポジトリーおよびチームを含めるかどうか。

boolean

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET "https://quay-server.example.com/api/v1/user/robots?limit=10&token=false&permissions=true" \
  -H "Authorization: Bearer <your_access_token>"
Copy to Clipboard Toggle word wrap

7.18.2. getOrgRobotPermissions
リンクのコピー

組織のロボットのリポジトリーパーミッションリストを返します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

path

orgname
必須

組織の名前

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>/permissions"
Copy to Clipboard Toggle word wrap

7.18.3. regenerateOrgRobotToken
リンクのコピー

組織のロボットのトークンを再生成します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

path

orgname
必須

組織の名前

string

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
Copy to Clipboard Toggle word wrap

7.18.4. getUserRobotPermissions
リンクのコピー

ユーザーのロボットのリポジトリーパーミッションリストを返します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/user/robots/<ROBOT_SHORTNAME>/permissions"
Copy to Clipboard Toggle word wrap

7.18.5. regenerateUserRobotToken
リンクのコピー

ユーザーのロボットのトークンを再生成します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>/regenerate"
Copy to Clipboard Toggle word wrap

7.18.6. getOrgRobot
リンクのコピー

指定された名前の組織のロボットを返します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

path

orgname
必須

組織の名前

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>"
Copy to Clipboard Toggle word wrap

7.18.7. createOrgRobot
リンクのコピー

組織に新しいロボットを作成します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

path

orgname
必須

組織の名前

string

要求の body スキーマ (application/json)

ロボット作成のデータ (任意)

Expand
名前説明スキーマ

description
任意

ロボットのテキスト形式の説明 (任意)

string

unstructured_metadata
任意

ロボットの非構造化メタデータ (任意)

object

レスポンス
Expand
HTTP コード説明スキーマ

201

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_name>"
Copy to Clipboard Toggle word wrap

7.18.8. deleteOrgRobot
リンクのコピー

既存の組織ロボットを削除します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

path

orgname
必須

組織の名前

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"
Copy to Clipboard Toggle word wrap

7.18.9. getOrgRobots
リンクのコピー

組織のロボットをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

orgname
必須

組織の名前

string

クエリーパラメーター
Expand
タイプ名前説明スキーマ

query

limit
任意

これが指定されている場合には、返すべきロボットの数。

integer

query

token
任意

False の場合には、ロボットのトークンは返されません。

boolean

query

permissions
任意

ロボットのパーミッションがあるリポジトリーおよびチームを含めるかどうか。

boolean

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots"
Copy to Clipboard Toggle word wrap

7.18.10. getUserRobot
リンクのコピー

指定の名前のユーザーのロボットを返します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
Copy to Clipboard Toggle word wrap

7.18.11. createUserRobot
リンクのコピー

指定の名前で新たなユーザーロボットを作成します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

要求の body スキーマ (application/json)

ロボット作成のデータ (任意)

Expand
名前説明スキーマ

description
任意

ロボットのテキスト形式の説明 (任意)

string

unstructured_metadata
任意

ロボットの非構造化メタデータ (任意)

object

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/user/robots/<robot_name>"
Copy to Clipboard Toggle word wrap

7.18.12. deleteUserRobot
リンクのコピー

既存のロボットを削除します。

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

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

robot_shortname
必須

ユーザーまたは組織の接頭辞を含まない、ロボットの省略名

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
Copy to Clipboard Toggle word wrap

7.18.13. 認証フェデレーションロボットトークン
リンクのコピー

ロボットアイデンティティーフェデレーションメカニズムを使用して、期限切れのロボットトークンを返します。

oauth2/federation/robot/token の取得

認可: oauth2_implicit (robot:auth)

レスポンス
Expand
HTTP コード説明スキーマ

200

認証とトークン生成が成功しました

{ "token": "string" }

401

Unauthorized: 認証が欠落しているか無効です

{ "error": "string" }

リクエストボディー
Expand
タイプ名前説明スキーマ

body

auth_result
required

ロボットのアイデンティティーに関する情報を含む認証プロセスの結果。

{ "missing": "boolean", "error_message": "string", "context": { "robot": "RobotObject" } }

コマンドの例
$ curl -X GET "https://quay-server.example.com/oauth2/federation/robot/token" \
  -H "Authorization: Bearer <your_access_token>"
Copy to Clipboard Toggle word wrap

7.18.14. createOrgRobotFederation
リンクのコピー

指定された組織ロボットのフェデレーション設定を作成します。

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

指定された組織ロボットのフェデレーション設定を取得します。

認可: oauth2_implicit (user:admin)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

orgname + robot_shortname 必須

組織名とロボットの短縮名 (ユーザー名や組織の接頭辞なし)

string

レスポンス
Expand
HTTP コード説明スキーマ

201

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

コマンドの例
$ curl -X POST "https://quay-server.example.com/api/v1/organization/{orgname}/robots/{robot_shortname}/federation" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json"
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat