Red Hat Quay API ガイド

Red Hat Quay 3

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 を提供します。

  • 各 Red Hat Quay インスタンスのエンドポイント (URL https://<yourquayhost>/api/v1) から利用できます。
  • Swagger UI を有効にして、ブラウザー経由でエンドポイントに接続し、Red Hat Quay の設定を取得、削除、投稿、および配置できます。
  • API 呼び出しを実行し、OAuth トークンを使用するアプリケーションからアクセスできます。
  • JSON としてデータを送受信します。

以下のテキストは、Red Hat Quay API にアクセスし、API を使用して 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/

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

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

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

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

1.2. OAuth アクセストークンの作成

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

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

前提条件

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

手順

  1. メインページで、Organization を選択します。
  2. ナビゲーションペインで、Applications を選択します。
  3. Create New Application をクリックし、新しいアプリケーション名を入力して、Enter を押します。
  4. OAuth Applications ページで、アプリケーションの名前を選択します。
  5. オプション: 以下の情報を入力します。

    1. Application Name
    2. Homepage URL
    3. Description
    4. Avatar E-mail
    5. Redirect/Callback URL prefix
  6. ナビゲーションペインで、Generate Token を選択します。
  7. 次のオプションのチェックボックスをオンにします。

    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
  8. Generate Access Token をクリックします。新しいページにリダイレクトされます。
  9. 許可する権限を確認し、Authorize Application をクリックします。Authorize Application をクリックして決定した内容を確定します。
  10. Access Token ページにリダイレクトされます。アクセストークンをコピーして保存します。

    重要

    これは、アクセストークンをコピーして保存する唯一の機会です。このページを離れると再取得できません。

1.3. Web ブラウザーからの Quay API へのアクセス

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

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

この方法で API にアクセスしても、Red Hat Quay インストールで利用可能なスーパーユーザーエンドポイントにはアクセスできません。以下は、swagger-ui コンテナーイメージを実行してローカルシステムで実行されている Red Hat Quay API インターフェイスにアクセスする例です。

# export SERVER_HOSTNAME=<yourhostname>
# sudo podman run -p 8888:8080 -e API_URL=https://$SERVER_HOSTNAME:8443/api/v1/discovery docker.io/swaggerapi/swagger-ui

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

1.4. コマンドラインでの Red Hat Quay API へのアクセス

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

1.4.1. スーパーユーザー情報の取得

$ curl -X GET -H "Authorization: Bearer <token_here>" \
    "https://<yourquayhost>/api/v1/superuser/users/"

以下に例を示します。

$ curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
    {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

1.4.2. API を使用したスーパーユーザーの作成

  • Quay のデプロイで説明されているようにスーパーユーザー名を設定します。

    • 設定エディター UI を使用します。または、
    • 設定 API を使用して更新された設定バンドルを検証 (およびダウンロード) して、config.yaml ファイルを直接編集します。
  • スーパーユーザー名のユーザーアカウントを作成します。

    • 上記のように承認トークンを取得し、curl を使用してユーザーを作成します。

      $ curl -H "Content-Type: application/json"  -H "Authorization: Bearer Fava2kV9C92p1eXnMawBZx9vTqVnksvwNm0ckFKZ" -X POST --data '{
       "username": "quaysuper",
       "email": "quaysuper@example.com"
      }'  http://quay-server:8080/api/v1/superuser/users/ | jq
    • 返されるコンテンツには、新規ユーザーアカウント用に生成されたパスワードが含まれます。

      {
        "username": "quaysuper",
        "email": "quaysuper@example.com",
        "password": "EH67NB3Y6PTBED8H0HC6UVHGGGA3ODSE",
        "encrypted_password": "fn37AZAUQH0PTsU+vlO9lS0QxPW9A/boXL4ovZjIFtlUPrBz9i4j9UDOqMjuxQ/0HTfy38goKEpG8zYXVeQh3lOFzuOjSvKic2Vq7xdtQsU="
      }

ユーザーのリストを要求すると、quaysuper がスーパーユーザーとして表示されます。

$ curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
  {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    },
    {
      "kind": "user",
      "name": "quaysuper",
      "username": "quaysuper",
      "email": "quaysuper@example.com",
      "verified": true,
      "avatar": {
        "name": "quaysuper",
        "hash": "c0e0f155afcef68e58a42243b153df08",
        "color": "#969696",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

1.4.3. 使用状況ログのリスト表示

内部 API /api/v1/superuser/logs を使用して、現在のシステムの使用状況ログをリスト表示できます。結果はページネーションされます。以下の例では、20 以上のリポジトリーを作成し、複数の呼び出しを使用して結果セット全体にアクセスする方法を紹介しています。

1.4.3.1. ページネーションの例

最初の呼び出し

$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs | jq

初期出力

{
  "start_time": "Sun, 12 Dec 2021 11:41:55 -0000",
  "end_time": "Tue, 14 Dec 2021 11:41:55 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t21",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:16 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t20",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:05 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
...

   {
      "kind": "create_repo",
      "metadata": {
        "repo": "t2",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:17 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    }
  ],
  "next_page": "gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5"
}

next_page を使用した 2 回目の呼び出し

$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs?next_page=gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5 | jq

2 回目の呼び出しからの出力

{
  "start_time": "Sun, 12 Dec 2021 11:42:46 -0000",
  "end_time": "Tue, 14 Dec 2021 11:42:46 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t1",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:07 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    ...
  ]
}

1.4.4. ディレクトリーの同期

LDAP の対応するグループ名が ldapgroup となる testadminorg 組織の newteam チームのディレクトリーの同期を有効にするには、以下を実行します。

$ curl -X POST -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       -H "Content-type: application/json" \
       -d '{"group_dn": "cn=ldapgroup,ou=Users"}' \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

同じチームの同期を無効にするには、以下を実行します。

$ curl -X DELETE -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

1.4.5. API を使用したリポジトリービルドの作成

指定の入力からリポジトリーをビルドし、ビルドにカスタムタグを付けるには、requestRepoBuild エンドポイントを使用できます。以下のデータを使用できます。

{
"docker_tags": [
   "string"
],
"pull_robot": "string",
"subdirectory": "string",
"archive_url": "string"
}

archive_url パラメーターは、Dockerfile とビルドに必要な他のファイルが含まれる tar または zip アーカイブを参照する必要があります。file_id パラメーターは、以前のビルドシステムに含まれていましたが、これは今後使用できません。Dockerfile がサブディレクトリーにある場合は、これも指定する必要があります。

アーカイブは一般に公開されている必要があります。組織の管理者のみがロボットのアカウントトークンにアクセスできるため、OAuth アプリには Administer Organization スコープが必要です。そうしないと、誰かがロボットに対するビルドアクセスを割り当てるだけで、ロボットパーミッションを取得し、そのパーミッションを使用してイメージコンテンツを取得できるようになります。エラーが発生した場合は、返される json ブロックを確認し、アーカイブの場所、プルロボット、およびその他のパラメーターが正しく指定されていることを確認します。個別のビルドページの右上にある Download logs をクリックし、詳細なメッセージがないかログを確認します。

1.4.6. 組織のロボットの作成

$ curl -X PUT https://quay.io/api/v1/organization/{orgname}/robots/{robot shortname} \
   -H 'Authorization: Bearer <token>''

1.4.7. ビルドのトリガー

$ curl -X POST https://quay.io/api/v1/repository/YOURORGNAME/YOURREPONAME/build/ \
   -H 'Authorization: Bearer <token>'

要求のある Python

import requests
r = requests.post('https://quay.io/api/v1/repository/example/example/image', headers={'content-type': 'application/json', 'Authorization': 'Bearer <redacted>'}, data={[<request-body-contents>})
print(r.text)

1.4.8. プライベートリポジトリーの作成

$ curl -X POST https://quay.io/api/v1/repository \
    -H 'Authorization: Bearer {token}' \
    -H 'Content-Type: application/json' \
    -d '{"namespace":"yournamespace", "repository":"yourreponame",
    "description":"descriptionofyourrepo", "visibility": "private"}' | jq

1.4.9. ミラーリングされたリポジトリーの作成

最小設定

curl -X POST
  -H "Authorization: Bearer ${bearer_token}"
  -H "Content-Type: application/json"
  --data '{"external_reference": "quay.io/minio/mc", "external_registry_username": "", "sync_interval": 600, "sync_start_date": "2021-08-06T11:11:39Z", "root_rule": {"rule_kind": "tag_glob_csv", "rule_value": [ "latest" ]}, "robot_username": "orga+robot"}' https://${quay_registry}/api/v1/repository/${orga}/${repo}/mirror | jq

拡張設定

$ curl -X POST
  -H "Authorization: Bearer ${bearer_token}"
  -H "Content-Type: application/json"
  --data '{"is_enabled": true, "external_reference": "quay.io/minio/mc", "external_registry_username": "username", "external_registry_password": "password", "external_registry_config": {"unsigned_images":true, "verify_tls": false, "proxy": {"http_proxy": "http://proxy.tld", "https_proxy": "https://proxy.tld", "no_proxy": "domain"}}, "sync_interval": 600, "sync_start_date": "2021-08-06T11:11:39Z", "root_rule": {"rule_kind": "tag_glob_csv", "rule_value": [ "*" ]}, "robot_username": "orga+robot"}' https://${quay_registry}/api/v1/repository/${orga}/${repo}/mirror | jq

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

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

2.1. 承認

oauth2_implicit

スコープ

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

スコープDescription

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)

新しいトークンの説明。

名前説明スキーマ

friendlyName
任意

トークンの特定に役立つ分かりやすい名前

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.2.2. listAppTokens

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

GET /api/v1/user/apptoken

承認: oauth2_implicit(user:admin)

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

query

expiring
任意

true の場合には、まもなく有効期限が切れるトークンのみを返します。

boolean

応答
HTTP コードDescriptionスキーマ

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)

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

