Red Hat Quay API ガイド
Red Hat Quay API ガイド
概要
序文 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Quay API (アプリケーションプログラミングインターフェース) は、Red Hat Quay の機能の追加、表示、変更、および削除を行うための一連のエンドポイントで構成される OAuth 2 RESTful API です。本書では、これらのエンドポイントと、そのエンドポイントにアクセスするために使用するコマンドおよびブラウザーベースの例を説明します。
第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 クラスターで設定を表示し、変更する方法を説明します。付録 A には 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 エンドポイントが表示されます。スーパーユーザー API エンドポイントや (リポジトリーミラーリングなど) Quay.io で有効にされていない Red Hat Quay 機能のエンドポイントは表示されません。
API Explorer から、以下の情報を取得したり、変更したりすることが可能です。
- Billing (請求)、サブスクリプション、Plan (計画)
- リポジトリービルドおよびビルドトリガー
- エラーメッセージおよびグローバルメッセージ
- リポジトリーイメージ、マニフェスト、パーミッション、通知、脆弱性およびイメージの署名
- 使用ログ
- 組織、メンバーおよび OAuth アプリケーション
- ユーザーおよびロボットアカウント
- その他
これを選択してエンドポイントを開き、エンドポイントの各部分の Model Schema を表示します。エンドポイントを開き、必要なパラメーター (リポジトリー名やイメージなど) を入力し、「Try it out!」ボタンを選択して Quay.io エンドポイントに関連する設定をクエリーするか、または変更します。
1.2. OAuth アクセストークンの作成 リンクのコピーリンクがクリップボードにコピーされました!
組織の API にアクセスできるように OAuth アクセストークンを作成するには、以下を実行します。
- Red Hat Quay にログインし、使用する組織を選択します (または新規の組織を作成します)。
- 左側のナビゲーションから「Applications」アイコンを選択します。
- 「Create New Application」を選択し、プロンプトが出されたら新しいアプリケーションに名前を付けます。
- 新規アプリケーションを選択します。
- 左側のナビゲーションから「Generate Token」を選択します。
- チェックボックスを選択してトークンのスコープを設定し、「Generate Access Token」を選択します。
- 許可するパーミッションを確認し、「Authorize Application」を選択してこれを承認します。
- API にアクセスするために使用する新規に生成されたトークンをコピーします。
1.3. Web ブラウザーから Quay API へのアクセス リンクのコピーリンクがクリップボードにコピーされました!
Swagger を有効にすると、Web ブラウザーを使用して独自の Red Hat Quay インスタンスの API にアクセスできます。この URL を使用すると、Swagger UI と URL で Red Hat Quay API を公開できます。
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 calls must be invoked with an X-Requested-With header if called from a browser」などのエラーがログに出されるのを防ぐには、以下の行を、クラスター内のすべてのノード上の config.yaml に追加し、Red Hat Quay を再起動します。
BROWSER_API_CALLS_XHR_ONLY: false
BROWSER_API_CALLS_XHR_ONLY: false
1.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 を使用したスーパーユーザーの作成 リンクのコピーリンクがクリップボードにコピーされました!
『Quay のデプロイ』で説明されているようにスーパーユーザーの名前を設定します。
- 設定エディターの UI を使用します。または以下を実行します。
-
設定 API を使用して更新された設定バンドルを検証(およびダウンロード)するオプションで、
config.yamlファイルを直接編集します。
スーパーユーザー名のユーザーアカウントを作成します。
上記のように認証トークンを取得し、
curlを使用してユーザーを作成します。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/ | jq$ 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. ディレクトリーの同期 リンクのコピーリンクがクリップボードにコピーされました!
LDAP の対応するグループ名が ldapgroup の、testadminorg 組織の newteam チームのディレクトリーの同期を有効にするには、以下を実行します。
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/syncing
1.4.4. API を使用したリポジトリービルドの作成 リンクのコピーリンクがクリップボードにコピーされました!
指定された入力からリポジトリーをビルドし、カスタムタグでビルドにタグを付けるために、requestRepoBuild エンドポイントを使用できます。これには、以下のデータが使用されます。
archive_url パラメーターは、Dockerfile およびその他のビルドに必要なファイルが含まれる tar または zip アーカイブを参照する必要があります。file_id パラメーターは、古いビルドシステムから分離されました。これを使用することはできません。Dockerfile がサブディレクトリーにある場合は、Dockerfile も指定する必要があります。
アーカイブは一般にアクセスできる必要があります。OAuth アプリケーションには、「Administer Organization」(組織管理者) のスコープが設定されている必要があります。組織管理者のみがロボットのアカウントトークンにアクセスできるためです。それ以外の場合は、他のユーザーは (アクセスがなくても) ロボットにビルドアクセスを付与するだけでロボットパーミッションを取得でき、これを使用してイメージコンテンツを取得できる場合があります。エラーが発生した場合は、返される json ブロックを確認し、アーカイブの場所、プルロボットおよびその他のパラメーターが正しく渡されていることを確認します。個々のビルドページの右上にある「Download logs」をクリックし、ログで詳細なメッセージを確認できます。
1.4.5. 組織ロボットの作成 リンクのコピーリンクがクリップボードにコピーされました!
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.6. ビルドのトリガー リンクのコピーリンクがクリップボードにコピーされました!
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.7. プライベートリポジトリーの作成 リンクのコピーリンクがクリップボードにコピーされました!
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"}' | jq
$ 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"}' | jq
第2章 付録 A: Red Hat Quay API (アプリケーションプログラミングインターフェース) リンクのコピーリンクがクリップボードにコピーされました!
この API を使用すると、Red Hat Quay リポジトリー、ユーザー、および組織を使用するために必要な多くの操作を実行できます。
2.1. アプリケーション固有のトークン: 現在のユーザーのアプリケーション固有のトークンを管理します。 リンクのコピーリンクがクリップボードにコピーされました!
2.2. ビルド: リポジトリービルドの作成、一覧表示、取り消し、ステータス/ログの取得 リンクのコピーリンクがクリップボードにコピーされました!
2.2.1. get /api/v1/repository/{repository}/build/{build_uuid}/status リンクのコピーリンクがクリップボードにコピーされました!
2.2.1.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
ビルドの uuid で指定されるビルドのステータスを返します。
2.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| build_uuid | required (必須) | ビルドの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.2.1.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.2.2. get /api/v1/repository/{repository}/build/{build_uuid}/logs リンクのコピーリンクがクリップボードにコピーされました!
2.2.2.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
ビルドの uuid によって指定されるビルドのビルドログを返します。
2.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| build_uuid | required (必須) | ビルドの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.2.2.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.2.3. get /api/v1/repository/{repository}/build/{build_uuid} リンクのコピーリンクがクリップボードにコピーされました!
2.2.3.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
ビルドに関する情報を返します。
2.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| build_uuid | required (必須) | ビルドの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.2.3.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.2.4. delete /api/v1/repository/{repository}/build/{build_uuid} リンクのコピーリンクがクリップボードにコピーされました!
2.2.4.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
リポジトリービルドを取り消します。
2.2.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| build_uuid | required (必須) | ビルドの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.2.4.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 204 | Deleted (削除) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.2.5. get /api/v1/repository/{repository}/build/ リンクのコピーリンクがクリップボードにコピーされました!
2.2.5.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
リポジトリービルドの一覧を取得します。
2.2.5.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
| since | 指定の unix タイムコードからすべてのビルドを返します。 | クエリー | 整数 | |
| limit | 返すビルドの最大数。 | クエリー | 整数 |
2.2.5.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.2.6. post /api/v1/repository/{repository}/build/ リンクのコピーリンクがクリップボードにコピーされました!
2.2.6.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
リポジトリーをビルドし、指定の入力からプッシュするよう要求します。
2.2.6.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | path |
string
|
| body | 必須 (パラメーターコンテンツタイプ: application/json) | 要求本体の内容。 | body |
|
2.2.6.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 201 | Successful creation (正常な作成) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.3. 検出: API 検出情報 リンクのコピーリンクがクリップボードにコピーされました!
2.4. エラー: エラー詳細 API リンクのコピーリンクがクリップボードにコピーされました!
2.5. globalmessages : Messages API リンクのコピーリンクがクリップボードにコピーされました!
2.6. イメージ: リポジトリーイメージの一覧表示および検索 リンクのコピーリンクがクリップボードにコピーされました!
2.7. ログ: 組織またはリポジトリーの使用ログへのアクセス リンクのコピーリンクがクリップボードにコピーされました!
2.8. マニフェスト: リポジトリーのマニフェストの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.9. 組織: 組織、メンバー、および OAuth アプリケーションの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.10. パーミッション: リポジトリーパーミッションの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.11. プロトタイプ: リポジトリーに追加されたデフォルトのパーミッションの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.12. リポジトリー: リポジトリーの一覧表示、作成、および管理 リンクのコピーリンクがクリップボードにコピーされました!
2.13. repositorynotification: リポジトリーイベント/通知の一覧表示、作成、および管理 リンクのコピーリンクがクリップボードにコピーされました!
2.14. ロボット: ユーザーおよび組織のロボットアカウントの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.15. 検索: すべてのレジストリーコンテキストに対する検索 リンクのコピーリンクがクリップボードにコピーされました!
2.16. スーパーユーザー: スーパーユーザー API リンクのコピーリンクがクリップボードにコピーされました!
2.17. タグ: リポジトリーのタグの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.18. チーム: 組織のチームの作成、一覧表示および管理 リンクのコピーリンクがクリップボードにコピーされました!
2.18.1. get /api/v1/organization/{orgname}/team/{teamname}/permissions リンクのコピーリンクがクリップボードにコピーされました!
2.18.1.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
組織のチームのリポジトリーパーミッションの一覧を返します。
2.18.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| orgname | required (必須) | 組織の名前 | パス | 文字列 |
| teamname | required (必須) | チームの名前。 | パス | 文字列 |
2.18.1.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.18.2. delete /api/v1/organization/{orgname}/team/{teamname}/members/{membername} リンクのコピーリンクがクリップボードにコピーされました!
2.18.2.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
チームのメンバーを削除します。ユーザーがチームに参加するよう招待されるだけであれば、招待は削除されます。
2.18.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| orgname | required (必須) | 組織の名前 | パス | 文字列 |
| membername | required (必須) | チームメンバーのユーザー名 | パス | 文字列 |
| teamname | required (必須) | チームの名前。 | パス | 文字列 |
2.18.2.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 204 | Deleted (削除) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
:leveloffset: +1
2.19. get /api/v1/organization/{orgname}/team/{teamname}/members リンクのコピーリンクがクリップボードにコピーされました!
2.19.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたチームのメンバーの一覧を取得します。
2.19.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
| orgname | required (必須) | 組織の名前 | パス | 文字列 |
| teamname | required (必須) | チームの名前。 | パス | 文字列 |
| includePending | true / false | 保留中のメンバーを含めるかどうか。 | クエリー | ブール値 |
2.19.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20. トリガー: ビルドトリガーの作成、一覧表示および管理 リンクのコピーリンクがクリップボードにコピーされました!
2.20.1. post /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate リンクのコピーリンクがクリップボードにコピーされました!
2.20.1.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたビルドトリガーをアクティベートします。
2.20.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | path |
string
|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | path |
string
|
| body | 必須 (パラメーターコンテンツタイプ: application/json) | 要求本体の内容。 | body |
|
2.20.1.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 201 | Successful creation (正常な作成) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20.2. get /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds リンクのコピーリンクがクリップボードにコピーされました!
2.20.2.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたトリガーによって開始されるビルドを一覧表示します。
2.20.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
| limit | 返すビルドの最大数。 | クエリー | 整数 |
2.20.2.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 201 | Successful creation (正常な作成) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20.3. post /api/v1/repository/{repository}/trigger/{trigger_uuid}/start リンクのコピーリンクがクリップボードにコピーされました!
2.20.3.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたトリガーからビルドを手動で開始します。
2.20.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | path |
string
|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | path |
string
|
| body | 必須 (パラメーターコンテンツタイプ: application/json) | 要求本体の内容。 | body |
|
2.20.3.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 201 | Successful creation (正常な作成) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20.4. get /api/v1/repository/{repository}/trigger/{trigger_uuid} リンクのコピーリンクがクリップボードにコピーされました!
2.20.4.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたビルドトリガーの情報を取得します。
2.20.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.20.4.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20.5. put /api/v1/repository/{repository}/trigger/{trigger_uuid} リンクのコピーリンクがクリップボードにコピーされました!
2.20.5.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたビルドトリガーを更新します。
2.20.5.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | path |
string
|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | path |
string
|
| body | 必須 (パラメーターコンテンツタイプ: application/json) | 要求本体の内容。 | body |
Model: Model Schema
{
"enabled": true
}
|
2.20.5.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.20.6. delete /api/v1/repository/{repository}/trigger/{trigger_uuid} リンクのコピーリンクがクリップボードにコピーされました!
2.20.6.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたビルドトリガーを削除します。
2.20.6.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| trigger_uuid | required (必須) | ビルドトリガーの UUID | パス | 文字列 |
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.20.6.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 204 | Deleted (削除) |
| 400 |
| Bad Request (不適切な要求) | モード: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" |
| 401 |
| Session required (セッションが必要) | モデル: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" } |
| 403 |
| Unauthorized access (不正アクセス) | モデル: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" } |
| 404 |
2.20.7. get /api/v1/repository/{repository}/trigger/ リンクのコピーリンクがクリップボードにコピーされました!
2.20.7.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたリポジトリーのトリガーを一覧表示します。
2.20.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| repository | required (必須) | リポジトリーの完全パス (例: namespace/name) | パス | 文字列 |
2.20.7.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.21. ユーザー: 現在のユーザーの管理 リンクのコピーリンクがクリップボードにコピーされました!
2.21.1. get /api/v1/user/starred リンクのコピーリンクがクリップボードにコピーされました!
2.21.1.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
共有されているすべてのリポジトリーを一覧表示します。
2.21.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| next_page | required (必須) | 次のページのページトークン。 | パス | 文字列 |
2.21.1.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.21.2. post /api/v1/user/starred リンクのコピーリンクがクリップボードにコピーされました!
2.21.2.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
2.21.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| body | 必須 (パラメーターコンテンツタイプ: application/json) | 要求本体の内容。 | body |
|
2.21.2.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 201 | Successful creation (正常な作成) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.21.3. get /api/v1/user/ リンクのコピーリンクがクリップボードにコピーされました!
2.21.3.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
認証されたユーザーのユーザー情報を取得します。
2.21.3.2. 応答クラス (ステータス 200) リンクのコピーリンクがクリップボードにコピーされました!
モデル: Model Schema
応答コンテンツタイプ: application/json
2.21.3.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.21.4. delete /api/v1/user/starred/{repository} リンクのコピーリンクがクリップボードにコピーされました!
2.21.4.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
リポジトリーからスターを削除します。
2.21.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| repository | required (必須) | リポジトリーの完全なパス(例: namespace/name) | パス | 文字列 |
2.21.4.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 204 | Deleted (削除) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|
2.21.5. get /api/v1/users/{username} リンクのコピーリンクがクリップボードにコピーされました!
2.21.5.1. 実装に関する注意 リンクのコピーリンクがクリップボードにコピーされました!
指定されたユーザーのユーザー情報を取得します。
2.21.5.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 値 | 説明 | パラメータータイプ | データタイプ |
|---|---|---|---|---|
| username | required (必須) | パス | 文字列 |
2.21.5.3. 応答メッセージ リンクのコピーリンクがクリップボードにコピーされました!
| HTTP ステータスコード | 理由 | 応答モデル | ヘッダー |
|---|---|---|---|
| 200 | Successful invocation (正常な呼び出し) |
| |
| 400 | 不適切な要求 |
| |
| 401 | Session required (セッションが必要) |
| |
| 403 | Unauthorized access (不正アクセス) |
| |
| 404 | Not found (見つからない) |
|