ホーム
製品
Red Hat Quay
3.12
Red Hat Quay API ガイド

Red Hat Quay API ガイド

Red Hat Quay 3.12

Red Hat Quay API ガイド

Red Hat OpenShift Documentation Team

概要

Red Hat Quay API の使用

はじめに
リンクのコピー

Red Hat Quay アプリケーションプログラミングインターフェイス (API) は、Red Hat Quay 機能を追加、表示、変更、および削除するための一連のエンドポイントで構成される OAuth 2 RESTful API です。

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 は 3.y.z リリースに api/v1 エンドポイントを使用しています。

このガイドでは、api/v1 エンドポイントと、それらのエンドポイントにアクセスするためのブラウザーベースの例を説明します。

第1章 Red Hat Quay API の使用
リンクのコピー

Red Hat Quay は完全な OAuth 2、RESTful API を提供します。[OAuth 2] RESTful API には次の利点があります。

これは、Red Hat Quay ホストのエンドポイント /api/v1 から利用できます。たとえば、https://<quay-server.example.com>/api/v1 です。
Swagger UI を有効にすると、ユーザーがブラウザー経由でエンドポイントに接続し、Red Hat Quay の設定を GET、POST、DELETE、PUT できるようになります。
API 呼び出しを実行して OAuth トークンを使用するアプリケーションからアクセスできます。
データを JSON 形式で送受信します。

次のセクションでは、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/

Copy to Clipboard

Toggle word wrap

表示される API Explorer には Quay.io API エンドポイントが表示されます。Quay.io で有効でない Red Hat Quay 機能のスーパーユーザー API エンドポイントまたはエンドポイント (リポジトリーミラーリングなど) は表示されません。

API Explorer から、以下に関する情報を取得し、変更できます。

請求、サブスクリプション、およびプラン
リポジトリービルドおよびビルドトリガー
エラーメッセージおよびグローバルメッセージ
リポジトリーイメージ、マニフェスト、パーミッション、通知、脆弱性、およびイメージの署名
使用状況に関するログ
組織、メンバー、および OAuth アプリケーション
ユーザーとロボットアカウント
その他

エンドポイントを選択して開き、エンドポイントの各部分のモデルスキーマを表示します。エンドポイントを開き、必要なパラメーター (リポジトリー名またはイメージなど) を入力し、Try it out! ボタンを選択して Quay.io エンドポイントに関連する設定を照会するか、変更します。

1.2. v1 OAuth アクセストークンの作成
リンクのコピー

OAuth アクセストークンは、保護されたリソースへのセキュアなアクセスを可能にする認証情報です。Red Hat Quay では、組織の API エンドポイントにアクセスする前に、OAuth アクセストークンを作成する必要があります。

OAuth アクセストークンを作成するには、次の手順を実行します。

前提条件

Red Hat Quay に管理者としてログインしている。

手順

メインページで、Organization を選択します。
ナビゲーションペインで、Applications を選択します。
Create New Application をクリックし、新しいアプリケーション名を入力して、Enter を押します。
OAuth Applications ページで、アプリケーションの名前を選択します。
オプション: 以下の情報を入力します。
1. Application Name
2. Homepage URL
3. Description
4. Avatar E-mail
5. Redirect/Callback URL prefix
ナビゲーションペインで、Generate Token を選択します。
次のオプションのチェックボックスをオンにします。
1. Administer Organization
2. Administer Repositories
3. Create Repositories
4. View all visible repositories
5. Read/Write to any accessible repositories
6. Super User Access
7. Administer User
8. Read User Information
Generate Access Token をクリックします。新しいページにリダイレクトされます。
許可する権限を確認し、Authorize Application をクリックします。Authorize Application をクリックして決定した内容を確定します。
Access Token ページにリダイレクトされます。アクセストークンをコピーして保存します。
重要
これは、アクセストークンをコピーして保存する唯一の機会です。このページを離れると再取得できません。

1.3. OCI リファラー OAuth アクセストークンの作成
リンクのコピー

場合によっては、OCI リファラー OAuth アクセストークンを作成することを推奨します。このトークンは、リポジトリー配下にあるマニフェストの OCI リファラーをリスト表示するために使用します。

手順

config.yaml ファイルを更新して、FEATURE_REFERRERS_API: true フィールドを含めます。以下に例を示します。
```
# ...
FEATURE_REFERRERS_API: true
# ...
```
```
# ...
FEATURE_REFERRERS_API: true
# ...
```
Copy to Clipboard Toggle word wrap
次のコマンドを入力し、認証情報を Base64 でエンコードします。
```
echo -n '<username>:<password>' | base64
```
```
$ echo -n '<username>:<password>' | base64
```
Copy to Clipboard Toggle word wrap
出力例
```
abcdeWFkbWluOjE5ODlraWROZXQxIQ==
```
```
abcdeWFkbWluOjE5ODlraWROZXQxIQ==
```
Copy to Clipboard Toggle word wrap

次のコマンドを入力して、base64 でエンコードされた文字列を使用し、URL エンドポイントを Red Hat Quay サーバーに変更します。

curl --location '<quay-server.example.com>/v2/auth?service=<quay-server.example.com>&scope=repository:quay/listocireferrs:pull,push' --header 'Authorization: Basic <base64_username:password_encode_token>' -k | jq

$ curl --location '<quay-server.example.com>/v2/auth?service=<quay-server.example.com>&scope=repository:quay/listocireferrs:pull,push' --header 'Authorization: Basic <base64_username:password_encode_token>' -k | jq

Copy to Clipboard

Toggle word wrap

出力例

{
  "token": "<example_secret>
}

{
  "token": "<example_secret>
}

Copy to Clipboard

Toggle word wrap

1.4. OAuth アクセストークンの再割り当て
リンクのコピー

組織管理者は、特定の権限を持つ他のユーザーによって作成されるように OAuth API トークンを割り当てることができます。これにより、OAuth API トークンを作成する組織管理者権限を持たないユーザーがトークンを使用した場合でも、監査ログが正確に反映されるようになります。

注記

次の手順は、現在の Red Hat Quay UI でのみ機能します。現在、Red Hat Quay v2 UI には実装されていません。

前提条件

組織管理者権限を持つユーザーとしてログインしており、OAuth API トークンを割り当てることができる。
注記
OAuth API トークンは、認可ではなく認証に使用されます。たとえば、OAuth トークンを割り当てるユーザーは、管理 API エンドポイントを使用するために Admin チームロールを持っている必要があります。詳細は、リポジトリーへのアクセスの管理を参照してください。

手順

オプション: まだ更新していない場合は、Red Hat Quay config.yaml ファイルを更新して、FEATURE_ASSIGN_OAUTH_TOKEN: true フィールドを含めます。
```
# ...
FEATURE_ASSIGN_OAUTH_TOKEN: true
# ...
```
```
# ...
FEATURE_ASSIGN_OAUTH_TOKEN: true
# ...
```
Copy to Clipboard Toggle word wrap
オプション: Red Hat Quay レジストリーを再起動します。
組織管理者として Red Hat Quay レジストリーにログインします。
OAuth トークンを作成した組織の名前をクリックします。
ナビゲーションペインで、Applications をクリックします。
適切なアプリケーション名をクリックします。
ナビゲーションペインで、Generate Token をクリックします。
Assign another user をクリックし、OAuth トークンを引き継ぐユーザーの名前を入力します。
新しいユーザーに付与する必要な権限のボックスをオンにします。たとえば、新しいユーザーにリポジトリーの作成のみを許可する場合は、Create Repositories クリックします。
重要
権限の制御は、組織内のチームロールによって定義され、ここで選択したオプションに関係なく設定する必要があります。たとえば、OAuth トークンを割り当てるユーザーは、管理 API エンドポイントを使用するために Admin チームロールを持っている必要があります。
Super User Access ボックスをオンにしただけでは、この権限がユーザーに実際に付与されるわけではありません。config.yaml ファイルでスーパーユーザーを設定する必要があり、かつここでボックスをオンにする必要があります。
Assign token をクリックします。ポップアップボックスに、認可を確認する次のメッセージと、承認される権限が表示されます。
```
This will prompt user <username> to generate a token with the following permissions:
repo:create
```
```
This will prompt user <username> to generate a token with the following permissions:
repo:create
```
Copy to Clipboard Toggle word wrap
ポップアップボックスで Assign token をクリックします。新しいページにリダイレクトされ、次のメッセージが表示されます。
```
Token assigned successfully
```
```
Token assigned successfully
```
Copy to Clipboard Toggle word wrap

検証