path

token_uuid
必須

アプリケーション固有のトークンの uuid

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

token_uuid
必須

アプリケーション固有のトークンの uuid

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

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

docker_tags
任意

ビルドイメージがプッシュされるタグ。指定のない場合は、latest が使用されます。

string の配列
non-empty unique

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

since
任意

指定の unix タイムコード以降の全ビルドを返します。

integer

query

limit
任意

返すビルドの最大数

integer

応答
HTTP コードDescriptionスキーマ

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

承認: 

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

query

internal
任意

内部 API を含めるかどうか。

boolean

応答
HTTP コードDescriptionスキーマ

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}

承認: 

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

path

error_type
必須

エラーのタイプを特定するエラーコード。

string

レスポンス
HTTP コードDescriptionスキーマ

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)

新規メッセージの作成

名前説明スキーマ

message
任意

単一メッセージ

object

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.6.2. getGlobalMessages

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

GET /api/v1/messages

承認: 

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.6.3. deleteGlobalMessage

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

DELETE /api/v1/message/{uuid}

承認: oauth2_implicit(super:user)

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

path

uuid
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

query

performer
任意

ログをフィルターするユーザー名。

string

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.2. exportUserLogs

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

POST /api/v1/user/exportlogs

承認: oauth2_implicit(user:admin)

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

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

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

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

