APIリファレンス

[更新日：2025年2月4日]

AppRunの機能をAPI経由で利用するための手順について説明します。
アプリケーションの作成・管理・運用など、すべての機能をAPIで自動化できます。

APIキーの作成

APIの利用には、認証用の「APIキー」が必要です。以下の手順で発行してください。

  1. さくらのクラウドのコントロールパネル にログインします。

  2. 使用するクラウドアカウントを選択します。

  3. APIキー のマニュアルを参照し、APIキーを作成します。

  4. 作成されたアクセストークンとアクセストークンシークレットを手元に控えておきます。

重要

  • APIキー作成時の注意点

    • アクセスレベルは「アクセス不可」以外を選択してください。

    • 「AppRun β」のアクセス権にチェックを入れてください。

    • いずれのアクセスレベルでもadmin権限で利用可能です。

作成されたAPIキーは以下の2つの情報で構成されます。

  • アクセストークン：ユーザーIDとして使用

  • アクセストークンシークレット：パスワードとして使用

AppRunユーザーの作成

AppRunのAPIを利用するには、まずユーザーを作成する必要があります。
ただし、すでにコントロールパネルからAppRunを利用している場合は、この手順は不要です。

以下のコマンドを実行し、AppRunユーザーを作成してください。
アクセストークンとアクセストークンシークレットには、先ほど作成したAPIキーの情報を入力します。

curl -u '<アクセストークン>:<アクセストークンシークレット>' \
     -X POST \
     https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api/user

注釈

  • AppRunを初めて利用する場合のみ必要な手順です。

  • ユーザーの作成および削除に料金は発生しません。

APIドキュメント

以上でAppRunのAPIを利用するための初期設定は完了です。
続いて、アプリケーションの作成や管理を行う場合は、以下のAPIドキュメントをご参照ください。

各APIの詳細な仕様、リクエスト例、レスポンス例などが記載されています。