平素より PCS をご利用いただき、誠にありがとうございます。
PCS の bot・マイクラサーバーをプログラムから操作できる「PCS API」を、2026年9月27日に公開いたしました。電源の操作に加え、使用量・ログの取得、設定の変更、ファイルとバックアップの操作、操作の履歴の取得、API キーごとの権限の設定に対応しております。PCS PASS 会員向けの機能です。
主な機能
| 機能 | 内容 |
|---|---|
| 電源の操作 | 起動・停止・再起動・強制停止 |
| 状態・使用量・ログ | 稼働状態、CPU・メモリ・ディスク・通信量の使用量、コンソールの出力の取得 |
| 設定の変更 | サーバー名・起動ファイル・死活監視・自動再起動の変更 |
| ファイル | ファイルの一覧・内容の取得・ダウンロード・書き込み・アップロード・削除、フォルダの作成、名前の変更 |
| バックアップ | バックアップの作成・一覧の取得・復元 |
| 操作の履歴 | API による操作の記録の取得 |
| Webhook | サーバーの停止・復帰などのイベントを、指定の URL へ通知 |
| 稼働バッジ | サーバーの稼働状況を表示する画像(GitHub の README・Web サイトに掲載可能) |
API キーと権限
- API キーは、アカウント設定の「PCS API・Webhook」で発行できます。1つのアカウントで同時に5個まで発行できます。
- API キーごとに、使用できる操作(権限)を選んで発行します。権限は「閲覧」「電源の操作」「設定の変更」「ファイルの読み込み」「ファイルの書き込み」「バックアップ」の6種類で、閲覧の権限はすべてのキーに付与されます。
- API キーの発行・無効化の際は、登録メールアドレスへお知らせします。
- 電源の操作、設定の変更、ファイルとバックアップの操作などは操作の履歴に記録され、API の利用状況のページで確認できます。
従来の API キーについて
PCS API の公開前に発行した API キー(ck_ で始まるキーなど)は、従来のキーとして、閲覧(ログ・操作の履歴を除く)と電源の操作に引き続きご利用いただけます。ログ・操作の履歴の取得、設定の変更、ファイルとバックアップの操作には、権限を選んで新たに発行した API キーをご利用ください。
ご利用にあたって
- PCS PASS の期間が終了すると API キーと Webhook は停止し、再びご加入いただくと同じ設定のままご利用いただけます。
- 対象は、契約中の bot とマイクラサーバーです。プレミアムの bot も、1個ずつ操作できます。PCS WEB のサイトと PCS VPS は対象外です。
- 時間制のマイクラサーバーの起動・再起動には、ウォレットに所定の残高が必要です。起動している間の料金は、ウォレットから差し引かれます。
エンドポイントの一覧、エラー、利用制限の詳細と、Python・discord.py・GitHub Actions からの利用例は、PCS API のドキュメントに掲載しております。
お問い合わせ
本件に関するご質問は、お問い合わせフォームよりご連絡ください。
今後とも PCS をよろしくお願い申し上げます。