メインコンテンツにスキップ

FASTPANEL API

概要

FASTPANEL® API を使用すると、Webインターフェースに依存せずにコントロールパネルを柔軟に管理できます。 これにより、定型的な操作の自動化、FASTPANEL® と外部サービスの連携、そしてより効率的なインフラ管理ワークフローの構築が可能になります。

トークン管理

ヒント

現時点では、APIトークン管理は Ubuntu 20.04 上で動作する FASTPANEL® インストールでのみ利用できます。

APIトークン管理セクションを開くには、FASTPANEL® インターフェースの右上隅にあるユーザー名をクリックし、"API tokens" を選択します。

新しいAPIトークンを作成するには、"Add API Token" をクリックします。 入力するフォームが表示されます:

  • Name — トークンの任意の名前。
  • Full API access — フルアクセスが必要な場合は、この設定を有効のままにします。
  • Constraint IP — このフィールドで指定したIPアドレスにAPIアクセスを制限します。
  • Expires at — トークンの有効期限。

トークンの作成を完了するには、"Add" をクリックします。

重要

必ずトークンを保存してください。再度アクセスすることはできません!

トークンの使用

詳細な FASTPANEL® API ドキュメントは、次の リンク から確認できます。

たとえば、コントロールパネルユーザーの一覧を取得するには、次のコマンドを使用できます:

curl 'https://yourserverip.example/api/users?page=1&per_page=20' \
--header 'Authorization: YOUR_SECRET_TOKEN'

ここで

  • YOUR_SECRET_TOKEN — 先ほど作成したトークン
  • yourserverip.example — サーバーのIPアドレスまたはドメイン名