名前説明スキーマ

callback_url
任意

エクスポートされたログに対するリンクで呼び出すコールバック URL

string

callback_email
任意

エクスポートされたログに対するリンクをメールで送信するメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.3. listUserLogs

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

GET /api/v1/user/logs

承認: oauth2_implicit(user:admin)

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

query

next_page
任意

次のページのページトークン

string

query

performer
任意

ログをフィルターするユーザー名。

string

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.4. getAggregateOrgLogs

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

query

performer
任意

ログをフィルターするユーザー名。

string

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.5. exportOrgLogs

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

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

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

名前説明スキーマ

callback_url
任意

エクスポートされたログに対するリンクで呼び出すコールバック URL

string

callback_email
任意

エクスポートされたログに対するリンクをメールで送信するメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.6. listOrgLogs

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

query

next_page
任意

次のページのページトークン

string

query

performer
任意

ログをフィルターするユーザー名。

string

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.7. getAggregateRepoLogs

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.8. exportRepoLogs

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

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

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

名前説明スキーマ

callback_url
任意

エクスポートされたログに対するリンクで呼び出すコールバック URL

string

callback_email
任意

エクスポートされたログに対するリンクをメールで送信するメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.7.9. listRepoLogs

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

next_page
任意

次のページのページトークン