OAuth トークンを再割り当てした後、割り当てられたユーザーがトークンを受け入れて、API エンドポイントの使用に必要なベアラートークンを受け取る必要があります。割り当てられたユーザーに、Red Hat Quay レジストリーにログインするよう依頼します。
ユーザーは、ログインしたら、Users and Organizations の下にある自分のユーザー名をクリックする必要があります。
ナビゲーションペインで、External Logins And Applications をクリックする必要があります。
Authorized Applications の下で、Authorize Application をクリックしてアプリケーションを確認する必要があります。新しいページに移動し、Authorize Application をクリックして再確認する必要があります。
ユーザーは、ベアラートークンが表示される新しいページにリダイレクトされます。このベアラートークンは再度表示することはできないため、保存する必要があります。

1.5. Web ブラウザーからの Quay API へのアクセス
リンクのコピー

Swagger を有効にし、Web ブラウザーを使用して独自の Red Hat Quay インスタンスの API にアクセスできます。この URL は、Red Hat Quay API を UI および以下の URL 経由で公開します。

https://<yourquayhost>/api/v1/discovery.

https://<yourquayhost>/api/v1/discovery.

Copy to Clipboard

Toggle word wrap

この方法で 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

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

1.6. コマンドラインでの Red Hat Quay API へのアクセス
リンクのコピー

curl コマンドを使用して、Red Hat Quay クラスターの API を使用して GET、PUT、POST、または DELETE 操作を実行できます。<token> は、以下の例の設定を取得または変更するために作成した OAuth アクセストークンに置き換えます。

第2章 Red Hat Quay アプリケーションプログラミングインターフェイス (API)
リンクのコピー

この API を使用すると、Red Hat Quay リポジトリー、ユーザー、および組織の使用に必要な多くの操作を実行できます。

2.1. 認可
リンクのコピー

oauth2_implicit

スコープ

以下のスコープは、API エンドポイントへのアクセスを制御するのに使用されます。

Expand

スコープ	説明
repo:read	このアプリケーションは、付与ユーザーまたはロボットアカウントに表示されるすべてのリポジトリーを表示し、プルできます。
repo:write	このアプリケーションは、付与ユーザーまたはロボットアカウントに書き込みのアクセス権が割り当てられているリポジトリーをすべて表示、プッシュ、およびプルできます。
repo:admin	このアプリケーションには、付与ユーザーまたはロボットアカウントがアクセスできるすべてのリポジトリーに管理者権限が割り当てられます。
repo:create	このアプリケーションは、付与ユーザーまたはロボットアカウントがリポジトリーを作成できる namespace にリポジトリーを作成できます。
user:read	このアプリケーションは、ユーザー名やメールアドレスなどのユーザー情報を読み取ることができます。
org:admin	このアプリケーションは、ロボットの作成、チームの作成、チームのメンバーシップの調整、請求設定の変更など、組織の管理を行うことができます。このパーミッションを付与する前に、要求元アプリケーションに絶対の信頼が必要です。
super:user	このアプリケーションは、ユーザーの管理、スーパーユーザーパネルにある組織およびその他の機能の管理など、インストールを管理できます。このパーミッションを付与する前に、要求元アプリケーションに絶対の信頼が必要です。
user:admin	このアプリケーションは、ロボットの作成、リポジトリーへのパーミッションを付与するなど、アカウントを管理できます。このパーミッションを付与する前に、要求元アプリケーションに絶対の信頼が必要です。

2.2. appspecifictokens
リンクのコピー

現在のユーザーのアプリケーション固有のトークンを管理します。

2.2.1. createAppToken
リンクのコピー

ユーザー向けに新規アプリケーション固有のトークンを作成します。

POST /api/v1/user/apptoken

認可: oauth2_implicit (user:admin)

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

新しいトークンの説明。

Expand

名前	説明	スキーマ
タイトル必須	トークンの特定に役立つ分かりやすい名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.2.2. listAppTokens
リンクのコピー

ユーザーのアプリケーション固有のトークンをリスト表示します。

GET /api/v1/user/apptoken

認可: oauth2_implicit (user:admin)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	expiring 任意	true の場合には、まもなく有効期限が切れるトークンのみを返します。	boolean

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.2.3. getAppToken
リンクのコピー

ユーザーの特定のアプリケーショントークンを返します。

GET /api/v1/user/apptoken/{token_uuid}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	token_uuid 必須	アプリケーション固有のトークンの uuid	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.2.4. revokeAppToken
リンクのコピー

ユーザーの特定のアプリケーショントークンを取り消します。

DELETE /api/v1/user/apptoken/{token_uuid}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	token_uuid 必須	アプリケーション固有のトークンの uuid	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3. build
リンクのコピー

リポジトリービルドの作成、リスト表示、キャンセル、およびステータス/ログの取得

2.3.1. getRepoBuildStatus
リンクのコピー

ビルドの uuid で指定したビルドのステータスを返します。

GET /api/v1/repository/{repository}/build/{build_uuid}/status

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3.2. getRepoBuildLogs
リンクのコピー

ビルド uuid で指定したビルドのビルドログを返します。

GET /api/v1/repository/{repository}/build/{build_uuid}/logs

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3.3. getRepoBuild
リンクのコピー

ビルドに関する情報を返します。

GET /api/v1/repository/{repository}/build/{build_uuid}

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3.4. cancelRepoBuild
リンクのコピー

リポジトリービルドをキャンセルします。

DELETE /api/v1/repository/{repository}/build/{build_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3.5. requestRepoBuild
リンクのコピー

指定の入力からリポジトリーをビルドし、プッシュすることを要求します。

POST /api/v1/repository/{repository}/build/

認可: oauth2_implicit (repo:write)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

新規リポジトリービルドの説明。

Expand

名前	説明	スキーマ
file_id 任意	ビルド仕様のアップロード時に生成されたファイル ID	string
archive_url 任意	ビルドする .tar.gz の URL。"http" または "https" で開始する必要があります。	string
subdirectory 任意	Dockerfile があるサブディレクトリー。このサブディレクトリーまたは dockerfile_path のみを指定できます。	string
dockerfile_path 任意	docker ファイルへのパス。このパスまたはサブディレクトリーのみを指定できます。	string
context 任意	dockerfile のコンテキストを指定します。これは任意です。	string
pull_robot 任意	プル認証情報として使用する Quay ロボットアカウントのユーザー名	string
タグ任意	ビルドイメージがプッシュされるタグ。指定のない場合は、"latest" が使用されます。	string の配列 `non-empty` `unique`

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.3.6. getRepoBuilds
リンクのコピー

リポジトリービルドのリストを取得します。

GET /api/v1/repository/{repository}/build/

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	since 任意	指定の unix タイムコード以降の全ビルドを返します。	integer
query	limit 任意	返すビルドの最大数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.4. discovery
リンクのコピー

API 検出情報。

2.4.1. discovery
リンクのコピー

Swagger API 形式で利用可能なすべての API エンドポイントをリスト表示します。

GET /api/v1/discovery

認可:

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	internal 任意	内部 API を含めるかどうか。	boolean

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.5. error
リンクのコピー

エラー詳細 API。

2.5.1. getErrorDescription
リンクのコピー

エラーの詳細情報を取得します。

GET /api/v1/error/{error_type}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	error_type 必須	エラーのタイプを特定するエラーコード。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し	ApiErrorDescription
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.6. globalmessages
リンクのコピー

メッセージ API。

2.6.1. createGlobalMessage
リンクのコピー

メッセージを作成します。

POST /api/v1/messages

認可: oauth2_implicit(super:user)

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

新規メッセージの作成

Expand

名前	説明	スキーマ
message 必須	単一メッセージ	object

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.6.2. getGlobalMessages
リンクのコピー

スーパーユーザーのメッセージを返します。

GET /api/v1/messages

認可:

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.6.3. deleteGlobalMessage
リンクのコピー

メッセージを削除します。

DELETE /api/v1/message/{uuid}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	uuid 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.7. logs
リンクのコピー

組織またはリポジトリーの使用状況ログにアクセスします。

2.7.1. getAggregateUserLogs
リンクのコピー

現在のユーザーの集計ログを返します。

GET /api/v1/user/aggregatelogs

認可: oauth2_implicit (user:admin)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	performer 任意	ログをフィルターするユーザー名。	string
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/user/aggregatelogs?performer=<username>&starttime=<MM/DD/YYYY>&endtime=<MM/DD/YYYY>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/user/aggregatelogs?performer=<username>&starttime=<MM/DD/YYYY>&endtime=<MM/DD/YYYY>"

Copy to Clipboard

Toggle word wrap

2.7.2. exportUserLogs
リンクのコピー

現在のユーザーの集計ログを返します。

POST /api/v1/user/exportlogs

認可: oauth2_implicit (user:admin)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

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

エクスポートログ操作の設定

Expand

名前	説明	スキーマ
callback_url 任意	エクスポートされたログに対するリンクで呼び出すコールバック URL	string
callback_email 任意	エクスポートされたログに対するリンクをメールで送信するメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "starttime": "<MM/DD/YYYY>",
        "endtime": "<MM/DD/YYYY>",
        "callback_email": "your.email@example.com"
      }' \
  "http://<quay-server.example.com>/api/v1/user/exportlogs"

