Red Hat Summit5.2. Red Hat Quay API の使用
アプリケーションを作成し、必要な設定で OAuth 2 アクセストークンを生成したら、CLI から API を使用して、アクセストークンを GET、PUT、POST、または DELETE 設定に渡すことができます。通常、Red Hat Quay API コマンドは次の例のようになります。
$ curl -X GET -H "Authorization: Bearer <your_access_token>" 1 https://<quay-server.example.com>/api/v1/<example>/<endpoint>/ 2
すべての Red Hat Quay API については、アプリケーションプログラミングインターフェイス (API) の章を参照してください。記載内容を理解することは、呼び出しを成功させるために非常に重要です。たとえば、createAppToken API エンドポイントの次のエントリーがあります。
*createAppToken* 1 Create a new app specific token for user. 2 *POST /api/v1/user/apptoken* 3 **Authorizations: **oauth2_implicit (**user:admin**) 4 Request body schema (application/json) *Path parameters* 5 Name: **title** Description: Friendly name to help identify the token. Schema: string *Responses* 6 |HTTP Code|Description |Schema |201 |Successful creation | |400 |Bad Request |<<_apierror,ApiError>> |401 |Session required |<<_apierror,ApiError>> |403 |Unauthorized access |<<_apierror,ApiError>> |404 |Not found |<<_apierror,ApiError>> |===
API エンドポイントを使用するには、アクセストークンを渡し、必要に応じて適切なフィールドを含めます。次の手順は、POST/api/v1/user/apptoken エンドポイントの使用方法を示しています。
前提条件
- Red Hat Quay API にアクセスできる。そのためには、OAuth 2 アクセストークンが作成済みでなければなりません。
-
config.yamlファイルでBROWSER_API_CALLS_XHR_ONLY: falseを設定している。
手順
POST /api/v1/user/apptokenAPI 呼び出しを入力して、ユーザーアプリケーションを作成します。$ curl -X POST \ -H "Authorization: Bearer <access_token>" 1 -H "Content-Type: application/json" \ -d '{ "title": "MyAppToken" 2 }' \ "http://quay-server.example.com/api/v1/user/apptoken" 3
出力例
{"token": {"uuid": "6b5aa827-cee5-4fbe-a434-4b7b8a245ca7", "title": "MyAppToken", "last_accessed": null, "created": "Wed, 08 Jan 2025 19:32:48 -0000", "expiration": null, "token_code": "K2YQB1YO0ABYV5OBUYOMF9MCUABN12Y608Q9RHFXBI8K7IE8TYCI4WEEXSVH1AXWKZCKGUVA57PSA8N48PWED9F27PXATFUVUD9QDNCE9GOT9Q8ACYPIN0HL"}}
検証
Red Hat Quay UI のナビゲーションペインでユーザー名をクリックし、Account Settings をクリックします。アプリケーションの名前は、Docker CLI and other Application Tokens の見出しの下に表示されます。以下に例を示します。