string

query

endtime
任意

ログの最新時間。形式: "%m/%d/%Y"(UTC)

string

query

starttime
任意

ログの最初の時間。形式: "%m/%d/%Y"(UTC)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.8. manifest

リポジトリーのマニフェストを管理します。

2.8.1. getManifestLabel

マニフェストで特定の ID のラベルを取得します。

GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

承認: oauth2_implicit(repo:read)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

path

labelid
必須

ラベルの ID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.8.2. deleteManifestLabel

マニフェストから既存のラベルを削除します。

DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

承認: oauth2_implicit (repo:write)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

path

labelid
必須

ラベルの ID

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.8.3. addManifestLabel

タグマニフェストに新規ラベルを追加します。

POST /api/v1/repository/{repository}/manifest/{manifestref}/labels

承認: oauth2_implicit (repo:write)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

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

マニフェストにラベルを追加します。

名前説明スキーマ

key
任意

ラベルのキー

string

value
任意

ラベルの値

string

media_type
任意

このラベルのメディアタイプ

 
応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.8.4. listManifestLabels

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

承認: oauth2_implicit(repo:read)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

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

query

filter
必須

これが指定されている場合には、指定の接頭辞に一致するラベルのみが返されます。

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.8.5. getRepoManifest

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

承認: oauth2_implicit(repo:read)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.9. mirror

2.9.1. syncCancel

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

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

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

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

応答
HTTP コードDescriptionスキーマ

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)

応答
HTTP コードDescriptionスキーマ

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}

承認: 

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

path

quota_id
必須

 

string

path

limit_id
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

limit_id
必須

 

string

path

orgname
必須

 

string

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

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

名前説明スキーマ

type
任意

割り当て制限のタイプ: 警告または拒否

string

threshold_percent
必須

クォータのしきい値 (クォータのパーセント単位)

integer

応答
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

limit_id
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

orgname
必須

 

string

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

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

名前説明スキーマ

type
任意

割り当て制限のタイプ: 警告または拒否

string

threshold_percent
必須

クォータのしきい値 (クォータのパーセント単位)

integer

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.10.6. listOrganizationQuotaLimit

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

承認: 

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

path

quota_id
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

limit_id
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.10.9. getOrganizationQuota

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

承認: 

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

path

quota_id
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

orgname
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

orgname
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.10.13. listOrganizationQuota

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

承認: 

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

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

quota_id
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11. 組織

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

2.11.1. createOrganization

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

POST /api/v1/organization/

承認: oauth2_implicit(user:admin)

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

新しい組織の説明。

名前説明スキーマ

name
任意

組織のユーザー名

string

email
任意

組織の連絡先メール

string

recaptcha_response
任意

検証用の recaptcha 応答コード (無効となっている場合もある)。

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.2. validateProxyCacheConfig

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

承認: 

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

path

orgname
必須

 

string

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

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

名前説明スキーマ

upstream_registry
任意

キャッシュされるアップストリームレジストリーの名前

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.3. getOrganizationCollaborators

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

client_id
必須

OAuth クライアント ID

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

client_id
必須

OAuth クライアント ID

string

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

name
任意

アプリケーションの名前

string

redirect_uri
任意

アプリケーションの OAuth リダイレクトの URI

string

application_uri
任意

アプリケーションのホームページの URI

string

description
任意

アプリケーションの人間が判読できる説明

string

avatar_email
任意

アプリケーションに使用するアバターのメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

client_id
必須

OAuth クライアント ID

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

name
任意

アプリケーションの名前

string

redirect_uri
任意

アプリケーションの OAuth リダイレクトの URI

string

application_uri
任意

アプリケーションのホームページの URI

string

description
任意

アプリケーションの人間が判読できる説明

string

avatar_email
任意

アプリケーションに使用するアバターのメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.9. getProxyCacheConfig

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

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

承認: 

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.10. deleteProxyCacheConfig

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

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

承認: 

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.11. createProxyCacheConfig

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

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

承認: 

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

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