Copy to Clipboard

Toggle word wrap

2.7.3. listUserLogs
リンクのコピー

現在のユーザーのログをリスト表示します。

GET /api/v1/user/logs

認可: oauth2_implicit (user:admin)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	performer 任意	ログをフィルターするユーザー名。	string
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/user/logs"

$ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/user/logs"

Copy to Clipboard

Toggle word wrap

2.7.4. getAggregateOrgLogs
リンクのコピー

指定した組織の集計ログを取得します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	performer 任意	ログをフィルターするユーザー名。	string
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"

Copy to Clipboard

Toggle word wrap

2.7.5. exportOrgLogs
リンクのコピー

指定した組織のログをエクスポートします。

POST /api/v1/organization/{orgname}/exportlogs

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

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

エクスポートログ操作の設定

Expand

名前	説明	スキーマ
callback_url 任意	エクスポートされたログに対するリンクで呼び出すコールバック URL	string
callback_email 任意	エクスポートされたログに対するリンクをメールで送信するメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "starttime": "<MM/DD/YYYY>",
        "endtime": "<MM/DD/YYYY>",
        "callback_email": "org.logs@example.com"
      }' \
  "http://<quay-server.example.com>/api/v1/organization/{orgname}/exportlogs"

Copy to Clipboard

Toggle word wrap

2.7.6. listOrgLogs
リンクのコピー

指定した組織のログをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	performer 任意	ログをフィルターするユーザー名。	string
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"

Copy to Clipboard

Toggle word wrap

2.7.7. getAggregateRepoLogs
リンクのコピー

指定したリポジトリーの集計ログを返します。

GET /api/v1/repository/{repository}/aggregatelogs

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/repository/<repository_name>/<namespace>/aggregatelogs?starttime=2024-01-01&endtime=2024-06-18""

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "<quay-server.example.com>/api/v1/repository/<repository_name>/<namespace>/aggregatelogs?starttime=2024-01-01&endtime=2024-06-18""

Copy to Clipboard

Toggle word wrap

2.7.8. exportRepoLogs
リンクのコピー

指定したリポジトリーのログのエクスポートをキューに入れます。

POST /api/v1/repository/{repository}/exportlogs

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

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

エクスポートログ操作の設定

Expand

名前	説明	スキーマ
callback_url 任意	エクスポートされたログに対するリンクで呼び出すコールバック URL	string
callback_email 任意	エクスポートされたログに対するリンクをメールで送信するメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "starttime": "2024-01-01",
        "endtime": "2024-06-18",
        "callback_url": "http://your-callback-url.example.com"
      }' \
  "http://<quay-server.example.com>/api/v1/repository/{repository}/exportlogs"

Copy to Clipboard

Toggle word wrap

2.7.9. listRepoLogs
リンクのコピー

指定したリポジトリーのログをリスト表示します。

GET /api/v1/repository/{repository}/logs

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	endtime 任意	ログの最新時間。形式: "%m/%d/%Y"(UTC)	string
query	starttime 任意	ログの最初の時間。形式: "%m/%d/%Y"(UTC)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "http://<quay-server.example.com>/api/v1/repository/{repository}/logs"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "http://<quay-server.example.com>/api/v1/repository/{repository}/logs"

Copy to Clipboard

Toggle word wrap

2.9. mirror
リンクのコピー

2.9.1. syncCancel
リンクのコピー

指定したリポジトリーのミラーリング設定の sync_status を更新します。

POST /api/v1/repository/{repository}/mirror/sync-cancel

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.9.2. syncNow
リンクのコピー

指定したリポジトリーのミラーリング設定の sync_status を更新します。

POST /api/v1/repository/{repository}/mirror/sync-now

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.9.3. getRepoMirrorConfig
リンクのコピー

指定したリポジトリーのミラーリング設定を返します。

GET /api/v1/repository/{repository}/mirror

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し	ViewMirrorConfig
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.9.4. changeRepoMirrorConfig
リンクのコピー

ユーザーがリポジトリーのミラーリング設定を変更できるようにします。

PUT /api/v1/repository/{repository}/mirror

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーミラーリング設定を更新します。

Expand

名前	説明	スキーマ
is_enabled 任意	同期を有効または無効にするために使用されます。	boolean
external_reference 任意	外部リポジトリーの場所。	string
external_registry_username 任意	外部レジストリーでの認証に使用されるユーザー名。
external_registry_password 任意	外部レジストリーでの認証に使用されるパスワード。
sync_start_date 任意	このリポジトリーの次の同期時間を決定します。	string
sync_interval 任意	next_start_date が同期を開始するまでの秒数。	integer
robot_username 任意	イメージのプッシュに使用されるロボットのユーザー名。	string
root_rule 任意	同期する必要のあるタグの判別に使用する glob パターンのリスト。	object
external_registry_config 任意		object

応答

Expand

HTTP コード	説明	スキーマ
201	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.9.5. createRepoMirrorConfig
リンクのコピー

特定のリポジトリーの RepoMirrorConfig を作成します。

POST /api/v1/repository/{repository}/mirror

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーのミラーリング設定を作成します。

Expand

名前	説明	スキーマ
is_enabled 任意	同期を有効または無効にするために使用されます。	boolean
external_reference 必須	外部リポジトリーの場所。	string
external_registry_username 任意	外部レジストリーでの認証に使用されるユーザー名。
external_registry_password 任意	外部レジストリーでの認証に使用されるパスワード。
sync_start_date 必須	このリポジトリーの次の同期時間を決定します。	string
sync_interval 必須	next_start_date が同期を開始するまでの秒数。	integer
robot_username 必須	イメージのプッシュに使用されるロボットのユーザー名。	string
root_rule 必須	同期する必要のあるタグの判別に使用する glob パターンのリスト。	object
external_registry_config 任意		object

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10. namespacequota
リンクのコピー

2.10.1. listUserQuota
リンクのコピー

GET /api/v1/user/quota

認可: oauth2_implicit (user:admin)

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.2. getOrganizationQuotaLimit
リンクのコピー

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

認可:

パスパラメーター

Expand

タイプ	名前	スキーマ
path	quota_id 必須	string
path	limit_id 必須	string
path	orgname 必須	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.3. changeOrganizationQuotaLimit
リンクのコピー

PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	スキーマ
path	quota_id 必須	string
path	limit_id 必須	string
path	orgname 必須	string

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

変更する組織のクォータ制限の説明

Expand

名前	説明	スキーマ
type 任意	割り当て制限のタイプ: "Warning" または "Reject"	string
threshold_percent 任意	クォータのしきい値 (クォータのパーセント単位)	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.4. deleteOrganizationQuotaLimit
リンクのコピー

DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	スキーマ
path	quota_id 必須	string
path	limit_id 必須	string
path	orgname 必須	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.5. createOrganizationQuotaLimit
リンクのコピー

POST /api/v1/organization/{orgname}/quota/{quota_id}/limit

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	orgname 必須		string

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

新しい組織のクォータ制限の説明

Expand

名前	説明	スキーマ
type 必須	割り当て制限のタイプ: "Warning" または "Reject"	string
threshold_percent 必須	クォータのしきい値 (クォータのパーセント単位)	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.6. listOrganizationQuotaLimit
リンクのコピー

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	orgname 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.7. getUserQuotaLimit
リンクのコピー

GET /api/v1/user/quota/{quota_id}/limit/{limit_id}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	limit_id 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.8. listUserQuotaLimit
リンクのコピー

GET /api/v1/user/quota/{quota_id}/limit

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.9. getOrganizationQuota
リンクのコピー

GET /api/v1/organization/{orgname}/quota/{quota_id}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	orgname 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.10. changeOrganizationQuota
リンクのコピー

PUT /api/v1/organization/{orgname}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	orgname 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 任意	組織で許可されているバイト数	integer
limits 任意	人間が判読可能な組織のストレージ容量。Mi、Gi、Ti などの SI 単位だけでなく、GB や MB などの非標準単位も受け入れます。`limit_bytes` と相互に排他的である必要があります。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.11. deleteOrganizationQuota
リンクのコピー

DELETE /api/v1/organization/{orgname}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string
path	orgname 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.12. createOrganizationQuota
リンクのコピー

新しい組織のクォータを作成します。

