第6章 API を使用して設定を取得する

前提条件

• config.yaml ファイルに FEATURE_SUPERUSER_CONFIGDUMP: true を設定している。
• config.yaml ファイルで、ユーザーにスーパーユーザーロールを割り当てている。
• スーパーユーザー用の OAuth 2 アクセストークンを生成している。

手順

• v1/superuser/config API エンドポイントを使用して設定を取得します。以下に例を示します。

  $ curl -X GET -H "Authorization: Bearer <bearer_token>" "http://<quay-server.example.com>/api/v1/superuser/config" | jq -r .config

  出力例

  ...
    "TEAM_RESYNC_STALE_TIME": "30m",
    "UI_DELAY_AFTER_WRITE_SECONDS": 3,
    "UI_MODELCARD_ANNOTATION": {},
    "UI_MODELCARD_ARTIFACT_TYPE": "application/x-mlmodel",
    "UI_MODELCARD_LAYER_ANNOTATION": {
      "org.opencontainers.image.title": "README.md"
    }
  ...

• 特定の情報を返すには、.config、.env、.warning、.schema のいずれかを渡します。以下に例を示します。

  $ curl -X GET -H "Authorization: Bearer <bearer_token>" "http://<quay-server.example.com>/api/v1/superuser/config" | jq -r .warning

  出力例

  ...
    "BILLING_TYPE": "FakeStripe",
    "BUILDLOGS_OPTIONS": [],
    "BUILD_MANAGER": null,
    "CDN_SPECIFIC_NAMESPACES": [],
    "CHANNEL_COLORS": [
    ]
  ...