upstream_registry
必須

キャッシュされるアップストリームレジストリーの名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

membername
必須

組織メンバーのユーザー名

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

membername
必須

組織メンバーのユーザー名

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.15. getOrganization

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

GET /api/v1/organization/{orgname}

承認: 

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.16. changeOrganizationDetails

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

PUT /api/v1/organization/{orgname}

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

既存組織の更新の説明

名前説明スキーマ

email
任意

組織の連絡先メール

string

invoice_email
任意

組織が請求書のメールを受信する必要があるかどうか

boolean

invoice_email_address
任意

請求書を受信するメールアドレス

 

tag_expiration_s
任意

タグの有効期限 (秒)

integer

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.17. deleteAdminedOrganization

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

DELETE /api/v1/organization/{orgname}

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.11.18. getApplicationInformation

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

GET /api/v1/app/{client_id}

承認: 

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

path

client_id
必須

OAuth クライアント ID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.12. パーミッション

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

2.12.1. getUserTransitivePermission

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

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

承認: oauth2_implicit(repo:admin)

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

path

username
必須

パーミッションが適用されるユーザー名

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

username
必須

パーミッションが適用されるユーザーのユーザー名

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

username
必須

パーミッションが適用されるユーザーのユーザー名

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

role
任意

ユーザーに使用するロール

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.12.4. deleteUserPermissions

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

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

承認: oauth2_implicit(repo:admin)

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

path

username
必須

パーミッションが適用されるユーザーのユーザー名

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.12.5. getTeamPermissions

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

teamname
必須

パーミッションが適用されるチームの名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

teamname
必須

パーミッションが適用されるチームの名前

string

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

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

名前説明スキーマ

role
任意

チームに使用するロール

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

teamname
必須

パーミッションが適用されるチームの名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13. policy

2.13.1. listOrganizationAutoPrunePolicies

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.2. createOrganizationAutoPrunePolicy

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

method
任意

タグのプルーニングに使用するメソッド (number_of_tags、creation_date)

string

value
任意

プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

 
レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.3. deleteOrganizationAutoPrunePolicy

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

path

policy_uuid
required

ポリシーの一意の ID

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.4. updateOrganizationAutoPrunePolicy

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

path

policy_uuid
required

ポリシーの一意の ID

string

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

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

名前説明スキーマ

method
任意

タグのプルーニングに使用するメソッド (number_of_tags、creation_date)

string

value
任意

プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

 
レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.5. getOrganizationAutoPrunePolicy

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

path

policy_uuid
required

ポリシーの一意の ID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.6. listUserAutoPrunePolicies

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

GET /api/v1/user/autoprunepolicy/

承認: oauth2_implicit(user:admin)

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.7. createUserAutoPrunePolicy

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

POST /api/v1/user/autoprunepolicy/

承認: oauth2_implicit(user:admin)

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

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

名前説明スキーマ

method
任意

タグのプルーニングに使用するメソッド (number_of_tags、creation_date)

string

value
任意

プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

 
レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.8. deleteUserAutoPrunePolicy

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

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

承認: oauth2_implicit(user:admin)

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

path

policy_uuid
required

ポリシーの一意の ID

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.9. updateUserAutoPrunePolicy

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

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

承認: oauth2_implicit(user:admin)

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

path

policy_uuid
required

ポリシーの一意の ID

string

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

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

名前説明スキーマ

method
任意

タグのプルーニングに使用するメソッド (number_of_tags、creation_date)

string

value
任意

プルーニング方法に使用する値 (タグの数 (例: 10)、時間デルタ (例: 7d (7 日)))

 
レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.13.10. getUserAutoPrunePolicy

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

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

承認: oauth2_implicit(user:admin)

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

path

policy_uuid
required

ポリシーの一意の ID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

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)

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

path

prototypeid
必須

プロトタイプの ID

string

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

role
任意

パーミッションに適用する必要のあるロール

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.2. deleteOrganizationPrototypePermission

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

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

承認: oauth2_implicit(org:admin)

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

path

prototypeid
必須

プロトタイプの ID

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.3. createOrganizationPrototypePermission

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

role
任意

委譲に適用する必要のあるロール

string