POST /api/v1/organization/{orgname}/quota

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 必須	組織で許可されているバイト数	integer
limits 任意	人間が判読可能な組織のストレージ容量。Mi、Gi、Ti などの SI 単位だけでなく、GB や MB などの非標準単位も受け入れます。`limit_bytes` と相互に排他的である必要があります。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.13. listOrganizationQuota
リンクのコピー

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

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.10.14. getUserQuota
リンクのコピー

GET /api/v1/user/quota/{quota_id}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	quota_id 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11. organization
リンクのコピー

組織、メンバーおよび OAuth アプリケーションを管理します。

2.11.1. createOrganization
リンクのコピー

新しい組織を作成します。

POST /api/v1/organization/

認可: oauth2_implicit (user:admin)

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

新しい組織の説明。

Expand

名前	説明	スキーマ
name 必須	組織のユーザー名	string
email 任意	組織の連絡先メール	string
recaptcha_response 任意	検証用の recaptcha 応答コード (無効となっている場合もある)。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST   -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json"   -d '{

$ curl -X POST   -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json"   -d '{
    "name": "<new_organization_name>"
  }'   "https://<quay-server.example.com>/api/v1/organization/"

Copy to Clipboard

Toggle word wrap

2.11.2. validateProxyCacheConfig
リンクのコピー

POST /api/v1/organization/{orgname}/validateproxycache

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須		string

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

組織のプロキシーキャッシュ設定

Expand

名前	説明	スキーマ
upstream_registry 必須	キャッシュされるアップストリームレジストリーの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
202	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.3. getOrganizationCollaborators
リンクのコピー

指定した組織の外部コラボレーターをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.4. getOrganizationApplication
リンクのコピー

指定の組織、指定の client_id のアプリケーションを取得します。

GET /api/v1/organization/{orgname}/applications/{client_id}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.5. updateOrganizationApplication
リンクのコピー

この組織のアプリケーションを更新します。

PUT /api/v1/organization/{orgname}/applications/{client_id}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

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

更新アプリケーションの説明。

Expand

名前	説明	スキーマ
name 必須	アプリケーションの名前	string
redirect_uri 必須	アプリケーションの OAuth リダイレクトの URI	string
application_uri 必須	アプリケーションのホームページの URI	string
description 任意	アプリケーションの人間が判読できる説明	string
avatar_email 任意	アプリケーションに使用するアバターのメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.6. deleteOrganizationApplication
リンクのコピー

この組織のアプリケーションを削除します。

DELETE /api/v1/organization/{orgname}/applications/{client_id}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.7. createOrganizationApplication
リンクのコピー

この組織に新しいアプリケーションを作成します。

POST /api/v1/organization/{orgname}/applications

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

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

新しい組織アプリケーションを説明します。

Expand

名前	説明	スキーマ
name 必須	アプリケーションの名前	string
redirect_uri 任意	アプリケーションの OAuth リダイレクトの URI	string
application_uri 任意	アプリケーションのホームページの URI	string
description 任意	アプリケーションの人間が判読できる説明	string
avatar_email 任意	アプリケーションに使用するアバターのメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.8. getOrganizationApplications
リンクのコピー

指定した組織のアプリケーションをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.9. getProxyCacheConfig
リンクのコピー

組織のプロキシーキャッシュ設定を取得します。

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

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.10. deleteProxyCacheConfig
リンクのコピー

組織のプロキシーキャッシュ設定を削除します。

DELETE /api/v1/organization/{orgname}/proxycache

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.11. createProxyCacheConfig
リンクのコピー

組織のプロキシーキャッシュ設定を作成します。

POST /api/v1/organization/{orgname}/proxycache

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

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

組織のプロキシーキャッシュ設定

Expand

名前	説明	スキーマ
upstream_registry 必須	キャッシュされるアップストリームレジストリーの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.12. getOrganizationMember
リンクのコピー

組織のメンバーの詳細を取得します。

GET /api/v1/organization/{orgname}/members/{membername}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	membername 必須	組織メンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.13. removeOrganizationMember
リンクのコピー

組織からメンバーを削除し、そのリポジトリーの特権をすべて破棄して組織の全チームから削除します。

DELETE /api/v1/organization/{orgname}/members/{membername}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	membername 必須	組織メンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.14. getOrganizationMembers
リンクのコピー

指定した組織のメンバー (人間) をリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.15. getOrganization
リンクのコピー

指定した組織の詳細を取得します。

GET /api/v1/organization/{orgname}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	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/organization/<organization_name>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>"

Copy to Clipboard

Toggle word wrap

2.11.16. changeOrganizationDetails
リンクのコピー

指定した組織の詳細を変更します。

PUT /api/v1/organization/{orgname}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

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

既存組織の更新の説明

Expand

名前	説明	スキーマ
email 任意	組織の連絡先メール	string
invoice_email 任意	組織が請求書のメールを受信する必要があるかどうか。	boolean
invoice_email_address 任意	請求書を受信するメールアドレス
tag_expiration_s 任意	タグの有効期限 (秒)	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.11.17. deleteAdminedOrganization
リンクのコピー

指定した組織を削除します。

DELETE /api/v1/organization/{orgname}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>"

Copy to Clipboard

Toggle word wrap

2.11.18. getApplicationInformation
リンクのコピー

指定したアプリケーションに関する情報を取得します。

GET /api/v1/app/{client_id}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12. permission
リンクのコピー

リポジトリーのパーミッションを管理します。

2.12.1. getUserTransitivePermission
リンクのコピー

指定したユーザーのパーミッションを取得します。

GET /api/v1/repository/{repository}/permissions/user/{username}/transitive

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	username 必須	パーミッションが適用されるユーザー名	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.2. getUserPermissions
リンクのコピー

指定したユーザーのパーミッションを取得します。

GET /api/v1/repository/{repository}/permissions/user/{username}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	username 必須	パーミッションが適用されるユーザーのユーザー名	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.3. changeUserPermissions
リンクのコピー

既存リポジトリーのパーミッションを更新します。

PUT /api/v1/repository/{repository}/permissions/user/{username}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	username 必須	パーミッションが適用されるユーザーのユーザー名	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

ユーザーパーミッションの説明。

Expand

名前	説明	スキーマ
ロールが必須	ユーザーに使用するロール	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{"role": "admin"}' \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{"role": "admin"}' \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

Copy to Clipboard

Toggle word wrap

2.12.4. deleteUserPermissions
リンクのコピー

ユーザーのパーミッションを削除します。

DELETE /api/v1/repository/{repository}/permissions/user/{username}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	username 必須	パーミッションが適用されるユーザーのユーザー名	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

Copy to Clipboard

Toggle word wrap

2.12.5. getTeamPermissions
リンクのコピー

指定したチームのパーミッションをフェッチします。

GET /api/v1/repository/{repository}/permissions/team/{teamname}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	teamname 必須	パーミッションが適用されるチームの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.6. changeTeamPermissions
リンクのコピー

既存のチームパーミッションを更新します。

PUT /api/v1/repository/{repository}/permissions/team/{teamname}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	teamname 必須	パーミッションが適用されるチームの名前	string

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

チームパーミッションの説明。

Expand

名前	説明	スキーマ
ロールが必須	チームに使用するロール	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.7. deleteTeamPermissions
リンクのコピー

指定したチームのパーミッションを削除します。

DELETE /api/v1/repository/{repository}/permissions/team/{teamname}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	teamname 必須	パーミッションが適用されるチームの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.8. listRepoTeamPermissions
リンクのコピー

すべてのチームパーミッションをリスト表示します。

GET /api/v1/repository/{repository}/permissions/team/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.12.9. listRepoUserPermissions
リンクのコピー

全ユーザーパーミッションをリスト表示します。

GET /api/v1/repository/{repository}/permissions/user/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/

Copy to Clipboard

Toggle word wrap

2.13. policy
リンクのコピー

2.13.1. createOrganizationAutoPrunePolicy
リンクのコピー

組織の自動プルーニングポリシーを作成します。

POST /api/v1/organization/{orgname}/autoprunepolicy/

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 必須	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 必須	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.2. listOrganizationAutoPrunePolicies
リンクのコピー

組織の自動プルーニングポリシーを一覧表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.3. getOrganizationAutoPrunePolicy
リンクのコピー

組織の自動プルーニングポリシーを取得します。

GET /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.4. deleteOrganizationAutoPrunePolicy
リンクのコピー

組織の自動プルーニングポリシーを削除します。

DELETE /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.5. updateOrganizationAutoPrunePolicy
リンクのコピー

組織の自動プルーニングポリシーを更新します。

PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string
path	policy_uuid required	ポリシーの一意の ID	string

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 必須	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 必須	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
204	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.6. createRepositoryAutoPrunePolicy
リンクのコピー

