APIキー

[更新: 2024年12月18日]

概要

さくらのVPSをAPIで操作する場合、事前にコントロールパネルからAPIキーおよびロールを作成する必要があります。

ここではAPIキー関連の手順について説明します。
APIキーの操作を行う際は、会員IDでコントロールパネルにログインしてください。

発行後、APIキーを再表示することはできませんので、紛失・失念等にはご注意ください。
また、APIキー発行にはロールが必要です。ロールを作成されていない場合は ロール をご参照のうえ、ロールを先に作成してください。

重要

2024年9月18日以前にAPIキーを発行されていたお客様は、APIキーの名称とロールを以下のとおり自動的に設定させていただいております。
APIキー(トークン文字列)やアクセス方法に変更はございませんので、以前のAPI操作をそのままご利用いただけます。

  • APIキー名: [名称自動付与] 2024/09/18 以前に作成したAPIキー

  • ロール: [名称自動付与] 全権限、全リソース

APIキーの管理

APIキーの追加

Note

APIキー発行にはロールが必要です。ロールを作成されていない場合は ロール をご参照のうえ、ロールを先に作成してください。

左メニューの「APIキー管理」をクリックします。

左メニューAPIキー管理

「APIキー」タブをクリックします。

「APIキー」タブ

「APIキーの追加」をクリックします。

「APIキー」の追加ボタン

APIキーの設定項目を入力し、「APIキーの追加」をクリックします。

APIキーの設定と追加

APIキーが表示されます。

追加したAPIキー情報

注意

APIキーは再表示できませんので、ご注意ください。

APIキーの再生成

左メニューの「APIキー管理」をクリックします。

左メニューAPIキー管理

「APIキー」タブをクリックします。

「APIキー」タブ

APIキーを再生成するAPIキー名をクリックします。

APIキーを再生成するAPIキーの選択

「APIキー再生成」をクリックします。

APIキーの再生成ボタン

注意

APIキー再生成後、以前のAPIキーは使用できなくなります。

APIキーが表示されます。

再生成したAPIキー情報

注意

APIキーは再表示できませんので、ご注意ください。

APIキーの削除

左メニューの「APIキー管理」をクリックします。

左メニューAPIキー管理

「APIキー」タブをクリックします。

「APIキー」タブ

APIキーを削除するAPIキー名をクリックします。

APIキーを削除するAPIキーの選択

「APIキー削除」をクリックします。

APIキー削除の場所

「削除」をクリックします。

APIキーの削除

APIキーの設定

APIキーの編集

左メニューの「APIキー管理」をクリックします。

左メニューAPIキー管理

「APIキー」タブをクリックします。

「APIキー」タブ

編集するAPIキー名をクリックします。

編集するAPIキーの選択

「編集」をクリックします。

「編集」ボタンをクリック

APIキーの設定項目を入力し、「保存」をクリックします。

編集と内容の保存