activating_user
任意

ルールが適用されるユーザーを作成するリポジトリー

object

delegate
任意

ルールでアクセス権を付与するユーザーまたはチームに関する情報

object

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.4. getOrganizationPrototypePermissions

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15. repository

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

2.15.1. createRepo

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

POST /api/v1/repository

承認: oauth2_implicit(repo:create)

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

新規リポジトリーの説明

名前説明スキーマ

repository
必須

リポジトリー名

string

visibility
必須

リポジトリーの初期の表示内容

string

namespace
必須

リポジトリーを作成する namespace。省略すると、呼び出し元のユーザー名が使用されます。

string

description
必須

リポジトリーの Markdown でエンコードされた説明

string

repo_kind
任意

リポジトリーの種類

 
応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.2. listRepos

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

GET /api/v1/repository

承認: oauth2_implicit(repo:read)

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

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

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.3. changeRepoVisibility

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

visibility
任意

リポジトリーの初期の表示内容

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.4. changeRepoState

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

state
任意

プッシュが許可されるかどうかを決定します。

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.5. getRepo

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

GET /api/v1/repository/{repository}

承認: oauth2_implicit(repo:read)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

includeTags
任意

リポジトリータグを含めるかどうか

boolean

query

includeStats
任意

アクション統計を含めるかどうか。

boolean

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.6. updateRepo

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

PUT /api/v1/repository/{repository}

承認: oauth2_implicit (repo:write)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

description
任意

リポジトリーの Markdown でエンコードされた説明

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.7. deleteRepository

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

DELETE /api/v1/repository/{repository}

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16. repositorynotification

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

2.16.1. testRepoNotification

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

uuid
必須

通知の UUID

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16.2. getRepoNotification

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

uuid
必須

通知の UUID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16.3. deleteRepoNotification

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

uuid
必須

通知の UUID

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16.4. resetRepositoryNotificationFailures

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

uuid
必須

通知の UUID

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16.5. createRepoNotification

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

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

名前説明スキーマ

event
任意

通知が応答するイベント

string

method
任意

通知の方法 (メールや Web コールバックなど)

string

config
任意

特定の通知メソッドに関する JSON 設定情報

object

eventConfig
任意

特定の通知イベントに関する JSON 設定情報

object

title
任意

人間が判読できる通知のタイトル

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.16.6. listRepoNotifications

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

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

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.17. repotoken

リポジトリーアクセストークンの管理 (非推奨)

2.17.1. getTokens

指定したリポジトリートークン情報を取得します。

GET /api/v1/repository/{repository}/tokens/{code}

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

code
必須

トークンコード

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.17.2. changeToken

指定したリポジトリートークンのパーミッションを更新します。

PUT /api/v1/repository/{repository}/tokens/{code}

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

code
必須

トークンコード

string

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

トークンパーミッションの説明

名前説明スキーマ

role
任意

トークンに使用するロール

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.17.3. deleteToken

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

DELETE /api/v1/repository/{repository}/tokens/{code}

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

code
必須

トークンコード

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.17.4. createToken

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

POST /api/v1/repository/{repository}/tokens/

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

新しいトークンの説明。

名前説明スキーマ

friendlyName
任意

トークンの特定に役立つ分かりやすい名前

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.17.5. listRepoTokens

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

GET /api/v1/repository/{repository}/tokens/

承認: oauth2_implicit(repo:admin)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

query

limit
任意

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

integer

query

token
任意

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

boolean

query

permissions
任意

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

boolean

応答
HTTP コードDescriptionスキーマ

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)

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

path

robot_shortname
必須

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

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

robot_shortname
必須

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

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.4. getUserRobotPermissions

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

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

承認: oauth2_implicit(user:admin)

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

path

robot_shortname
必須

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

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

robot_shortname
必須

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

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.6. getOrgRobot

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

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

承認: oauth2_implicit(org:admin)

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

path

robot_shortname
必須

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

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

robot_shortname
必須

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

string

path

orgname
必須

組織の名前

string

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

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

名前説明スキーマ

description
任意

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

string

unstructured_metadata
任意

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

object

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.8. deleteOrgRobot

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

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

承認: oauth2_implicit(org:admin)

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