リポジトリーの自動プルーニングポリシーを作成します。

POST /api/v1/repository/{repository}/autoprunepolicy/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 任意	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 任意	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.7. listRepositoryAutoPrunePolicies
リンクのコピー

リポジトリーの自動プルーニングポリシーをリスト表示します。

GET /api/v1/repository/{repository}/autoprunepolicy/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.8. getRepositoryAutoPrunePolicy
リンクのコピー

リポジトリーの自動プルーニングポリシーを取得します。

GET /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.9. deleteRepositoryAutoPrunePolicy
リンクのコピー

リポジトリーの自動プルーニングポリシーを削除します。

DELETE /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.10. updateRepositoryAutoPrunePolicy
リンクのコピー

リポジトリーの自動プルーニングポリシーを更新します。

PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 任意	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 任意	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.11. createUserAutoPrunePolicy
リンクのコピー

現在ログインしているユーザーの自動プルーニングポリシーを作成します。

POST /api/v1/user/autoprunepolicy/

認可: oauth2_implicit (user:admin)

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 必須	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 必須	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.12. listUserAutoPrunePolicies
リンクのコピー

現在ログインしているユーザーの自動プルーニングポリシーをリスト表示します。

GET /api/v1/user/autoprunepolicy/

認可: oauth2_implicit (user:admin)

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.13. getUserAutoPrunePolicy
リンクのコピー

現在ログインしているユーザーの自動プルーニングポリシーを取得します。

GET /api/v1/user/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.14. deleteUserAutoPrunePolicy
リンクのコピー

現在ログインしているユーザーの自動プルーニングポリシーを削除します。

DELETE /api/v1/user/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.13.15. updateUserAutoPrunePolicy
リンクのコピー

現在ログインしているユーザーの自動プルーニングポリシーを更新します。

PUT /api/v1/user/autoprunepolicy/{policy_uuid}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	policy_uuid required	ポリシーの一意の ID	string

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

ユーザーの namespace に適用されるポリシー設定

Expand

Name	説明	スキーマ
method 必須	タグのプルーニングに使用するメソッド (number_of_tags、creation_date)	string
value 必須	プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

応答

Expand

HTTP コード	説明	スキーマ
204	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.14. prototype
リンクのコピー

リポジトリーに追加されたデフォルトのパーミッションを管理します。

2.14.1. updateOrganizationPrototypePermission
リンクのコピー

既存のパーミッションプロトタイプのロールを更新します。

PUT /api/v1/organization/{orgname}/prototypes/{prototypeid}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	prototypeid 必須	プロトタイプの ID	string
path	orgname 必須	組織の名前	string

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

新しいプロトタイプロールの説明

Expand

名前	説明	スキーマ
role 任意	パーミッションに適用する必要のあるロール	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{

$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{
    "role": "write"
  }' \
  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototypeid>

Copy to Clipboard

Toggle word wrap

2.14.2. deleteOrganizationPrototypePermission
リンクのコピー

既存のパーミッションのプロトタイプを削除します。

DELETE /api/v1/organization/{orgname}/prototypes/{prototypeid}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	prototypeid 必須	プロトタイプの ID	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>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototype_id>

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototype_id>

Copy to Clipboard

Toggle word wrap

2.14.3. createOrganizationPrototypePermission
リンクのコピー

新規パーミッションのプロトタイプを作成します。

POST /api/v1/organization/{orgname}/prototypes

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

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

新しいプロトタイプの説明

Expand

名前	説明	スキーマ
ロールが必須	委譲に適用する必要のあるロール	string
activating_user 任意	ルールが適用されるユーザーを作成するリポジトリー	object
委譲必須	ルールでアクセス権を付与するユーザーまたはチームに関する情報	object

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   --data '{

$ curl -X POST   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   --data '{
    "role": "<admin_read_or_write>",
    "delegate": {
      "name": "<username>",
      "kind": "user"
    },
    "activating_user": {
      "name": "<robot_name>"
    }
  }'   https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes

Copy to Clipboard

Toggle word wrap

2.14.4. getOrganizationPrototypePermissions
リンクのコピー

この組織の既存のプロトタイプをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes

Copy to Clipboard

Toggle word wrap

2.15. referrers
リンクのコピー

v2 API リファラーのリストを示します。

2.15.1. getReferrers
リンクのコピー

イメージダイジェストの v2 API リファラーのリストを示します。

GET /v2/{organization_name}/{repository_name}/referrers/{digest}

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

イメージダイジェストのリファラー。

Expand

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	referrers 必須	リポジトリー配下にあるマニフェストの OCI リファラーを検索します。	string

2.16. repository
リンクのコピー

リポジトリーをリスト表示、作成、管理します。

2.16.1. createRepo
リンクのコピー

新規リポジトリーを作成します。

POST /api/v1/repository

認可: oauth2_implicit(repo:create)

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

新規リポジトリーの説明

Expand

名前	説明	スキーマ
repository 必須	Repository name	string
visibility 必須	リポジトリーの初期の表示内容	string
namespace 任意	リポジトリーを作成する namespace。省略すると、呼び出し元のユーザー名が使用されます。	string
description 必須	リポジトリーの Markdown でエンコードされた説明	string
repo_kind 任意	リポジトリーの種類

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "repository": "<new_repository_name>",
    "visibility": "<public>",
    "description": "<This is a description of the new repository>."
  }' \
  "https://quay-server.example.com/api/v1/repository"

Copy to Clipboard

Toggle word wrap

2.16.2. listRepos
リンクのコピー

さまざまな状況で現在のユーザーに表示されるリポジトリーのリストを取得します。

GET /api/v1/repository

認可: oauth2_implicit(repo:read)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	repo_kind 任意	返すリポジトリーの種類	string
query	popularity 任意	リポジトリーの人気指標を含めるかどうか。	boolean
query	last_modified 任意	リポジトリーの最終変更時を含めるかどうか。	boolean
query	public 必須	公開されているリポジトリーをユーザーに表示するように追加します。	boolean
query	starred 必須	ユーザーがスターをつけたリポジトリーを返すようにフィルタリングします。	boolean
query	namespace 必須	この namespace に返されたリポジトリーをフィルターします。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.16.3. changeRepoVisibility
リンクのコピー

リポジトリーの可視性を変更します。

POST /api/v1/repository/{repository}/changevisibility

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーの可視性を変更します。

Expand

名前	説明	スキーマ
visibility 必須	リポジトリーの初期の表示内容	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.16.4. changeRepoState
リンクのコピー

リポジトリーの状態を変更します。

PUT /api/v1/repository/{repository}/changestate

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーの状態を変更します。

Expand

名前	説明	スキーマ
状態必須	プッシュが許可されるかどうかを決定します。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.16.5. getRepo
リンクのコピー

指定したリポジトリーを取得します。

GET /api/v1/repository/{repository}

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	includeTags 任意	リポジトリータグを含めるかどうか。	boolean
query	includeStats 任意	アクション統計を含めるかどうか。	boolean

応答

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/repository/<namespace>/<repository_name>"

$ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

Copy to Clipboard

Toggle word wrap

2.16.6. updateRepo
リンクのコピー

指定したリポジトリーにある説明を更新します。

PUT /api/v1/repository/{repository}

認可: oauth2_implicit (repo:write)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーで更新できるフィールド。

Expand

名前	説明	スキーマ
description 必須	リポジトリーの Markdown でエンコードされた説明	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.16.7. deleteRepository
リンクのコピー

リポジトリーを削除します。

DELETE /api/v1/repository/{repository}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	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/repository/<namespace>/<repository_name>"

$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

Copy to Clipboard

Toggle word wrap

2.17. repositorynotification
リンクのコピー

リポジトリーイベント/通知をリスト表示、作成、管理します。

2.17.1. testRepoNotification
リンクのコピー

このリポジトリーのテスト通知をキューに入れます。

POST /api/v1/repository/{repository}/notification/{uuid}/test

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	uuid 必須	通知の UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

Copy to Clipboard

Toggle word wrap

2.17.2. getRepoNotification
リンクのコピー

指定した通知の情報を取得します。