path

robot_shortname
必須

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

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.9. getOrgRobots

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

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

承認: oauth2_implicit(org:admin)

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

path

orgname
必須

組織の名前

string

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

query

limit
任意

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

integer

query

token
任意

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

boolean

query

permissions
任意

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

boolean

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.10. getUserRobot

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

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

承認: oauth2_implicit(user:admin)

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

path

robot_shortname
必須

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

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.11. createUserRobot

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

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

承認: oauth2_implicit(user:admin)

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

path

robot_shortname
必須

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

string

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

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

名前説明スキーマ

description
任意

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

string

unstructured_metadata
任意

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

object

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.18.12. deleteUserRobot

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

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

承認: oauth2_implicit(user:admin)

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

path

robot_shortname
必須

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

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

manifestref
必須

マニフェストのダイジェスト

string

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

query

vulnerabilities
任意

脆弱性情報を含めます

boolean

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21. スーパーユーザー

スーパーユーザー API。

2.21.1. createInstallUser

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

POST /api/v1/superuser/users/

承認: oauth2_implicit(super:user)

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

ユーザー作成のデータ

名前説明スキーマ

username
任意

作成されるユーザーの名前

string

email
任意

作成中のユーザーのメールアドレス

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.2. listAllUsers

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

GET /api/v1/superuser/users/

承認: oauth2_implicit(super:user)

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

query

next_page
任意

次のページのページトークン

string

query

limit
任意

ページごとに返す結果の数を制限します。最大 100 です。

integer

query

disabled
任意

false の場合には、有効なユーザーのみが返されます。

boolean

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.3. listAllLogs

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

GET /api/v1/superuser/logs

承認: oauth2_implicit(super:user)

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

query

next_page
任意

次のページのページトークン

string

query

page
任意

ログのページ番号

integer

query

endtime
任意

最後にログを取得した時間 (%m/%d/%Y %Z)

string

query

starttime
任意

最初にログを取得する時間 (%m/%d/%Y %Z)

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.4. createServiceKey

POST /api/v1/superuser/keys

承認: oauth2_implicit(super:user)

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

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

名前説明スキーマ

service
任意

このキーで認証されるサービス

string

name
任意

サービスキーの判別しやすい名前

string

metadata
任意

このキーのメタデータのキー/値のペア

object

notes
任意

指定すると、キーにメモを追加で指定できます。

string

expiration
任意

unix タイムスタンプとしての有効期限

 
応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.5. listServiceKeys

GET /api/v1/superuser/keys

承認: oauth2_implicit(super:user)

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.6. changeUserQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

path

quota_id
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.7. deleteUserQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

path

quota_id
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.8. createUserQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.9. listUserQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.10. changeOrganizationQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

path

quota_id
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.11. deleteOrganizationQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

path

quota_id
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.12. createOrganizationQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

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

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

名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

応答
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.13. listOrganizationQuotaSuperUser

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

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.14. changeOrganization

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

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

承認: oauth2_implicit(super:user)

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

path

name
必須

管理する組織の名前

string

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

既存組織の更新の説明

名前説明スキーマ

email
任意

組織の連絡先メール

string

invoice_email
任意

組織が請求書のメールを受信する必要があるかどうか

boolean

invoice_email_address
任意

請求書を受信するメールアドレス

 

tag_expiration_s
任意

タグの有効期限 (秒)

integer

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.15. deleteOrganization

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

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

承認: oauth2_implicit(super:user)

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

path

name
必須

管理する組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.16. approveServiceKey

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

承認: oauth2_implicit(super:user)

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

path

kid
必須

サービスキーの一意識別子

string

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

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

名前説明スキーマ

notes
任意

オプションの承認に関する注意事項

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.17. deleteServiceKey

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

承認: oauth2_implicit(super:user)

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

path

kid
必須

サービスキーの一意識別子

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.18. updateServiceKey

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

承認: oauth2_implicit(super:user)

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

path

kid
必須

サービスキーの一意識別子

string

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

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

名前説明スキーマ

name
任意

サービスキーの判別しやすい名前

string

metadata
任意

このキーのメタデータのキー/値のペア

object