GET /api/v1/repository/{repository}/notification/{uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	uuid 必須	通知の UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

Copy to Clipboard

Toggle word wrap

2.17.3. deleteRepoNotification
リンクのコピー

指定した通知を削除します。

DELETE /api/v1/repository/{repository}/notification/{uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	uuid 必須	通知の UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/<uuid>

$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/<uuid>

Copy to Clipboard

Toggle word wrap

2.17.4. resetRepositoryNotificationFailures
リンクのコピー

リポジトリーの失敗通知を 0 件にリセットします。

POST /api/v1/repository/{repository}/notification/{uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	uuid 必須	通知の UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.17.5. createRepoNotification
リンクのコピー

POST /api/v1/repository/{repository}/notification/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

リポジトリーでの通知作成に関する情報

Expand

名前	説明	スキーマ
event 必須	通知が応答するイベント	string
method 必須	通知の方法 (メールや Web コールバックなど)	string
config 必須	特定の通知メソッドに関する JSON 設定情報	object
eventConfig 必須	特定の通知イベントに関する JSON 設定情報	object
title 任意	人間が判読できる通知のタイトル	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{
    "event": "<event>",
    "method": "<method>",
    "config": {
      "<config_key>": "<config_value>"
    },
    "eventConfig": {
      "<eventConfig_key>": "<eventConfig_value>"
    }
  }' \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/

Copy to Clipboard

Toggle word wrap

2.17.6. listRepoNotifications
リンクのコピー

指定したリポジトリーの通知をリスト表示します。

GET /api/v1/repository/{repository}/notification/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.18. robot
リンクのコピー

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

2.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

2.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

2.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"

$ 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

2.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

2.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"

$ 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

2.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

2.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>"

$ 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

2.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>"

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

2.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"

$ 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

2.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>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

Copy to Clipboard

Toggle word wrap

2.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>"

$ 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

2.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>"

$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

Copy to Clipboard

Toggle word wrap

2.19. search
リンクのコピー

すべてのレジストリーコンテキストに対して検索を実行します。

2.19.1. conductRepoSearch
リンクのコピー

指定したクエリーに一致するアプリケーションおよびリポジトリーのリストを取得します。

GET /api/v1/find/repositories

認可:

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	includeUsage 任意	使用状況のメタデータを含めるかどうか。	boolean
query	page 任意	ページ。	integer
query	query 任意	検索クエリー	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.19.2. conductSearch
リンクのコピー

指定したクエリーに一致するエンティティーおよびリソースのリストを取得します。

GET /api/v1/find/all

認可: oauth2_implicit(repo:read)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	query 任意	検索クエリー	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.19.3. getMatchingEntities
リンクのコピー

指定した接頭辞に一致するエンティティーのリストを取得します。

GET /api/v1/entities/{prefix}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	prefix 必須		string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	includeOrgs 任意	組織名を含めるかどうか。	boolean
query	includeTeams 任意	チーム名を含めるかどうか。	boolean
query	namespace 任意	組織エンティティーのクエリー時に使用する namespace。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.20. secscan
リンクのコピー

リポジトリーの脆弱性およびその他のセキュリティー情報をリスト表示および管理します。

2.20.1. getRepoManifestSecurity
リンクのコピー

GET /api/v1/repository/{repository}/manifest/{manifestref}/security

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	manifestref 必須	マニフェストのダイジェスト	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	vulnerabilities 任意	脆弱性情報を含めます	boolean

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/manifest/<manifest_digest>/security?vulnerabilities=<true_or_false>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/manifest/<manifest_digest>/security?vulnerabilities=<true_or_false>"

Copy to Clipboard

Toggle word wrap

2.21. superuser
リンクのコピー

スーパーユーザー API。

2.21.1. createInstallUser
リンクのコピー

新しいユーザーを作成します。

POST /api/v1/superuser/users/

認可: oauth2_implicit(super:user)

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

ユーザー作成のデータ

Expand

名前	説明	スキーマ
username 必須	作成されるユーザーの名前	string
email 任意	作成中のユーザーのメールアドレス	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{

$ curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{
  "username": "newuser",
  "email": "newuser@example.com"
}' "https://<quay-server.example.com>/api/v1/superuser/users/"

Copy to Clipboard

Toggle word wrap

2.21.2. deleteInstallUser
リンクのコピー

ユーザーを削除します。

DELETE /api/v1/superuser/users/{username}

認可: oauth2_implicit(super:user)

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

ユーザーを削除するためのデータ

Expand

Name	説明	スキーマ
username 必須	削除するユーザーのユーザー名	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"

$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"

Copy to Clipboard

Toggle word wrap

2.21.3. listAllUsers
リンクのコピー

システム内の全ユーザーリストを返します。

GET /api/v1/superuser/users/

認可: oauth2_implicit(super:user)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	limit 任意	ページごとに返す結果の数を制限します。最大 100 です。	integer
query	disabled 任意	false の場合には、有効なユーザーのみが返されます。	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/superuser/users/"

$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"

Copy to Clipboard

Toggle word wrap

2.21.4. listAllLogs
リンクのコピー

現在のシステムの使用状況ログをリスト表示します。

GET /api/v1/superuser/logs

認可: oauth2_implicit(super:user)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string
query	page 任意	ログのページ番号	integer
query	endtime 任意	最後にログを取得した時間 (%m/%d/%Y %Z)	string
query	starttime 任意	最初にログを取得する時間 (%m/%d/%Y %Z)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.5. listAllOrganizations
リンクのコピー

現在のシステムの組織をリスト表示します。

GET /api/v1/superuser/organizations

認可: oauth2_implicit(super:user)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
path	name 必須	管理対象の組織名	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/superuser/organizations/"

$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"

Copy to Clipboard

Toggle word wrap

2.21.6. createServiceKey
リンクのコピー

POST /api/v1/superuser/keys

認可: oauth2_implicit(super:user)

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

サービスキーの作成の説明

Expand

名前	説明	スキーマ
サービス必須	このキーで認証されるサービス	string
name 任意	サービスキーの判別しやすい名前	string
metadata 任意	このキーのメタデータのキー/値のペア	object
notes 任意	指定すると、キーにメモを追加で指定できます。	string
有効期限必須	unix タイムスタンプとしての有効期限

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.7. listServiceKeys
リンクのコピー

GET /api/v1/superuser/keys

認可: oauth2_implicit(super:user)

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.8. changeUserQuotaSuperUser
リンクのコピー

PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string
path	quota_id 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 任意	組織で許可されているバイト数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.9. deleteUserQuotaSuperUser
リンクのコピー

DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string
path	quota_id 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.10. createUserQuotaSuperUser
リンクのコピー

POST /api/v1/superuser/organization/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 必須	組織で許可されているバイト数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.11. listUserQuotaSuperUser
リンクのコピー

GET /api/v1/superuser/organization/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.12. changeOrganizationQuotaSuperUser
リンクのコピー

PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string
path	quota_id 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 任意	組織で許可されているバイト数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.13. deleteOrganizationQuotaSuperUser
リンクのコピー

DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string
path	quota_id 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.14. createOrganizationQuotaSuperUser
リンクのコピー

POST /api/v1/superuser/users/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

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

新しい組織の割り当ての説明

Expand

名前	説明	スキーマ
limit_bytes 任意	組織で許可されているバイト数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.15. listOrganizationQuotaSuperUser
リンクのコピー

GET /api/v1/superuser/users/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.16. changeOrganization
リンクのコピー

指定したユーザーの情報を更新します。

PUT /api/v1/superuser/organizations/{name}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	name 必須	管理する組織の名前	string

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

既存組織の更新の説明

Expand

名前	説明	スキーマ
email 任意	組織の連絡先メール	string
invoice_email 任意	組織が請求書のメールを受信する必要があるかどうか。	boolean
invoice_email_address 任意	請求書を受信するメールアドレス
tag_expiration_s 任意	タグの有効期限 (秒)	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.17. deleteOrganization
リンクのコピー

指定した組織を削除します。

DELETE /api/v1/superuser/organizations/{name}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	name 必須	管理する組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.18. approveServiceKey
リンクのコピー

POST /api/v1/superuser/approvedkeys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	kid 必須	サービスキーの一意識別子	string

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

サービスキーの承認に関する情報

Expand

名前	説明	スキーマ
notes 任意	オプションの承認に関する注意事項	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.19. deleteServiceKey
リンクのコピー

DELETE /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	kid 必須	サービスキーの一意識別子	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.20. updateServiceKey
リンクのコピー

PUT /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	kid 必須	サービスキーの一意識別子	string

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

サービスキーの更新の説明

Expand

名前	説明	スキーマ
name 任意	サービスキーの判別しやすい名前	string
metadata 任意	このキーのメタデータのキー/値のペア	object
expiration 任意	unix タイムスタンプとしての有効期限

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.21. getServiceKey
リンクのコピー

GET /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	kid 必須	サービスキーの一意識別子	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.22. getRepoBuildStatusSuperUser
リンクのコピー

ビルドの uuid で指定したビルドのステータスを返します。

GET /api/v1/superuser/{build_uuid}/status

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.23. getRepoBuildSuperUser
リンクのコピー

ビルドに関する情報を返します。

GET /api/v1/superuser/{build_uuid}/build

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.24. getRepoBuildLogsSuperUser
リンクのコピー

ビルド uuid で指定したビルドのビルドログを返します。

GET /api/v1/superuser/{build_uuid}/logs

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	build_uuid 必須	ビルドの UUID	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.25. getRegistrySize
リンクのコピー

GET /api/v1/superuser/registrysize/

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

イメージレジストリーサイズの説明

Expand

Name	説明	スキーマ
size_bytes* optional	組織で許可されているバイト数	integer
last_ran		integer
queued		boolean
running		boolean

応答

Expand

HTTP コード	説明	スキーマ
200	作成済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.21.26. postRegistrySize
リンクのコピー

POST /api/v1/superuser/registrysize/

認可: oauth2_implicit(super:user)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	namespace 必須		string

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

イメージレジストリーサイズの説明

Expand

Name	説明	スキーマ
last_ran		integer
queued		boolean
running		boolean

応答

Expand

HTTP コード	説明	スキーマ
201	作成済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.22. tag
リンクのコピー

リポジトリーのタグを管理します。

2.22.1. restoreTag
リンクのコピー

リポジトリーの以前のイメージに、リポジトリータグを復元します。

POST /api/v1/repository/{repository}/tag/{tag}/restore

認可: oauth2_implicit (repo:write)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	tag 必須	タグの名前	string

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

タグを特定のイメージに復元します。

Expand

名前	説明	スキーマ
manifest_digest 必須	指定されている場合には、使用する必要があるマニフェストダイジェスト。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{
    "manifest_digest": <manifest_digest>
  }' \
  quay-server.example.com/api/v1/repository/quayadmin/busybox/tag/test/restore

Copy to Clipboard

Toggle word wrap

2.22.2. changeTag
リンクのコピー

タグが参照するイメージを変更するか、新規タグを作成します。

PUT /api/v1/repository/{repository}/tag/{tag}

認可: oauth2_implicit (repo:write)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	tag 必須	タグの名前	string

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

特定のタグを変更します。

Expand

名前	説明	スキーマ
manifest_digest 任意	(指定されている場合) タグが参照すべきマニフェストダイジェスト
expiration 任意	(指定されている場合) イメージの有効期限

応答

Expand

HTTP コード	説明	スキーマ
201	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{

$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{
    "manifest_digest": "<manifest_digest>"
  }' \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/<tag>

Copy to Clipboard

Toggle word wrap

2.22.3. deleteFullTag
リンクのコピー

指定したリポジトリータグを削除します。

DELETE /api/v1/repository/{repository}/tag/{tag}

認可: oauth2_implicit (repo:write)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string
path	tag 必須	タグの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.22.4. listRepoTags
リンクのコピー

GET /api/v1/repository/{repository}/tag/

認可: oauth2_implicit(repo:read)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	onlyActiveTags 任意	アクティブなタグだけに絞り込みます。	boolean
query	page 任意	結果のページインデックス。デフォルトは 1 です。	integer
query	limit 任意	ページごとに返す結果の数を制限します。最大 100 です。	integer
query	filter_tag_name 任意	構文: <op>:<name> 操作に基づいてタグ名をフィルターします。<op> には 'like' または 'eq' を指定できます。	string
query	specificTag 任意	特定のタグだけに絞り込みます。	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Accept: application/json" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/

Copy to Clipboard

Toggle word wrap

2.23. team
リンクのコピー

組織のチームを作成、リスト表示、および管理します。

2.23.1. getOrganizationTeamPermissions
リンクのコピー

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

GET /api/v1/organization/{orgname}/team/{teamname}/permissions

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.23.2. updateOrganizationTeamMember
リンクのコピー

既存のチームにメンバーを追加または調整します。

PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	membername 必須	チームメンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

$ curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

Copy to Clipboard

Toggle word wrap

2.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.

Copy to Clipboard

Toggle word wrap

DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	membername 必須	チームメンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

Copy to Clipboard

Toggle word wrap

2.23.4. getOrganizationTeamMembers
リンクのコピー

指定したチームのメンバーのリストを取得します。

GET /api/v1/organization/{orgname}/team/{teamname}/members

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	orgname 必須	組織の名前	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	includePending 任意	保留中のメンバーを含めるかどうか。	boolean

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"

$ curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"

Copy to Clipboard

Toggle word wrap

2.23.5. inviteTeamMemberEmail
リンクのコピー

既存のチームに招待するメールアドレスを追加します。

PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	スキーマ
path	email 必須	string
path	teamname 必須	string
path	orgname 必須	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

$ curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

Copy to Clipboard

Toggle word wrap

2.23.6. deleteTeamMemberEmailInvite
リンクのコピー

チームへの参加を招待するメールアドレスを削除します。

DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	スキーマ
path	email 必須	string
path	teamname 必須	string
path	orgname 必須	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

Copy to Clipboard

Toggle word wrap

2.23.7. updateOrganizationTeam
リンクのコピー

指定したチームの組織全体のパーミッションを更新します。

注記

この API はチームの作成にも使用されます。

PUT /api/v1/organization/{orgname}/team/{teamname}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	orgname 必須	組織の名前	string

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

チームの説明

Expand

名前	説明	スキーマ
ロールが必須	チームに適用する必要のある組織全体のパーミッション	string
description 任意	チームの Markdown の説明	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -k -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H "Authorization: Bearer <bearer_token>"  --data '{"role": "creator"}' https://<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>

$ curl -k -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H "Authorization: Bearer <bearer_token>"  --data '{"role": "creator"}' https://<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>

Copy to Clipboard

Toggle word wrap

2.23.8. deleteOrganizationTeam
リンクのコピー

指定したチームを削除します。

DELETE /api/v1/organization/{orgname}/team/{teamname}

認可: oauth2_implicit(org:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	teamname 必須	チームの名前	string
path	orgname 必須	組織の名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"

Copy to Clipboard

Toggle word wrap

2.24. trigger
リンクのコピー

ビルドトリガーを作成、リスト表示、管理します。

2.24.1. activateBuildTrigger
リンクのコピー

指定したビルドトリガーをアクティブにします。

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

Expand

名前	説明	スキーマ
config 必須	任意の json	object
pull_robot 任意	イメージのプルに使用するロボットの名前	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.2. listTriggerRecentBuilds
リンクのコピー

指定したトリガーで開始するビルドをリスト表示します。

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	limit 任意	返すビルドの最大数	integer

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.3. manuallyStartBuildTrigger
リンクのコピー

指定したトリガーからビルドを手動で開始します。

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

ビルドトリガーをアクティベートするための実行パラメーター (任意)

Expand

名前	説明	スキーマ
branch_name 任意	(SCM のみ) 指定した場合のビルドするブランチの名前。	string
commit_sha 任意	(カスタムのみ) 指定されている場合は、git リポジトリーのチェックアウトに使用する ref/SHA1。	string
refs 任意	(SCM のみ) 指定されている場合のビルドの ref。

応答

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.4. getBuildTrigger
リンクのコピー

指定したビルドトリガーの情報を取得します。

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.5. updateBuildTrigger
リンクのコピー

指定したビルドトリガーを更新します。

PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

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

ビルドトリガーを更新するオプション

Expand

名前	説明	スキーマ
有効化必須	ビルドトリガーが有効かどうか。	boolean

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.6. deleteBuildTrigger
リンクのコピー

指定したビルドトリガーを削除します。

DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	trigger_uuid 必須	ビルドトリガーの UUID	string
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.24.7. listBuildTriggers
リンクのコピー

指定したリポジトリーのトリガーをリスト表示します。

GET /api/v1/repository/{repository}/trigger/

認可: oauth2_implicit(repo:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.25. user
リンクのコピー

現行ユーザーを管理します。

2.25.1. createStar
リンクのコピー

リポジトリーを表示します。

POST /api/v1/user/starred

認可: oauth2_implicit(repo:read)

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

Expand

名前	説明	スキーマ
namespace 必須	リポジトリーが属する namespace	string
repository 必須	Repository name	string

レスポンス

Expand

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.25.2. listStarredRepos
リンクのコピー

星付きのリポジトリーをすべてリスト表示します。

GET /api/v1/user/starred

認可: oauth2_implicit (user:admin)

クエリーパラメーター

Expand

タイプ	名前	説明	スキーマ
query	next_page 任意	次のページのページトークン	string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.25.3. getLoggedInUser
リンクのコピー

認証ユーザーのユーザー情報を取得します。

GET /api/v1/user/

認可: oauth2_implicit (user:read)

応答

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し	UserView
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.25.4. deleteStar
リンクのコピー

リポジトリーから星を削除します。

DELETE /api/v1/user/starred/{repository}

認可: oauth2_implicit (user:admin)

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	repository 必須	リポジトリーの完全パス (例: namespace/name)	string

レスポンス

Expand

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.25.5. getUserInformation
リンクのコピー

指定したユーザーのユーザー情報を取得します。

GET /api/v1/users/{username}

認可:

パスパラメーター

Expand

タイプ	名前	説明	スキーマ
path	username 必須		string

レスポンス

Expand

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

2.26. 定義
リンクのコピー

2.26.1. ApiError
リンクのコピー

Expand

名前	説明	スキーマ
status 任意	応答のステータスコード	integer
type 任意	エラーのタイプへの参照。	string
detail 任意	エラーの特定インスタンスの詳細。	string
title 任意	エラーのタイプを識別する一意のエラーコード。	string
error_message 任意	非推奨。	string
error_type 任意	非推奨。	string

2.26.2. UserView
リンクのコピー

Expand

名前	説明	スキーマ
verified 任意	ユーザーのメールアドレスが検証済みかどうか。	boolean
anonymous 任意	このユーザーデータがゲストユーザーを表す場合は True	boolean
email 任意	ユーザーのメールアドレス	string
avatar 任意	ユーザーのアイコンを表すアバターデータ	object
organizations 任意	ユーザーがメンバーとなっている組織に関する情報	object の配列。
logins 任意	ユーザーが認証された外部ログインプロバイダーのリスト	object の配列。
can_create_repo 任意	ユーザーにリポジトリー作成のパーミッションが割り当てられているかどうか。	boolean
preferred_namespace 任意	true の場合、ユーザーの namespace が表示されることが優先される namespace。	boolean

2.26.3. ViewMirrorConfig
リンクのコピー

Expand

名前	説明	スキーマ
is_enabled 任意	同期を有効または無効にするために使用されます。	boolean
external_reference 任意	外部リポジトリーの場所。	string
external_registry_username 任意	外部レジストリーでの認証に使用されるユーザー名。
external_registry_password 任意	外部レジストリーでの認証に使用されるパスワード。
sync_start_date 任意	このリポジトリーの次の同期時間を決定します。	string
sync_interval 任意	next_start_date が同期を開始するまでの秒数。	integer
robot_username 任意	イメージのプッシュに使用されるロボットのユーザー名。	string
root_rule 任意	同期する必要のあるタグの判別に使用する glob パターンのリスト。	object
external_registry_config 任意		object

2.26.4. ApiErrorDescription
リンクのコピー

Expand

名前	説明	スキーマ
type 任意	エラータイプリソースへの参照。	string
title 任意	エラーのタイトル。エラーの種類を一意に識別するために使用できます。	string
description 任意	問題の修正時に役立つ可能性のある詳細な説明。	string

法律上の通知
リンクのコピー

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

トップに戻る

名前	説明	スキーマ
key 必須	ラベルのキー	string
value 必須	ラベルの値	string
media_type 必須	このラベルのメディアタイプ

Red Hat Quay API ガイド

Red Hat Quay API ガイド

はじめにリンクのコピーリンクがクリップボードにコピーされました!

第1章 Red Hat Quay API の使用リンクのコピーリンクがクリップボードにコピーされました!

1.1. Quay.io からの Quay API へのアクセスリンクのコピーリンクがクリップボードにコピーされました!

1.2. v1 OAuth アクセストークンの作成リンクのコピーリンクがクリップボードにコピーされました!

1.3. OCI リファラー OAuth アクセストークンの作成リンクのコピーリンクがクリップボードにコピーされました!

1.4. OAuth アクセストークンの再割り当てリンクのコピーリンクがクリップボードにコピーされました!

1.5. Web ブラウザーからの Quay API へのアクセスリンクのコピーリンクがクリップボードにコピーされました!

1.6. コマンドラインでの Red Hat Quay API へのアクセスリンクのコピーリンクがクリップボードにコピーされました!

第2章 Red Hat Quay アプリケーションプログラミングインターフェイス (API)リンクのコピーリンクがクリップボードにコピーされました!

2.1. 認可リンクのコピーリンクがクリップボードにコピーされました!

スコープ

2.2. appspecifictokensリンクのコピーリンクがクリップボードにコピーされました!

2.2.1. createAppTokenリンクのコピーリンクがクリップボードにコピーされました!

POST /api/v1/user/apptoken

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

レスポンス

2.2.2. listAppTokensリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/user/apptoken

クエリーパラメーター

応答

2.2.3. getAppTokenリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/user/apptoken/{token_uuid}

パスパラメーター

レスポンス

2.2.4. revokeAppTokenリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/user/apptoken/{token_uuid}

パスパラメーター

レスポンス

2.3. buildリンクのコピーリンクがクリップボードにコピーされました!

2.3.1. getRepoBuildStatusリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/build/{build_uuid}/status

パスパラメーター

レスポンス

2.3.2. getRepoBuildLogsリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/build/{build_uuid}/logs

パスパラメーター

レスポンス

2.3.3. getRepoBuildリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/build/{build_uuid}

パスパラメーター

レスポンス

2.3.4. cancelRepoBuildリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/repository/{repository}/build/{build_uuid}

パスパラメーター

レスポンス

2.3.5. requestRepoBuildリンクのコピーリンクがクリップボードにコピーされました!

POST /api/v1/repository/{repository}/build/

パスパラメーター

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

応答

2.3.6. getRepoBuildsリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/build/

パスパラメーター

クエリーパラメーター

レスポンス

2.4. discoveryリンクのコピーリンクがクリップボードにコピーされました!

2.4.1. discoveryリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/discovery

クエリーパラメーター

応答

2.5. errorリンクのコピーリンクがクリップボードにコピーされました!

2.5.1. getErrorDescriptionリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/error/{error_type}

パスパラメーター

レスポンス

2.6. globalmessagesリンクのコピーリンクがクリップボードにコピーされました!

2.6.1. createGlobalMessageリンクのコピーリンクがクリップボードにコピーされました!

POST /api/v1/messages

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

応答

2.6.2. getGlobalMessagesリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/messages

応答

2.6.3. deleteGlobalMessageリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/message/{uuid}

パスパラメーター

レスポンス

2.7. logsリンクのコピーリンクがクリップボードにコピーされました!

はじめに
リンクのコピー

第1章 Red Hat Quay API の使用
リンクのコピー

1.1. Quay.io からの Quay API へのアクセス
リンクのコピー

1.2. v1 OAuth アクセストークンの作成
リンクのコピー

1.3. OCI リファラー OAuth アクセストークンの作成
リンクのコピー

1.4. OAuth アクセストークンの再割り当て
リンクのコピー

1.5. Web ブラウザーからの Quay API へのアクセス
リンクのコピー

1.6. コマンドラインでの Red Hat Quay API へのアクセス
リンクのコピー

第2章 Red Hat Quay アプリケーションプログラミングインターフェイス (API)
リンクのコピー

2.1. 認可
リンクのコピー

2.2. appspecifictokens
リンクのコピー

2.2.1. createAppToken
リンクのコピー

2.2.2. listAppTokens
リンクのコピー

2.2.3. getAppToken
リンクのコピー

2.2.4. revokeAppToken
リンクのコピー

2.3. build
リンクのコピー

2.3.1. getRepoBuildStatus
リンクのコピー

2.3.2. getRepoBuildLogs
リンクのコピー

2.3.3. getRepoBuild
リンクのコピー

2.3.4. cancelRepoBuild
リンクのコピー

2.3.5. requestRepoBuild
リンクのコピー

2.3.6. getRepoBuilds
リンクのコピー

2.4. discovery
リンクのコピー

2.4.1. discovery
リンクのコピー

2.5. error
リンクのコピー

2.5.1. getErrorDescription
リンクのコピー

2.6. globalmessages
リンクのコピー

2.6.1. createGlobalMessage
リンクのコピー

2.6.2. getGlobalMessages
リンクのコピー

2.6.3. deleteGlobalMessage
リンクのコピー

2.7. logs
リンクのコピー

2.7.1. getAggregateUserLogs
リンクのコピー

2.7.2. exportUserLogs
リンクのコピー

2.7.3. listUserLogs
リンクのコピー

2.7.4. getAggregateOrgLogs
リンクのコピー

2.7.5. exportOrgLogs
リンクのコピー

2.7.6. listOrgLogs
リンクのコピー

2.7.7. getAggregateRepoLogs
リンクのコピー

2.7.8. exportRepoLogs
リンクのコピー

2.7.9. listRepoLogs
リンクのコピー

2.8. マニフェスト
リンクのコピー

2.8.1. getManifestLabel
リンクのコピー

2.8.2. deleteManifestLabel
リンクのコピー

2.8.3. addManifestLabel
リンクのコピー