expiration
任意

unix タイムスタンプとしての有効期限

 
応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.19. getServiceKey

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

承認: oauth2_implicit(super:user)

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

path

kid
必須

サービスキーの一意識別子

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.20. getRepoBuildStatusSuperUser

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

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

承認: oauth2_implicit(super:user)

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

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.21. getRepoBuildSuperUser

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

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

承認: oauth2_implicit(super:user)

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

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.22. getRepoBuildLogsSuperUser

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

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

承認: oauth2_implicit(super:user)

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

path

build_uuid
必須

ビルドの UUID

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.23. getRegistrySize

GET /api/v1/superuser/registrysize/

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

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

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

名前説明スキーマ

size_bytes*
optional

組織で許可されているバイト数

integer

last_ran

 

integer

queued

 

boolean

running

 

boolean

応答
HTTP コードDescriptionスキーマ

201

作成済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.24. postRegistrySize

POST /api/v1/superuser/registrysize/

承認: oauth2_implicit(super:user)

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

path

namespace
必須

 

string

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

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

名前説明スキーマ

size_bytes*
optional

組織で許可されているバイト数

integer

last_ran

 

integer

queued

 

boolean

running

 

boolean

応答
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

tag
必須

タグの名前

string

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

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

名前説明スキーマ

manifest_digest
任意

指定されている場合には、使用する必要があるマニフェストダイジェスト。

string

レスポンス
HTTP コードDescriptionスキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.22.2. changeTag

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

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

承認: oauth2_implicit (repo:write)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

tag
必須

タグの名前

string

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

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

名前説明スキーマ

manifest_digest
任意

(指定されている場合) タグが参照すべきマニフェストダイジェスト

 

expiration
任意

(指定されている場合) イメージの有効期限

 
応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.22.3. deleteFullTag

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

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

承認: oauth2_implicit (repo:write)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

path

tag
必須

タグの名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

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

query

onlyActiveTags
任意

アクティブなタグだけに絞り込みます。

boolean

query

page
任意

結果のページインデックス。デフォルトは 1 です。

integer

query

limit
任意

ページごとに返す結果の数を制限します。最大 100 です。

integer

query

filter_tag_name
任意

構文: <op>:<name> 操作に基づいてタグ名をフィルターします。<op> には like または eq を指定できます。

string

query

specificTag
任意

特定のタグだけに絞り込みます。

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23. team

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

2.23.1. getOrganizationTeamPermissions

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

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

承認: 

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

path

teamname
必須

チームの名前

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

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)

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

path

teamname
必須

チームの名前

string

path

membername
必須

チームメンバーのユーザー名

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.3. deleteOrganizationTeamMember

チームのメンバーを削除します。

If the user is merely invited to join the team, then the invite is removed instead.
DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

承認: oauth2_implicit(org:admin)

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

path

teamname
必須

チームの名前

string

path

membername
必須

チームメンバーのユーザー名

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.4. getOrganizationTeamMembers

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

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

承認: oauth2_implicit(org:admin)

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

path

teamname
必須

チームの名前

string

path

orgname
必須

組織の名前

string

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

query

includePending
任意

保留中のメンバーを含めるかどうか。

boolean

応答
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.5. inviteTeamMemberEmail

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

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

承認: oauth2_implicit(org:admin)

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

path

email
必須

 

string

path

teamname
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.6. deleteTeamMemberEmailInvite

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

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

承認: oauth2_implicit(org:admin)

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

path

email
必須

 

string

path

teamname
必須

 

string

path

orgname
必須

 

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.7. updateOrganizationTeam

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

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

承認: oauth2_implicit(org:admin)

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

path

teamname
必須

チームの名前

string

path

orgname
必須

組織の名前

string

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

チームの説明

名前説明スキーマ

role
任意

チームに適用する必要のある組織全体のパーミッション

string

description
任意

チームの Markdown の説明

string

レスポンス
HTTP コードDescriptionスキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.8. deleteOrganizationTeam

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

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

承認: oauth2_implicit(org:admin)

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

path

teamname
必須

チームの名前

string

path

orgname
必須

組織の名前

string

レスポンス
HTTP コードDescriptionスキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス