Hostinger について
Hostinger API の MCP サーバーで、ホスティング、ドメイン、請求などの操作を一括または分野別に提供します。ホスト型の接続先とローカル実行に対応し、OAuth または API トークンで認証できます。
主な機能
- 01Hostinger API の複数分野に対応
- 02分野別のサーバーコマンド
- 03API 操作の検索と実行
- 04操作を順番に一括実行
- 05OAuth と API トークン認証
- 06ホスト型とローカルの通信方式
活用シーン
- 01ホスティングサービスの確認と管理
- 02ドメインや DNS の操作
- 03請求や VPS の操作
MCP 対応
MCP クライアントに `search`、`execute`、`multi-execute` ツールを公開し、Hostinger API の操作を検索・実行できます。ホスト型リモートサーバーへの接続と、stdio または Streamable HTTP によるローカル実行に対応します。
設定
リモートサーバーはインストール不要です。クライアントを選んで設定をコピーするか、ワンクリックで導入できます。
https://mcp.hostinger.comclaude mcp add --transport http hostinger https://mcp.hostinger.com{"mcpServers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}Cursor で開く{"servers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}VS Code で開く{"mcpServers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}{"mcpServers":{"hostinger":{"serverUrl":"https://mcp.hostinger.com"}}}コマンドはターミナルで実行し、JSON は各クライアントの MCP 設定に貼り付けて再起動します。認可が必要なサーバーは初回接続時にログインを求めます。
ツール
3| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| operation | string | はい | 検索で返された操作名です。 |
| params | object | いいえ | 操作の inputSchema に適合するパラメーターです。 |
詳細
hostinger-api-mcp
Hostinger API 用の Model Context Protocol(MCP)サーバーです。
クイックスタート:ホスト型リモートサーバー
ローカルで何もインストールまたは実行したくない場合は、Hostinger のホスト型 MCP サーバーに直接接続してください。
https://mcp.hostinger.com
Claude Code
claude mcp add --transport http hostinger https://mcp.hostinger.com
OAuth による認証を許可するためのブラウザーウィンドウが開きます。承認すると、以下の操作をセッション内で execute を通じて利用できます。
その他の MCP 対応クライアント
クライアントの設定で https://mcp.hostinger.com をリモートの Streamable HTTP MCP サーバーとして追加し、OAuth プロンプトが表示されたら完了してください。「リモート MCP サーバーの追加」または「カスタムコネクター」設定の表示方法については、クライアントのドキュメントを参照してください。
前提条件
- Node.js バージョン 24 以上
Node.js がインストールされていない場合は、公式ウェブサイトからダウンロードできます。 または、Homebrew(macOS 用)や Chocolatey(Windows 用)などのパッケージマネージャーを使って Node.js をインストールできます。
インストール済みの Node.js バージョンを管理するには、NVM (Node Version Manager) の使用をおすすめします。 NVM のインストール後、次のコマンドで Node.js をインストールできます。
nvm install v24
nvm use v24
インストール
MCP サーバーをインストールするには、使用しているパッケージマネージャーに応じて、次のいずれかのコマンドを実行してください。
# Install globally from npm
npm install -g @hostinger/mcp
# Or with yarn
yarn global add @hostinger/mcp
# Or with pnpm
pnpm add -g @hostinger/mcp
更新
MCP サーバーを最新バージョンに更新するには、使用しているパッケージマネージャーに応じて、次のいずれかのコマンドを実行してください。
# Update globally from npm
npm update -g @hostinger/mcp
# Or with yarn
yarn global upgrade @hostinger/mcp
# Or with pnpm
pnpm update -g @hostinger/mcp
バイナリ
このパッケージは、次の MCP サーバーコマンドをインストールします。
hostinger-api-mcp— すべての操作(合計 418 件)を扱う統合サーバーhostinger-agency-hosting-mcp— agency-hosting 用の 42 件の操作hostinger-agent-readiness-mcp— agent-readiness 用の 3 件の操作hostinger-billing-mcp— billing 用の 9 件の操作hostinger-dns-mcp— dns 用の 8 件の操作hostinger-domains-mcp— domains 用の 42 件の操作hostinger-ecommerce-mcp— ecommerce 用の 29 件の操作hostinger-horizons-mcp— horizons 用の 6 件の操作hostinger-hosting-mcp— hosting 用の 68 件の操作hostinger-mail-mcp— mail 用の 38 件の操作hostinger-reach-mcp— reach 用の 69 件の操作hostinger-vps-mcp— vps 用の 67 件の操作hostinger-wordpress-mcp— wordpress 用の 40 件の操作
すべてのバイナリで同じ 3 つのツールを利用できます。スコープを限定したバイナリでは、対応するグループの操作のみを検索・実行します。hostinger-api-mcp は、後方互換性のあるデフォルトとして引き続き使用できます。
設定
サーバーの実行時には、次の環境変数を設定できます。
DEBUG:デバッグログを有効にします(true/false)(デフォルト:false)HOSTINGER_API_TOKEN:API トークンです。Authorizationヘッダーで送信されます。設定すると OAuth は完全にバイパスされます。API_TOKEN:HOSTINGER_API_TOKENの非推奨の別名です。今後のバージョンで削除されるため、HOSTINGER_API_TOKENの使用をおすすめします。OAUTH_ISSUER:OAuth サーバーのベース URL(デフォルト:https://auth.hostinger.com)。HOSTINGER_API_TOKENが設定されていない場合にのみ使用されます。
認証
サーバーでは、次の 2 種類の認証方式をサポートしています。
API トークン(CI/スクリプトでの使用を推奨)
環境または .env ファイルに HOSTINGER_API_TOKEN を設定してください。設定されている場合は常にこちらが優先され、OAuth のコードは実行されません。
PKCE を使用した OAuth 2.0(対話型サインイン)
HOSTINGER_API_TOKEN が設定されておらず、サーバーが stdio モードで動作している場合、認証が必要なツールを初めて呼び出すと、OAuth 2.0 と PKCE が自動的に使用されます。
- 発行者に動的な OAuth クライアントを登録します(RFC 7591)— マシンごとに一度だけ行われます。
- 認証ページを開くブラウザーウィンドウが表示されます。
- サインイン後、サーバーはローカルのエフェメラルポートでリダイレクトを受信し、コードをトークンと交換して保存します。
- 以降の呼び出しでは、保存済みのアクセストークンが再利用されます。期限切れのトークンは自動的に更新されます。リフレッシュトークンが取り消された場合は、ブラウザーフローが再度開始されます。
認証情報の保存先:
- macOS / Linux:
~/.config/hostinger-mcp/credentials.json(モード 0600) - Windows:
%APPDATA%\hostinger-mcp\credentials.json
認証情報は、すべての Hostinger MCP バイナリ(hostinger-api-mcp、hostinger-vps-mcp など)で共有されます。
手動コマンド:
# Run the OAuth sign-in flow immediately (don't wait for the first tool call)
hostinger-api-mcp --login
# Revoke stored credentials
hostinger-api-mcp --logout
HTTP トランスポートに関する注意: OAuth サインインは --http モードではサポートされていません。--http を使用する前に HOSTINGER_API_TOKEN を設定してください。
使用方法
Claude、Cursor などの JSON 設定
{
"mcpServers": {
"hostinger-api": {
"command": "hostinger-api-mcp",
"env": {
"DEBUG": "false",
"HOSTINGER_API_TOKEN": "YOUR API TOKEN"
}
}
}
}
トランスポートのオプション
MCP サーバーは、次の 2 つのトランスポートモードをサポートしています。
標準入出力トランスポート
サーバーは標準入力/出力(stdio)トランスポートを使用できます(デフォルト)。これにより、ローカルでストリーミングが可能になります。
ストリーミング可能な HTTP トランスポート
サーバーは HTTP ストリーミングトランスポートを使用できます。これにより、HTTP 経由の双方向ストリーミングが可能になります。
# Default HTTP transport on localhost:8100
hostinger-api-mcp --http
# Specify custom host and port
hostinger-api-mcp --http --host 0.0.0.0 --port 8150
コマンドラインオプション
Options:
--http Use HTTP streaming transport (requires HOSTINGER_API_TOKEN env var)
--stdio Use Server-Sent Events transport (default)
--host {host} Hostname or IP address to listen on (default: 127.0.0.1)
--port {port} Port to bind to (default: 8100)
--login Run OAuth sign-in flow and exit
--logout Revoke stored OAuth credentials and exit
--help Show help message
MCP ツールプロバイダーとしての使用
このサーバーは Model Context Protocol(MCP)を実装しており、MCP 対応のあらゆるコンシューマーで使用できます。
HTTP ストリーミングトランスポートを使用してこのサーバーに接続する例:
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
// Create HTTP transport
const transport = new StreamableHTTPClientTransport({
url: "http://localhost:8100/",
headers: {
"Authorization": `Bearer ${process.env.HOSTINGER_API_TOKEN}`
}
});
// Connect to the MCP server
const client = new Client({
name: "my-client",
version: "1.0.0"
}, {
capabilities: {}
});
await client.connect(transport);
// List available tools
const { tools } = await client.listTools();
console.log("Available tools:", tools);
// Execute an operation
const result = await client.callTool({
name: "execute",
arguments: { operation: "billing_catalog_list", params: { category: "DOMAIN" } }
});
console.log("Tool result:", result);
ツール
各サーバーは 3 つのツールを公開します。
search— キーワードでオペレーションを検索し、各検索結果とともにそのinputSchemaを返します。execute— 1 つのオペレーションを実行します:{ "operation": "<name>", "params": { ... } }。multi-execute— 最大 20 個のオペレーションを順番に実行し、最初の失敗時に停止します。値が厳密に"$steps.<i>.<path>"と一致する params 値は、前のステップの結果に含まれるその値に置き換えられます。
オペレーション
各バイナリで search が提供するオペレーション:
新しいツールに置き換えられたオペレーションは、置き換え先のツールを提供するすべてのバイナリで search の対象から除外され、ドキュメントにも記載されません。削除されるまでは、execute から引き続き実行できます。
hostinger-agency-hosting-mcp
agency-hosting_deploy-node-static-website
アーカイブファイルから、node-static Agency Plan(h5g)のウェブサイトをデプロイします。警告:ウェブサイトの既存コンテンツは上書きされ、元に戻せません。実行前に必ずユーザーに確認してください。これは、node-static タイプの Agency Plan ウェブサイト(ビルド手順が必要な Node.js 製の静的サイト、またはシンプルな静的サイト)に使用します。このツールは、ドメインからウェブサイトを特定し、TUS 経由でアーカイブをウェブサイトのファイルブラウザーにアップロードしてから、サイトをビルドし、その結果を public_html にデプロイする build-assets プロセスを開始します。このオペレーションは同期的です。ツールが返る前にビルドとデプロイが完了するため、正常に完了するとすぐにウェブサイトが公開されます。別途、非同期のビルドを待ったり、状態を確認したりする必要はありません。アップロード用の認証情報は内部で生成・使用されます。別途アップロード URL エンドポイントを呼び出したり、自分でアーカイブをアップロードしたりしないでください。このツールがすべて処理します。そのまま展開する PHP アプリケーションには、代わりに agency-hosting_deploy-php-application を使用してください。ウェブサイトの UID はドメインから自動的に解決されます。
- メソッド:
custom - パス:
custom
agency-hosting_deploy-php-application
アーカイブファイルから、Agency Plan(h5g)の PHP(またはその他のビルド不要)ウェブサイトをデプロイします。警告:この操作はウェブサイトの既存のコンテンツを上書きし、元に戻せません。実行する前に、必ずユーザーに確認してください。アーカイブの内容をそのまま展開して提供し、ビルド手順を必要としない Agency Plan のウェブサイト(PHP アプリケーションなど)で使用します。このツールはドメインからウェブサイトを特定し、TUS を介してアーカイブをウェブサイトのファイルブラウザーにアップロードした後、インポートアーカイブ処理を開始して、ウェブサイトのコンテンツをアーカイブの内容で上書きします。この操作は同期的です。ツールが戻る前にアーカイブの展開とデプロイが完了するため、ツールが正常に終了するとウェブサイトはすぐに公開されます。別途、非同期のビルドを待ったり、状態を確認したりする必要はありません。アップロード認証情報は内部で生成されて使用されます。別途アップロード URL エンドポイントを呼び出したり、アーカイブを自分でアップロードしたりしないでください。このツールが最初から最後まで処理します。ビルド手順が必要な node-static ウェブサイトには、代わりに agency-hosting_deploy-node-static-website を使用してください。ウェブサイト UID はドメインから自動的に特定されます。
- Method:
custom - Path:
custom
agency-hosting_datacenters_list
指定された Agency Plan ホスティング注文で、新しいウェブサイトのプロビジョニングに利用できるデータセンターの一覧を取得します。
各データセンターには pinger_url が含まれています。クライアントからこの URL に ping を送信して、往復レイテンシを測定できます。データセンター間で結果を比較することで、ウェブサイトのセットアップを作成する際に code を datacenter_code として指定する前に、最も近いデータセンター(ping が最も低いもの)を選べます。
- Method:
GET - Path:
/api/agency-hosting/v1/orders/{order_id}/datacenters
agency-hosting_domains_change-website
Agency Plan ウェブサイトのプライマリドメインを変更します。
パスには現在のドメインを指定し、リクエストボディには新しいドメインを指定してください。 ドメインを null に設定すると、一時ドメインに戻ります。
- Method:
PUT - Path:
/api/agency-hosting/v1/websites/{website_uid}/domains/{from_domain}
agency-hosting_domains_link-to-website
ドメインを指定された Agency Plan ウェブサイトにリンクし、そのドメインへのトラフィックを配信できるようにします。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/domains
agency-hosting_domains_list
認証済みクライアントがアクセスできる Agency Plan ウェブサイトに関連付けられたドメインの、ページ分割された一覧を返します。
website_uuids フィルターを使用すると、特定のウェブサイトに結果を絞り込めます。
- Method:
GET - Path:
/api/agency-hosting/v1/domains
agency-hosting_domains_unlink-from-website
指定された Agency Plan ウェブサイトからドメインのリンクを解除します。
ウェブサイトは、このドメインでのトラフィック配信を直ちに停止します。
ウェブサイトのファイルとデータベースは保持され、ほかのリンク済みドメインには引き続きアクセスできます。
ウェブサイトに設定されているドメインがこれだけの場合、リンクを解除すると、ウェブサイトにはアクセス可能なドメインがなくなります。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}
agency-hosting_files_generate-upload-url
Agency Plan のウェブサイトのファイルストレージにファイルをアップロードするための、認証情報付きファイルブラウザーアップロード URL を生成します。
url、auth_key、rest_auth_key を返します。これらを使用して、TUS 再開可能アップロードプロトコル(TUS 1.0.0)経由でウェブサイトのファイルストレージにファイルをアップロードします。以下のすべてのリクエストに X-Auth: {auth_key} と X-Auth-Rest: {rest_auth_key} ヘッダーを指定してください。
- アップロードを作成します:
{url}/{relative_file_path}?override=trueにヘッダーupload-length: {file size in bytes}とupload-offset: 0を指定してPOSTします。201 Createdが返されることを確認します。 - ファイルをアップロードします:同じ場所にファイルのバイト列を送信し、完了するまで続けます(TUS 1.0.0 クライアントを使用するか、進行状況を追跡する
upload-offsetヘッダーを指定してPATCHリクエストを送信します)。
relative_file_path はウェブサイトのファイルストレージ内の保存先パスです。例:app.zip。
TUS クライアントの代わりに、通常の curl も使用できます:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when done
- メソッド:
POST - パス:
/api/agency-hosting/v1/websites/{website_uid}/files/upload-urls
agency-hosting_files_import-website-from-archive
すでにアップロードされているアーカイブから Agency Plan のウェブサイトをインポートします。
まず、ファイルブラウザーを使用してアーカイブをウェブサイトのルートディレクトリにアップロードし、このリクエストでファイル名を指定してください。ウェブサイトのコンテンツはアーカイブの内容で上書きされます。対応するアーカイブ形式:.zip、.tar、.tar.gz、.tgz。
- メソッド:
POST - パス:
/api/agency-hosting/v1/websites/{website_uid}/files/import-archive
agency-hosting_metrics_list-plan-order-disk-usage
選択した期間における Agency Plan の注文のディスク使用量と inode 使用量の集計値、およびプランのクォータを返します。数値は注文アカウント全体を対象とします。値には最大 1 時間の遅延が生じる場合があります。CPU、メモリ、プロセスの使用量については、resource-usage-metrics エンドポイントを参照してください。
- メソッド:
GET - パス:
/api/agency-hosting/v1/orders/{order_id}/disk-usage-metrics
agency-hosting_orders_list
認証済みクライアントがアクセスできる Agency Plan の注文を、ページ分割して一覧表示します。
- メソッド:
GET - パス:
/api/agency-hosting/v1/orders
agency-hosting_metrics_list-order-resource-usage
選択した期間における Agency Plan の注文の CPU、メモリ、プロセス使用量の集計値、プランのクォータ、およびウェブサイトごとの内訳を返します。各ウェブサイトは UID で識別されます。一時停止中および削除済みのウェブサイトは、注文の合計値にもウェブサイトごとの内訳にも含まれません。値には最大 1 時間の遅延が生じる場合があります。ディスク使用量と inode 使用量については、disk-usage-metrics エンドポイントを参照してください。
- メソッド:
GET - パス:
/api/agency-hosting/v1/orders/{order_id}/resource-usage-metrics
agency-hosting_php_list-extensions-for-website
Agency Plan のウェブサイトで利用可能なすべての PHP 拡張機能と、現在有効になっているかどうかを一覧表示します。
- メソッド:
GET - パス:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_replace-website-extensions
Agency Plan のウェブサイトで有効にする PHP 拡張機能を、指定されたものに置き換えます。リクエストに含まれていない切り替え可能な拡張機能は無効になるため、先に拡張機能のエンドポイントを呼び出し、有効にしたい拡張機能をすべて指定してください。PHP に組み込まれ、「built-in」状態として報告される拡張機能は常に有効であり、影響を受けません。
- メソッド:
PUT - パス:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_list-options-for-website
Agency Plan のウェブサイトで設定可能な php.ini ディレクティブを一覧表示します。それぞれのデフォルト値、現在有効な値、および設定可能な値も示します。
- メソッド:
GET - パス:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_replace-website-options
Agency Plan のウェブサイトのカスタム php.ini 値を、指定した値に置き換えます。リクエストに含まれていないオプションはデフォルト値にリセットされるため、最初にオプションのエンドポイントを呼び出し、設定したい値をすべて送信してください。空の配列を送信すると、すべてのオプションがデフォルト値にリセットされます。
- Method:
PUT - Path:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_list-versions-for-order
Agency Plan の注文で作成されたウェブサイトで利用できる PHP バージョンを、注文がホストされているサーバーに基づいて一覧表示します。ウェブサイトを作成する前に使用してください。既存のウェブサイトについては、ウェブサイト単位のバージョンエンドポイントを呼び出してください。
- Method:
GET - Path:
/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions
agency-hosting_php_list-versions-for-website
Agency Plan のウェブサイトで切り替え可能な PHP バージョンを一覧表示します。現在ウェブサイトで実行中のバージョンは、ウェブサイト詳細エンドポイントの settings.php.version として返されます。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions
agency-hosting_php_update-website-version
Agency Plan のウェブサイトを別の PHP バージョンに切り替えます。まず利用可能なバージョンのエンドポイントを呼び出し、選択できるバージョンを確認してください。ウェブサイトは新しいバージョンで再起動するため、切り替え中のリクエストが失敗したり、対象バージョンと互換性のないコードが動作しなくなったりする場合があります。
- Method:
PATCH - Path:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/version
agency-hosting_website-setups_create
Agency Plan のホスティング注文のいずれかに、新しいウェブサイトを作成します。
サイトのデータセンター、スタック(flavor)、PHP バージョンを選択します。任意で独自の domain を設定できます。省略するか、null に設定するか、利用できない状態にすると、代わりに無料の *.hostingersite.com サブドメインが生成されます。また、wordpress の詳細(管理者アカウント、サイトタイトル、言語)を指定して、WordPress をインストールすることもできます。
一般的な設定:
- プレーンな PHP サイト:
flavorをphp-fpmに設定し、settings.php.versionを指定します。wordpressとtypeは省略します。 - WordPress サイト:
flavorを使用する WordPress バージョン(例:wp-7.0)に設定し、wordpressブロック(管理者アカウント、タイトル、言語)を追加します。 - 静的/Node.js フロントエンドアプリ:
flavorをphp-fpmに設定し、typeをnode-staticに設定します。
プロビジョニングはバックグラウンドで実行されるため、レスポンスはジョブを識別するセットアップ UUID とともにすぐに返されます。プロビジョニングが完了すると、新しいウェブサイトにアクセスできるようになります。
- Method:
POST - Path:
/api/agency-hosting/v1/orders/{order_id}/websites/setups
agency-hosting_website-setups_status
setups エンドポイントから開始された Agency Plan のウェブサイトセットアップの現在のステータスを返します。
プロビジョニングリクエストで返された setup_uuid を使用してこのエンドポイントをポーリングし、status が completed になるまで確認してください。その時点で、website_uid が新しいウェブサイトを示します。
- Method:
GET - Path:
/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}
agency-hosting_ssl_reinstall-website
ドメインの Let's Encrypt 証明書を置き換えます。現在のプラットフォーム証明書が記録されている場合は、失効させて削除した後、新しいセットアップをバックグラウンドで開始します。すぐに返されます。処理中は Get website SSL status が installing を返し、その後 active または failed を返します。
無料サブドメインの場合、ドメインの証明書処理が記録されている場合(失敗したセットアップも、クリーンアップされるまでは該当します)、またはドメインが7日間に3回のセットアップ上限に達した場合は、422 を返します。同じドメインへのリクエストが1分以内にあった場合は429を返します。ウェブサイトが停止またはロックされている場合は403を返し、ウェブサイトまたはドメインが存在しない場合は404を返します。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/reinstall
agency-hosting_ssl_install-website
ドメインの Let's Encrypt 証明書の設定を開始し、すぐに応答を返します。設定はバックグラウンドで実行されます。実行中は Get website SSL status が installing を返し、完了すると active または failed を返します。List website processes の ssl_setup エントリーにも同じ進捗が表示されます。
ドメインに有効期限が切れていないプラットフォーム証明書がすでにある場合、ドメインの証明書処理が記録されている場合(失敗した設定も、クリーンアップされるまで該当します)、またはドメインが7日間に3回の設定制限に達した場合は、422を返します。同じドメインに対するリクエストが1分以内にすでに行われている場合は429を返します。ウェブサイトが停止またはロックされている場合は403を、ウェブサイトまたはドメインが存在しない場合は404を返します。
- メソッド:
POST - パス:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/setup
agency-hosting_ssl_website-status
Agency Plan ウェブサイトのドメイン1つについて、証明書の status、証明書が顧客によってアップロードされたものかどうか、および有効期限が切れる日時を返します。
installing は証明書の設定が実行中または再試行中であることを意味します。List website processes の ssl_setup エントリーにも同じ進捗が表示されます。active は有効な証明書が設定されていることを意味します。証明書は顧客がアップロードしたもの、プラットフォームが発行したもの、またはドメイン用に購入したライフタイム証明書のいずれかです。failed は直近の設定が断念され、有効な証明書が設定されていないことを意味します。expired は証明書の有効期限が切れたことを意味します。not_installed はドメインに証明書も設定処理もないことを意味します。ウェブサイトまたはドメインが存在しない場合は404を返します。
- メソッド:
GET - パス:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/status
agency-hosting_ssl_uninstall-website
ドメインのプラットフォーム発行 Let's Encrypt 証明書を削除します。応答前に証明書は失効されて削除されるため、新しい設定が完了するまで、ドメインにはプラットフォーム証明書が適用されなくなります。ドメインに削除対象のプラットフォーム証明書がない場合も成功します。アップロード済みの(カスタム)証明書には影響しません。
ドメインの証明書処理が記録されている場合(失敗した設定も、クリーンアップされるまで該当します)は422を返します。同じドメインに対するリクエストが1分以内にすでに行われている場合は429を返します。ウェブサイトが停止またはロックされている場合は403を、ウェブサイトまたはドメインが存在しない場合は404を返します。
- メソッド:
DELETE - パス:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl
agency-hosting_websites_build-nodejs-assets
アップロード済みのアーカイブを使用して、Agency Plan ウェブサイトの Node.js アプリケーションをビルドしてデプロイします。
まずアーカイブをファイルブラウザーにアップロードし、このリクエストでドキュメントルートからの相対パスを指定します。ウェブサイトのコンテンツはビルド結果で上書きされ、public_html にデプロイされます。
- メソッド:
POST - パス:
/api/agency-hosting/v1/websites/{website_uid}/build-assets
agency-hosting_cache_clear-website
プレビュー用ドメインを含め、Agency Plan ウェブサイトに関連付けられているすべてのドメインのキャッシュを消去します。
この操作では、ウェブサイトのすべての種類のキャッシュを消去します。
- メソッド:
DELETE - パス:
/api/agency-hosting/v1/websites/{website_uid}/cache
agency-hosting_cron-jobs_list-website
Agency Plan ウェブサイトに設定されている cron ジョブのページ分割された一覧を返します。
各エントリーには、スケジュール式と、そのスケジュールで実行されるコマンドが含まれます。
- メソッド:
GET - パス:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_create-website
スケジュール式とコマンドを指定して、Agency Plan ウェブサイトの cron ジョブを作成します。
作成した cron ジョブを返します。削除にはその uuid が必要です。
- メソッド:
POST - パス:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_delete-website
Agency Plan のウェブサイトから、UUID で識別される cron ジョブを完全に削除します。
この操作は冪等です。存在しない cron ジョブを削除しても、エラーにならず成功します。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs/{uuid}
agency-hosting_databases_list-website
Agency Plan のウェブサイト用に作成された MySQL データベースのページ分割された一覧を返します。
各項目には、システムユーザー以外のデータベースユーザーが含まれます。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_create-website
Agency Plan のウェブサイト用に、専用ユーザーを設定した MySQL データベースを作成します。
データベース名、ユーザー名、パスワードはすべて呼び出し元が指定する必要があります。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_delete-website
Agency Plan のウェブサイトから、ユーザーを含む MySQL データベースとそのすべてのデータを完全に削除します。
この操作は冪等です。存在しないデータベースを削除しても、エラーにならず成功します。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}
agency-hosting_databases_create-website-user
Agency Plan のウェブサイト上にある既存のデータベース用に、ユーザーを作成します。
各データベースで作成できるシステムユーザー以外のユーザーは1つだけです。すでにユーザーが存在するデータベースにユーザーを作成すると失敗します。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users
agency-hosting_databases_delete-website-user
Agency Plan のウェブサイト上のデータベースからユーザーを完全に削除し、そのユーザーが持つすべてのアクセス権を取り消します。
この操作は冪等です。存在しないユーザーを削除しても、エラーにならず成功します。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users/{database_user_name}
agency-hosting_websites_get
特定の Agency Plan ウェブサイトに関する詳細情報を取得します。設定、 ステータス、メタデータ、ホスティングプランの詳細、リソースクォータが含まれます。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_delete
Agency Plan のウェブサイトを完全に削除します。削除は非同期で処理されます。ウェブサイトはただちに削除中の状態に移行し、基盤となるサーバーリソースはバックグラウンドで削除されます。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_list-plan
認証済みクライアントがアクセスできる Agency Plan のウェブサイト(H5G、Builder、Horizons)のページ分割された一覧を取得します。
このエンドポイントは、ホスティングアカウント内のウェブサイトに加えて、アクセスを共有している他のクライアントのホスティングアカウント内のウェブサイトも返します。
レスポンスの形式はプラットフォームによって異なります。各項目の platform フィールドを参照してください。
特定の検出済みタイプのウェブサイトのみを一覧表示するには、website_types を使用します。たとえば、WordPress ウェブサイトのみ(website_types=wordpress)や Node.js ウェブサイトのみ(website_types=nodejs)を指定できます。order_ids、states、または domain と組み合わせると、結果をさらに絞り込めます。
- Method:
GET - Path:
/api/agency-hosting/v1/websites
agency-hosting_websites_list-processes
Agency Plan のウェブサイトで実行中および最近完了した非同期プロセスを一覧表示します。
各プロセスには、一意の ID(追跡用)、タイプ、ステータス(実行中、完了、失敗)があります。非同期操作(SSL の設定、バックアップ、クローン作成)を開始した後、このエンドポイントをポーリングして進捗を追跡してください。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/processes
agency-hosting_wordpress_change-version
Agency Plan のウェブサイトにインストールされている WordPress コアのバージョンを、インストール可能なバージョンのいずれかに変更します。
- Method:
PATCH - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/version
agency-hosting_wordpress_settings
Agency Plan のウェブサイトにおける現在の WordPress 設定を返します。インストールされているコアのバージョン、LiteSpeed Cache プラグインのステータス、オブジェクトキャッシュのステータス、メンテナンスモードのステータスが含まれます。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings
agency-hosting_wordpress_list-versions
Agency Plan のウェブサイトにインストールできる WordPress コアのバージョンを一覧表示します。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/versions
hostinger-agent-readiness-mcp
agent-readiness_checks_list
エージェント対応状況のスキャンで実行されるすべてのチェックについて、名前、カテゴリ、重みを一覧表示します。\n
スキャン結果の各 check_id に対応する、人が読みやすい名前を表示するために使用します。
- Method:
GET - Path:
/api/agent-readiness/v1/checks
agent-readiness_scans_run
公開ウェブサイトが AI エージェントによる検出、閲覧、操作にどの程度対応できているかをスキャンします。\n
スキャンは非同期で実行されます。この操作はスキャンを開始するだけで、返されるスキャンのステータスは通常 pending であり、結果はまだありません。結果を取得するには、同じドメインで Get agent readiness scan 操作を数秒おきにポーリングし、ステータスが completed または failed になるまで続けてください。スキャン自体の実行時間は最大 60 秒で、キューでの待機時間はこれに加算されます。failed になったスキャンは再試行されません。この操作を再度実行してください。\n
過去 5 分以内に開始された保留中のスキャンがすでにあるドメインに対してスキャンを開始すると、新しいスキャンの代わりにそのスキャンが返されます。
- Method:
POST - Path:
/api/agent-readiness/v1/scans
agent-readiness_scans_get
ウェブサイトの最新のエージェント対応状況スキャンを取得します。\n
Run agent readiness scan 操作で開始されたスキャンは非同期で実行されます。ステータスが pending の間、結果の各フィールドは null です。数秒待ってからこの操作を再度呼び出し、ステータスが completed または failed になるまで続けてください。failed になったスキャンは再試行されません。スキャンを再度実行してください。\n
完了したスキャンでは、0〜100 のスコア、レターグレード、カテゴリごとのスコア、および見つかった根拠と修正方法を含む各チェックの結果が表示されます。チェック名は List checks 操作で一覧表示されます。\n
ドメインが一度もスキャンされていない場合は 404 を返します。まず Run agent readiness scan 操作を使用してください。
- Method:
GET - Path:
/api/agent-readiness/v1/scans/{domain}
hostinger-billing-mcp
billing_catalog_list
注文可能なカタログ項目を取得します。
カタログ項目の価格は、浮動小数点数ではなくセント単位で表示されます。
たとえば、浮動小数点数の 17.99 は整数の 1799 として表示されます。
注文前に利用可能なサービスと価格を確認するには、このエンドポイントを使用してください。
- Method:
GET - Path:
/api/billing/v1/catalog
billing_orders_create-purchase
Hostinger の任意の製品の購入注文を作成します。
この統合エンドポイントは、カタログ項目を 1 つ以上指定して注文し、既存の課金インフラストラクチャを活用して、Hostinger のすべての製品で利用できます。購入可能な item_id の値は、カタログエンドポイントで確認してください。
支払い方法が指定されていない場合は、デフォルトの支払い方法が自動的に使用されます。
レスポンスが 202 Accepted の場合、支払いはまだ処理中です。支払いが確認されると、注文は非同期で完了します。
このエンドポイントは注文のみを行います。製品固有のプロビジョニング(VPS のセットアップやドメイン登録など)はここでは実行されません。注文の完了後、該当する製品エンドポイントまたは hPanelを使用してセットアップを完了してください。
カタログにある任意の製品を購入するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/billing/v1/orders
billing_payment-methods_set-default
アカウントのデフォルトの支払い方法を設定します。
今後の注文に使用するメインの支払い方法を設定するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_delete
アカウントから支払い方法を削除します。
このエンドポイントを使用して、ユーザーアカウントから使用していない支払い方法を削除します。
- Method:
DELETE - Path:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_list
新しい注文の作成に使用できる支払い方法を取得します。
新しい支払い方法を追加する場合は、 hPanelを使用してください。
注文を作成する前に、利用可能な支払い方法を確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/billing/v1/payment-methods
billing_subscriptions_list
アカウントに関連付けられているすべてのサブスクリプションの一覧を取得します。
このエンドポイントを使用して、アクティブなサービスと請求状況を確認します。
- Method:
GET - Path:
/api/billing/v1/subscriptions
billing_subscriptions_disable-auto-renewal
サブスクリプションの自動更新を無効にします。
サブスクリプションの自動更新を無効にする場合に、このエンドポイントを使用します。
- Method:
DELETE - Path:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable
billing_subscriptions_enable-auto-renewal
サブスクリプションの自動更新を有効にします。
サブスクリプションの自動更新を有効にする場合に、このエンドポイントを使用します。
- Method:
PATCH - Path:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable
billing_subscriptions_renew
既存のHostingerサブスクリプションの更新注文を作成します。
このエンドポイントは、既存の請求インフラストラクチャを利用して、
単一のサブスクリプションの更新注文を作成します。更新可能な
subscriptionIdの値を確認するには、
subscriptions endpointを使用してください。
支払い方法が指定されていない場合は、デフォルトの支払い方法が自動的に使用されます。
レスポンスが202 Acceptedの場合、支払いはまだ処理中です。支払いが確認されると、
更新は非同期で完了します。
アカウントで利用可能なサブスクリプションを更新するには、このエンドポイントを使用します。
- Method:
POST - Path:
/api/billing/v1/subscriptions/{subscriptionId}/renew
hostinger-dns-mcp
dns_snapshots_get
DNSゾーンレコードの内容を含む、特定のDNSスナップショットを取得します。
ドメインの過去のDNS設定を確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/dns/v1/snapshots/{domain}/{snapshotId}
dns_snapshots_list
ドメインのDNSスナップショットを取得します。
復元に利用できるDNSバックアップポイントを確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/dns/v1/snapshots/{domain}
dns_snapshots_restore
DNSゾーンを選択したスナップショットに復元します。
ドメインのDNSを以前の設定に戻すには、このエンドポイントを使用します。
- Method:
POST - Path:
/api/dns/v1/snapshots/{domain}/{snapshotId}/restore
dns_records_list
特定のドメインのDNSゾーンレコードを取得します。
ドメイン管理のために現在のDNS設定を確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/dns/v1/zones/{domain}
dns_records_update
選択したドメインのDNSレコードを更新します。
overwrite = trueを指定すると、既存のレコードが指定したレコードに置き換えられます。
それ以外の場合、既存のレコードが更新され、新しいレコードが追加されます。
ドメインのDNS設定を変更するには、このエンドポイントを使用します。
- Method:
PUT - Path:
/api/dns/v1/zones/{domain}
dns_records_delete
選択したドメインのDNSレコードを削除します。
削除するレコードを絞り込むには、フィルターにレコードのnameとtypeを追加します。
1つのリクエストで複数のフィルターを指定できます。
同じ名前とタイプのレコードが複数あり、その一部だけを削除したい場合は、
Update zone recordsエンドポイントを参照してください。
ドメインから特定のDNSレコードを削除するには、このエンドポイントを使用します。
- Method:
DELETE - Path:
/api/dns/v1/zones/{domain}
dns_records_reset
DNS ゾーンをデフォルトのレコードにリセットします。
このエンドポイントを使用すると、ドメインの DNS を元の設定に戻せます。
- Method:
POST - Path:
/api/dns/v1/zones/{domain}/reset
dns_records_validate
選択したドメインの DNS レコードを更新前に検証します。
検証が成功すると、レスポンスに 200 Success コードが含まれます。
検証エラーがある場合、レスポンスは 422 Validation error コードで失敗します。
このエンドポイントを使用して、変更を適用する前に DNS レコードの有効性を確認できます。
- Method:
POST - Path:
/api/dns/v1/zones/{domain}/validate
hostinger-domains-mcp
domains_verifications_direct
保留中および完了済みのドメイン認証の一覧を取得します。
- Method:
GET - Path:
/api/v2/direct/verifications/active
domains_availability_suggest-names-from-description
プロジェクトについての自由記述に基づいて、利用可能なドメイン名を提案します。
提案は AI モデルによって生成されるため、呼び出しごとに異なります。
このエンドポイントのレート制限は、1 分あたり 90 リクエストです。
ウェブサイトの内容しか分からない場合に、このエンドポイントを使用してドメイン名を探せます。
- Method:
POST - Path:
/api/domains/v1/availability/alternatives-from-description
domains_availability_suggest-names-from
すでに候補にしているドメイン名に基づいて、利用可能なドメイン名を提案します。
提案は AI モデルによって生成されるため、呼び出しごとに異なります。
このエンドポイントのレート制限は、1 分あたり 90 リクエストです。
希望するドメインがすでに取得されていて、近い候補が必要な場合に、このエンドポイントを使用します。
- Method:
POST - Path:
/api/domains/v1/availability/alternatives-from-domain
domains_availability_check
複数の TLD にわたってドメイン名の空き状況を確認します。
複数の TLD を一度に確認できます。
レスポンスに代替候補を含めるには、TLD を 1 つだけ指定し、with_alternatives を true に設定してください。
TLD は先頭にドットを付けずに指定してください(例:com、net、org)。
このエンドポイントのレート制限は、1 分あたり 90 リクエストです。
購入前にドメインが利用可能か確認するには、このエンドポイントを使用します。
- Method:
POST - Path:
/api/domains/v1/availability
domains_forwarding_get
ドメイン転送データを取得します。
このエンドポイントを使用して、ドメインの現在のリダイレクト設定を確認できます。
- Method:
GET - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_update
ドメイン転送設定を更新します。
このエンドポイントを使用して、ドメインの既存のリダイレクト設定を変更できます。
- Method:
PUT - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_delete
ドメイン転送データを削除します。
このエンドポイントを使用して、ドメインのリダイレクト設定を削除できます。
- Method:
DELETE - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_create
ドメイン転送設定を作成します。
このエンドポイントを使用して、ドメインから他の URL へのリダイレクトを設定できます。
- Method:
POST - Path:
/api/domains/v1/forwarding
domains_whois_pending-irtp-verification
ドメインの保留中の IRTP 認証を取得します。
WHOIS の変更を有効にするには、旧登録者と新登録者の両方が確認する必要があります。
このエンドポイントを使用して、登録者の確認待ちとなっている WHOIS 変更の状況を確認できます。
- Method:
GET - Path:
/api/domains/v1/irtp/{domain}
domains_whois_cancel-pending-irtp-verification
保留中の IRTP 認証をキャンセルします。
登録者の確認待ちで止まっている WHOIS 変更を取り消す場合に、このエンドポイントを使用します。 たとえば、確認メールを受信できず、5 日間の有効期限が切れるのを待たずに取り消したい場合に使用できます。
- Method:
DELETE - Path:
/api/domains/v1/irtp/{domain}
domains_move_incoming
指定したドメインの受信中の移管を取得します。
このドメインをあなたのアカウントに移管しているアカウントがない場合は、404 を返します。
あなた宛てのドメイン移管がまだ承認待ちかどうかを確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/domains/v1/move/incoming/{domain}
domains_move_accept-incoming
指定したドメインへの移管を承認します。
指定したWHOISプロフィールがドメインの連絡先として設定されるため、これらのプロフィールはお客様のアカウントに属し、TLDの要件を満たしている必要があります。ドメインが実際に使用している連絡先タイプのみが適用されますが、4つすべてのプロフィールIDを指定する必要があります。
移管は、まだお客様の判断待ちである必要があります。すでに承認済みの移管を再度承認することはできません。
承認しても移管は完了しません。新しい所有者の連絡先メールアドレスに確認メールが送信され、そのメールから変更が確認された後にのみドメインの所有者が変わります。それまでは移管はactivatingステータスのままです。ステータスは受信移管エンドポイントで確認できます。
このエンドポイントを使用して、お客様に譲渡されたドメインの所有権を取得します。
- メソッド:
PUT - パス:
/api/domains/v1/move/incoming/{domain}
domains_move_reject-incoming
指定したドメインへの移管を拒否します。
ドメインは、移管を開始したアカウントに引き続き属します。 すでに承認した移管は、拒否できなくなります。
引き継ぎを希望しないドメインを辞退するには、このエンドポイントを使用します。
- メソッド:
DELETE - パス:
/api/domains/v1/move/incoming/{domain}
domains_move_incoming-list
他のHostingerアカウントからお客様のアカウントへ移管中のすべてのドメインを取得します。
すでに完了したものを含め、すべてのステータスの移管が返されます。
承認待ちのドメインを確認するには、このエンドポイントを使用します。
- メソッド:
GET - パス:
/api/domains/v1/move/incoming
domains_move_outgoing
指定したドメインの送信移管を取得します。
ドメインの移管が進行中でない場合は、404が返されます。
単一のドメインについて、お客様が開始した移管のステータスを追跡するには、このエンドポイントを使用します。
- メソッド:
GET - パス:
/api/domains/v1/move/outgoing/{domain}
domains_move_start-outgoing
指定したドメインを別のHostingerアカウントへ移管します。
ドメインの所有者が変わる前に、移管先のアカウントがすでに存在し、移管を承認している必要があります。
ドメインは有効である必要があります。ドメインが属するサブスクリプションは自動的に特定されます。ドメイン専用のサブスクリプションがない場合、リクエストは404ステータスコードで拒否されます。
プレミアム保護で保護されたドメインには、追加の確認手順が必要です。このようなリクエストは428ステータスコードで拒否されます。
ドメインを別のHostingerユーザーに譲渡するには、このエンドポイントを使用します。
- メソッド:
POST - パス:
/api/domains/v1/move/outgoing/{domain}
domains_move_cancel-outgoing
指定したドメインの送信移管をキャンセルします。
移管先のアカウントがまだ承認していない場合に限り、移管をキャンセルできます。 ドメインはお客様のアカウントに引き続き属します。
完了する意思がなくなった移管を取り消すには、このエンドポイントを使用します。
- メソッド:
DELETE - パス:
/api/domains/v1/move/outgoing/{domain}
domains_move_outgoing-list
お客様のアカウントから他のHostingerアカウントへ移管中のすべてのドメインを取得します。
まだ完了していない移管のみが返されます。
お客様が開始した移管と、その移管先アカウントを追跡するには、このエンドポイントを使用します。
- メソッド:
GET - パス:
/api/domains/v1/move/outgoing
domains_portfolio_authorization-code
指定したドメインの認証コード(EPPコード)を取得します。このコードを使用して、ドメインをHostingerから別のレジストラーへ移管できます。
新しいコードをリクエストすると、以前に取得したコードは無効になります。
ドメインを別のレジストラーへ移管するために必要なコードを取得するには、このエンドポイントを使用します。
- メソッド:
GET - パス:
/api/domains/v1/portfolio/{domain}/auth-code
domains_portfolio_claim-free
アカウントで利用可能な無料ドメインを取得して登録します。
ドメインを購入する場合とは異なり、すでにお持ちの無料ドメインを使用するため、 支払い方法は不要です。
成功レスポンスは、ドメインが登録されたことを示します。登録に失敗した場合は、 hPanelにログインして、ドメインの登録状況を確認してください。
WHOIS情報が指定されていない場合は、そのTLDのデフォルトの連絡先情報が使用されます。 リクエストを行う前に、希望するTLDのWHOIS情報がアカウントに登録されていることを確認してください。
一部のTLDではadditional_detailsの指定が必要で、取得前に内容が検証されます。
処理できないリクエストは、レスポンス本文にエラーコードを含めて拒否されます。
たとえば、利用可能な無料ドメインがない場合は2037が返されます。
このエンドポイントを使用して、アカウントの無料ドメインを登録します。
- Method:
POST - Path:
/api/domains/v1/portfolio/claim
domains_portfolio_enable-lock
ドメインロックを有効にします。
ドメインロックが有効な場合、 ロックを無効にしない限り、ドメインを別のレジストラに移管できません。
このエンドポイントを使用して、不正な移管からドメインを保護します。
- Method:
PUT - Path:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_disable-lock
ドメインロックを無効にします。
ドメインを別のレジストラに移管する前に、ドメインロックを無効にする必要があります。
このエンドポイントを使用して、ドメインを別のレジストラに移管できるように準備します。
- Method:
DELETE - Path:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_get
指定したドメインの詳細情報を取得します。
このエンドポイントを使用して、ドメインの設定とステータスを詳しく確認します。
- Method:
GET - Path:
/api/domains/v1/portfolio/{domain}
domains_portfolio_list
アカウントに関連付けられているすべてのドメインを取得します。
このエンドポイントを使用して、ユーザーのドメインポートフォリオを確認します。
- Method:
GET - Path:
/api/domains/v1/portfolio
domains_portfolio_purchase
新しいドメイン名を購入して登録します。
登録に失敗した場合は、hPanelにログインして、ドメインの登録状況を確認してください。
支払い方法が指定されていない場合は、デフォルトの支払い方法が自動的に使用されます。
レスポンスが202 Acceptedの場合、支払い処理中であり、ドメインは
登録されていません。注文が完了したら、
hPanelからドメインを登録してください。
WHOIS情報が指定されていない場合は、そのTLDのデフォルトの連絡先情報が使用されます。 リクエストを行う前に、希望するTLDのWHOIS情報がアカウントに登録されていることを確認してください。
一部のTLDではadditional_detailsの指定が必要で、購入完了前に内容が検証されます。
このエンドポイントを使用して、ユーザーの新しいドメインを登録します。
- Method:
POST - Path:
/api/domains/v1/portfolio
domains_portfolio_enable-privacy-protection
ドメインのプライバシー保護を有効にします。
プライバシー保護が有効な場合、ドメイン所有者の個人情報は公開WHOISデータベースに表示されません。
このエンドポイントを使用して、ドメイン所有者の個人情報が公開されないように保護します。
- Method:
PUT - Path:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_disable-privacy-protection
ドメインのプライバシー保護を無効にします。
プライバシー保護が無効な場合、ドメイン所有者の個人情報は公開WHOISデータベースに表示されます。
このエンドポイントを使用して、ドメイン所有者の情報を公開します。
- Method:
DELETE - Path:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_renewal-information
指定したドメインの更新情報を取得します。ステータスと現在の 有効期限が含まれます。
このエンドポイントを使用して、単一ドメインの更新自動化と有効期限の監視を構築します。
- Method:
GET - Path:
/api/domains/v1/portfolio/{domain}/renewal
domains_portfolio_complete-setup
すでに料金を支払ったものの、まだセットアップされていないドメインを登録します。
注文の完了時にドメインが登録されなかった場合に、このエンドポイントを使用します。たとえば、Purchase new domain が 202 Accepted を返し、ドメインが未登録のままアカウントに追加された場合や、以前のセットアップが失敗した場合です。新たな注文や支払いは発生しません。すでに所有しているサブスクリプションが、支払い済みの期間に対して使用されます。
注文の完了時に登録に必要な情報が不足または無効だった場合、ドメインはセットアップ待ちの状態になります。他所で注文したドメインも、同じ理由でセットアップ待ちになることがあります。不足している情報を補完してから、このエンドポイントを呼び出してください。注文自体がまだ完了していない場合、ドメインはアカウントにありません。Get domain list に表示されるまでお待ちください。
domain_contacts が省略されている場合、そのTLDのデフォルトWHOISプロファイルが4つすべての役割に使用されます。プロファイルはそのTLDに対応し、すべての項目が設定済みである必要があります。プロファイルの未設定は、ドメインがセットアップ待ちになる最も一般的な理由です。Create WHOIS profile を使って作成してください。
一部のTLDでは additional_details が必須です。これらはセットアップ前に検証されるため、値が不足しているか無効な場合、登録を試みることなくリクエストが拒否されます。
ドメインはデフォルトのネームサーバーとプライバシー保護を有効にした状態でセットアップされます。いずれかを変更するには、その後に Update domain nameservers と Disable privacy protection を使用してください。
成功レスポンスは、セットアップリクエストが受け付けられたことを示すものであり、ドメインがすでに登録済みであることを意味しません。結果は Get domain list をポーリングして確認してください。ドメインは登録後にのみ Get domain details に表示されます。
アカウントでセットアップ待ちになっているドメインの登録を完了するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/domains/v1/portfolio/{domain}/setup
domains_portfolio_update-nameservers
指定したドメインのネームサーバーを設定します。
不適切なネームサーバー設定を行うと、ドメインが名前解決できなくなったり、利用できなくなったりする場合があるため、ご注意ください。
ドメインでカスタムDNSホスティングを設定するには、このエンドポイントを使用します。
- Method:
PUT - Path:
/api/domains/v1/portfolio/{domain}/nameservers
domains_transfer_claim-free
アカウントで利用可能な無料ドメイン移管を申請し、移管を開始します。
移管を購入する場合とは異なり、すでに保有している無料ドメイン移管を消費するため、支払い方法は不要です。
リクエストを送信する前に、現在のレジストラでドメインのロックを解除し、認証コードを取得してください。移管の検証が先に行われるため、移管できないドメインは、無料ドメイン移管が消費される前に拒否されます。
成功レスポンスは、移管が開始されたことを示します。完了時期は現在のレジストラによって異なります。移管一覧エンドポイントで進行状況を確認できます。
WHOIS情報が指定されていない場合、そのTLDのデフォルト連絡先情報が使用されます。リクエストを送信する前に、希望するTLDのWHOIS情報がアカウントに存在することを確認してください。
実行できないリクエストは、レスポンスボディにエラーコードを含む形で拒否されます。
アカウントの無料ドメイン移管を使ってドメインを移管するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/domains/v1/transfers/claim
domains_transfer_get
指定したドメインの移管情報を取得します。
ドメインの着信または発信レジストラ移管と、そのステータスを追跡するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/domains/v1/transfers/{domain}
domains_transfer_list
ポートフォリオ内のすべてのドメイン移管を取得します。
ドメイン全体の着信および発信レジストラ移管を監視するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/domains/v1/transfers
domains_transfer_start
別のレジストラからアカウントにドメインを移管します。
移管は、購入済みのドメイン移管サービスで実行されます。
リクエストを送信する前に、現在のレジストラでドメインのロックを解除し、認証コードを取得してください。
応答が成功した場合、移管が開始されたことを意味します。完了時期は現在のレジストラによって異なります。移管一覧エンドポイントで進捗を確認できます。
WHOIS 情報が指定されていない場合、その TLD のデフォルトの連絡先情報が使用されます。リクエストを送信する前に、希望する TLD の WHOIS 情報がアカウントに登録されていることを確認してください。
このエンドポイントを使用して、他所で登録したドメインをアカウントに移管します。
- Method:
POST - Path:
/api/domains/v1/transfers
domains_whois_change-for
ドメインの WHOIS 連絡先プロフィールを変更します。
指定した連絡先ロールを新しい WHOIS プロフィールに切り替え、レジストリに変更を申請します。現在それらのロールに割り当てられているプロフィールは自動的に特定されます。指定したロールが現在すべて同じプロフィールに割り当てられていない場合、リクエストは失敗します。
所有者の連絡先にある移管に関わる項目を変更すると、IRTP の確認手続きが開始されます。
変更は非同期で処理されます。
このエンドポイントを使用して、登録済みドメインの連絡先情報を別の情報に変更します。
- Method:
PUT - Path:
/api/domains/v1/whois/change
domains_whois_set-as-default
WHOIS 連絡先プロフィールをデフォルトに設定します。
新しいドメインを登録する際、そのプロフィールが属する TLD に対してデフォルトのプロフィールがあらかじめ選択されます。
このエンドポイントを使用して、登録のたびに連絡先情報を選択する手間を省けます。
- Method:
PUT - Path:
/api/domains/v1/whois/default/{whoisId}
domains_whois_unset-default
WHOIS 連絡先プロフィールのデフォルト設定を解除します。
プロフィール自体は保持されますが、その TLD に対して事前選択されなくなります。
このエンドポイントを使用して、新しい登録で連絡先情報が再利用されないようにします。
- Method:
DELETE - Path:
/api/domains/v1/whois/default/{whoisId}
domains_whois_get
WHOIS 連絡先プロフィールを取得します。
このエンドポイントを使用して、ドメイン登録の連絡先情報を確認します。
- Method:
GET - Path:
/api/domains/v1/whois/{whoisId}
domains_whois_delete
WHOIS 連絡先プロフィールを削除します。
このエンドポイントを使用して、不要な連絡先プロフィールをアカウントから削除します。
- Method:
DELETE - Path:
/api/domains/v1/whois/{whoisId}
domains_whois_list
WHOIS 連絡先プロフィールを取得します。
このエンドポイントを使用して、ドメイン登録に利用できる連絡先プロフィールを確認します。
- Method:
GET - Path:
/api/domains/v1/whois
domains_whois_create
WHOIS 連絡先プロフィールを作成します。
このエンドポイントを使用して、ドメイン登録用の新しい連絡先情報を追加します。
- Method:
POST - Path:
/api/domains/v1/whois
domains_whois_usage
指定した WHOIS 連絡先プロフィールが使用されているドメインの一覧を取得します。
このエンドポイントを使用して、特定の連絡先プロフィールを使用しているドメインを確認します。
- Method:
GET - Path:
/api/domains/v1/whois/{whoisId}/usage
hostinger-ecommerce-mcp
ecommerce_discounts_list
ストアの割引を一覧表示します。コードと名前に対するフリーテキスト、または無効状態で絞り込めます。固定額割引の金額は最小通貨単位の整数で、割合割引は 1~100 の整数値です。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_discounts_create
ストアの割引を作成します。固定額割引には最小通貨単位の金額(例:$10 は 1000)を指定し、割合割引には 1~100 の整数値を指定します。送料無料割引では値は無視されます。作成された割引を返します。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_miscellaneous_custom-storefront-setup-instructions
カスタム販売チャネルをストアに接続し、Ecommerce API を通じてカタログ、注文、配送、決済を同期するための手順を、Markdown 形式で取得します。
- Method:
GET - Path:
/api/ecommerce/v1/miscellaneous/custom-storefront-instructions
ecommerce_orders_cancel
注文をキャンセルし、必要に応じて顧客にメールを送信します。更新された注文の概要を返します。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/cancel
ecommerce_orders_fulfil
注文のフルフィルメントを作成し、1 回の呼び出しで追跡情報を追加します。未指定の場合、未フルフィルメントの残りのすべての商品が対象になります。更新された注文の概要を返します。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/fulfill
ecommerce_orders_list-store
ストアの注文を新しい順に概要として一覧表示します。ステータス、決済またはフルフィルメントのステータス、顧客のメールアドレス、注文番号、またはフリーテキストのクエリで絞り込めます。金額は通貨の最小単位で表示されます。明細、住所、フルフィルメントを確認するには、個別の注文を取得してください。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/orders
ecommerce_orders_retrieve
注文の全情報を取得します。明細(各項目には fulfill エンドポイントで必要な ID が含まれます)、住所、合計の内訳、追跡情報付きのフルフィルメントが含まれます。金額は通貨の最小単位で表示されます。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}
ecommerce_payments_enable-manual-method
手動決済方法を有効にして、オンライン決済プロバイダーなしでストアが注文を受け付けられるようにします。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/payment-methods/manual
ecommerce_payments_create-provider-connect-link
決済ゲートウェイをストアに接続するためのオンボーディングリンクを作成します。加盟店が開くゲートウェイのオンボーディング URL と、ストア管理画面へのディープリンクを返します。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/payment-providers/{provider_id}/connect-link
ecommerce_payments_list-store-providers
ストアの決済プロバイダーを、ストアにすでに接続済みのプロバイダーとインストール可能なゲートウェイに分けて一覧表示します。ゲートウェイの認証情報、シークレット、設定情報は公開されません。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/payment-providers
ecommerce_products_create-image-upload-url
商品画像をアップロードするための署名付き URL を返します(multipart/form-data POST)。その後、返された object_name を指定して attach-image エンドポイントを呼び出すと、画像をスキャンして商品に添付できます。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images/upload-url
ecommerce_products_delete
商品とそのバリエーションをストアから削除します。有効な購読者がいるサブスクリプション商品は、データを引き続き利用できるよう、削除ではなくアーカイブされます。
- Method:
DELETE - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_update
商品の名前、説明、ステータス、SEO 設定、またはコレクションを更新します。購入可能にするにはステータスを published に、非表示にするには draft に、販売を終了するには archived に設定します。SEO 設定(タイトル、説明、スラッグ)を省略すると、現在の値が保持されます。collection_changes を使うと、他のコレクションに変更を加えずにコレクションを追加または削除できます。バリエーション、価格、在庫はここではなく、バリエーション用エンドポイントで管理します。更新された商品の概要を返します。
- Method:
PATCH - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_create-digital
単一のバリエーションと任意の外部ダウンロードリンクを含む、公開済みのデジタル商品を作成します。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/products/digital
ecommerce_products_list
ストアの商品を、新しい順に簡潔な概要(名前、ステータス、サムネイル、バリエーション数、価格帯)で一覧表示します。価格は最小通貨単位の整数で、バリエーションに設定されています。ステータス、フリーテキスト、または商品 ID のセットで絞り込めます。include=variants を指定すると、各商品の価格と在庫を含むバリエーションが埋め込まれます。include=media を指定すると、メディアが埋め込まれます。
- メソッド:
GET - パス:
/api/ecommerce/v1/stores/{store_id}/products
ecommerce_products_create-physical
ストアの通貨で価格を設定した単一のバリエーションを持つ、公開済みの物理商品を作成します。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores/{store_id}/products/physical
ecommerce_products_upload-and-attach-image
URL からラスター画像(JPEG、PNG、GIF、WebP、最大 15MB)を取得し、1 回の呼び出しで商品に添付します。画像のダウンロードには、認証情報を埋め込んでいないポート 443 の HTTPS が必要です。リダイレクトは最大 1 回まで許可され、その転送先も同じ要件を満たす必要があります。プライベートネットワークまたは予約済みネットワークの転送先、サポートされていない URL、複数回のリダイレクトは拒否されます。画像はウイルススキャンとコンテンツ検証を行ったうえで、CDN に保存されます。is_thumbnail を設定すると、その画像が商品のメイン画像になります。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images
ecommerce_sales-channels_list
ストアの有効な販売チャネルを、すべてのメタデータとともに一覧表示します。
- メソッド:
GET - パス:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_create
ストアの販売チャネルを作成します。「custom」チャネルはヘッドレスです。独自のフロントエンドを構築し、Ecommerce API を通じてカタログ、注文、配送、決済を同期します。「quick-link」チャネルは、ハンドルが自動生成されるホスト型の 1 ページストアです。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_update
カスタム販売チャネルを更新します。販売者向けの name と、公開用の url(チャネルの domain として返されます)を変更できます。値をクリアするには null を渡します。
- メソッド:
PATCH - パス:
/api/ecommerce/v1/stores/{store_id}/sales-channels/{sales_channel_id}
ecommerce_shipping_set-store
ストアの定額配送料を設定します。配送ゾーンがまだ存在しない場合は作成します。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores/{store_id}/shipping
ecommerce_stores_delete
アカウントが所有するストアを論理削除します。
基盤となるストアデータは保持され、ストアに削除済みのマークが付けられるだけです。
- メソッド:
DELETE - パス:
/api/ecommerce/v1/stores/{store_id}
ecommerce_stores_list
アカウントに関連付けられているストアを取得します。
- メソッド:
GET - パス:
/api/ecommerce/v1/stores
ecommerce_stores_create
アカウント用の新しいストアを作成します。
ストアと同時にメインの販売チャネルも作成されます。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores
ecommerce_stores_metadata
ストアの準備状況に関するメタデータを取得します。決済方法と配送が設定済みかどうか、およびデフォルト通貨を確認できます。ストアフロントを構築する前に前提条件を確認するのに便利です。
- メソッド:
GET - パス:
/api/ecommerce/v1/stores/{store_id}/metadata
ecommerce_product-variants_update-in-batch
既存のバリエーションを ID で最大 100 件、一括更新します。更新可能な項目は、タイトル、SKU、在庫、在庫追跡、価格です。リクエストに含まれないバリエーションは変更されません。価格は既存の価格をすべて置き換えます。更新後のバリエーションを返します。
- メソッド:
PATCH - パス:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/batch
ecommerce_product-variants_delete
商品から単一のバリエーションを削除します。
- メソッド:
DELETE - パス:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}
ecommerce_product-variants_list
商品のバリエーションを、ランク順にオプション、価格、在庫とともに一覧表示します。 価格は最小通貨単位の整数で、バリエーションに設定されます。
- メソッド:
GET - パス:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
ecommerce_product-variants_create
1つ以上のオプション項目(例:サイズ、色)に沿って、商品にバリエーションを追加します。商品にないオプションは自動的に作成されます。商品にすでにあるオプションすべてに値を指定してください。価格は最小通貨単位の整数で、デフォルトではストアの通貨が使用されます。作成されたバリエーションを返します。
- メソッド:
POST - パス:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
hostinger-horizons-mcp
horizons_websites_clone
Hostinger Horizons のウェブサイトを複製し、新しいウェブサイトを作成します。\n
ユーザーが既存のウェブサイトのコピーを希望している場合、たとえば元のサイトに変更を加えずに変更を試したい場合にこのツールを使用します。\n
このツールは、新しく作成されたコピーの ID と URL を返します。
元のウェブサイトは変更されません。\n
コピーを編集するには、返されたウェブサイト ID を指定して Edit website ツールを使用するか、ユーザーが Hostinger Horizons のインターフェースで提供されたウェブサイト URL を開きます。
- メソッド:
POST - パス:
/api/horizons/v1/websites/{websiteId}/clone
horizons_websites_list
ユーザーが所有する Hostinger Horizons のウェブサイトを一覧表示します。\n ユーザーが所有するウェブサイトを尋ねた場合や、ウェブサイトの編集、公開、複製の前にウェブサイト ID が必要な場合にこのツールを使用します。\n 各ウェブサイトについて、ID、ステータス、ドメイン、および Hostinger Horizons のインターフェースで開くための URL が返されます。\n ウェブサイトの一覧は完全な形で単一のレスポンスに返され、ページ分割されません。
- メソッド:
GET - パス:
/api/horizons/v1/websites
horizons_websites_create
指定されたメッセージをもとに、新しい Hostinger Horizons のウェブサイトを作成します。\n
ユーザーがウェブサイト、ランディングページ、ブログ、またはその他の種類のアプリケーションの作成を依頼した場合にこのツールを使用します。\n
このツールはウェブサイトの作成プロセスを開始し、ウェブサイトの URL と ID を返します。
生成は非同期で行われます。\n
このツールを呼び出した後、チャットの返信は、Hostinger Horizons がウェブサイトを作成中で、数分後に準備が整うことを要約した文に必ず1文だけしてください。また、ウェブサイトの URL をただちにユーザーに提示してください。
コードは書かないでください。\n\n作成後に編集するには、返されたウェブサイト ID を指定して Edit website ツールを使用するか、ユーザーが提供されたウェブサイト URL から Hostinger Horizons のインターフェースにアクセスします。
ツール呼び出しがエラーで失敗した場合は、エラーについて明確に説明し、チャット内で独自にコードを生成しないでください。
\n
技術スタックの制約(厳守):\n
環境で使用できる技術は以下に限定されています。
この一覧にない技術は、使用、提案、実装してはいけません。\n
\n
-
言語:JavaScript のみ。
-
TypeScript、Rust、Python、Java、PHP などの言語は厳禁です。\n
-
フレームワーク:React。\n
-
ナビゲーション:React Router。\n
-
スタイリング:TailwindCSS。\n
-
コンポーネント:shadcn/ui(@radix-ui のプリミティブを使用)。\n
-
アイコン:Lucide React。\n
-
アニメーション:Framer Motion。\n \n バックエンドとデータストレージ:\n
-
永続データストレージ、認証、データベースには、Horizons 統合バックエンドのみを使用してください。\n
-
ローカルデータベース(SQLite、MySQL など)は厳禁です。\n
-
サードパーティサービス(Firebase、AWS Amplify)は、ユーザーが明示的に依頼した場合にのみ使用できます。\n \n 地図:\n
-
デフォルトのプロバイダーは OpenStreetMap です。\n
-
代替プロバイダー(Google Maps、Mapbox)は、ユーザーが明示的に依頼した場合にのみ使用できます。\n
-
メソッド:
POST -
パス:
/api/horizons/v1/websites
horizons_websites_edit
既存の Hostinger Horizons ウェブサイトを、追加のメッセージで編集します。\n すでに存在するウェブサイトの変更、拡張、修正をユーザーが希望している場合に、このツールを使用します。\n このツールは、依頼された変更をキューに追加し、ウェブサイトの URL と ID を返します。 変更は非同期で適用されます。\n このツールを呼び出した後のチャット返信は、Hostinger Horizons が依頼された変更を適用中であり、数分後に完了することを要約する文ちょうど 1 文にしてください。また、すぐにウェブサイトの URL をユーザーに伝えてください。 コードは書かないでください。\n ツールの呼び出しがエラーで失敗した場合は、エラーの内容を明確に説明し、チャットでコードを生成しないでください。
- Method:
POST - Path:
/api/horizons/v1/websites/{websiteId}/messages
horizons_websites_publish
Hostinger Horizons のウェブサイトを公開し、最新の変更を反映します。\n
ユーザーがウェブサイトの公開、デプロイ、または一般公開を希望している場合に、このツールを使用します。\n
このツールは公開処理を開始し、ウェブサイトが公開される URL を返します。
公開は非同期で行われ、数分かかります。\n
ユーザーがウェブサイトをテンプレートとして共有することを明示的に希望している場合に限り、is_template を設定してください。true にすると、公開ページに「テンプレートを使用」バナーが追加され、訪問者はウェブサイトを自分のアカウントにコピーできます。false にすると、バナーが削除されます。現在の設定を維持する場合は、この項目を省略してください。\n
このツールを呼び出した後のチャット返信は、ウェブサイトを公開中であることを要約する文ちょうど 1 文にしてください。また、すぐに公開 URL をユーザーに伝えてください。
- Method:
POST - Path:
/api/horizons/v1/websites/{websiteId}/publish
horizons_websites_get
ユーザーが Hostinger Horizons のインターフェースでウェブサイトを開くためのリンクを取得します。\n
既存のウェブサイトへのリンクをユーザーが希望している場合や、編集の前後にウェブサイトの URL が必要な場合に、このツールを使用します。\n
変更の生成中、またはウェブサイトの公開中は is_in_progress が true になります。公開する前に、false になるまで待ってください。published_at は最後にウェブサイトを公開した日時、is_template は公開ページに「テンプレートを使用」バナーが表示されるかどうか、has_ecommerce_store はオンラインストアがあるかどうかを示します。\n
ウェブサイトは Edit website ツールを使用するか、提供されたウェブサイト URL から Hostinger Horizons のインターフェースを開いて編集できます。
- Method:
GET - Path:
/api/horizons/v1/websites/{websiteId}
hostinger-hosting-mcp
hosting_deploy
Hostinger の Web ホスティング(Shared、Cloud)に、ローカルディレクトリ、アーカイブ、GitHub または GitLab リポジトリから、静的 HTML、PHP、Node.js アプリ、WordPress サイト全体、または WordPress プラグインやテーマをデプロイ、公開、アップロードします。プロジェクトの種類を検出し、アップロード、ビルド、Git の設定を自動で行います。アップロードやビルドの操作を呼び出したり、ディレクトリを自分でアーカイブしたりしないでください。警告:ウェブサイトのコンテンツを上書きし、元に戻せません。すでにコンテンツがあるサイトにデプロイする前に、ユーザーにドメインを確認してください。Node.js のビルドはサーバー上で実行されます。まず buildUuid が返されるので、ビルド状態が完了または失敗になるまで hosting_get-deployment を呼び出してください。プラグインやテーマは、ドキュメントルート内のフォルダーに WordPress がある場合(ヘッドレス)の場合も含め、サイトの WordPress インストール先に配置されます。静的サイト、PHP、プラグイン、テーマのデプロイはこの呼び出しが返る時点で完了します。WordPress サイトのインポートは開始されるだけで、ファイルは数分後に展開されます。Git を使用する場合、サイトがすでに Node.js アプリを実行しているか、Node.js の設定を指定する場合を除き、type(static または nodejs)を渡してください。静的サイトまたは PHP サイトはブランチを今すぐデプロイし、その後は push のたびにデプロイします。Node.js サイトはブランチを今すぐビルドし、その後は push のたびにビルドします。設定はサイトに保存されます(保存済みの設定がない場合は、ブランチの package.json から検出されます。上書きするには appType、nodeVersion、outputDirectory、buildScript、entryFile を渡してください)。Git を使用するには、hPanel で GitHub または GitLab を一度接続する必要があります。
- Method:
custom - Path:
custom
hosting_get-deployment
ウェブサイトの Node.js デプロイについて、デプロイ状態、ビルド状態、ビルドログ、ビルド失敗の理由(失敗分析)を確認します。最新のビルド(または buildUuid)の状態、ビルドログの末尾、ビルド失敗時の失敗分析、サイトに保存されているビルド設定と Git 自動デプロイ設定を取得します。hosting_deploy で Node.js のビルドを開始した後や、デプロイが失敗した理由を確認する場合に使用してください。ビルド状態が完了または失敗になるまで、間隔を徐々に長くしながらポーリングしてください。ログ全体が返されます。前回の呼び出し以降の新しい出力のみを読むには、fromLine(前回の呼び出し以降の行数)を渡してください。Node.js のビルドがないウェブサイトでは、build: null と説明が返されます。静的サイト、PHP、プラグイン、テーマのデプロイは hosting_deploy の呼び出しが返る時点で完了し、WordPress サイトのインポートは開始から数分後に完了するためです。
- Method:
custom - Path:
custom
hosting_websites_trigger-event
このウェブサイトで何かが起きたことを Hostinger に通知し、hPanel などの Hostinger サービスがそれに応じて動作できるようにします。event.name でイベントを選択し、受け取る event.params が決まります。この呼び出しによってウェブサイトが変更されることはありません。
- Method:
custom - Path:
custom
hosting_cache_clear-website
ウェブサイトのサーバー側キャッシュをすべて一度に完全に消去します。コンテンツを更新してすぐに反映させたい場合や、大幅な変更を加えた後に使用してください。
ウェブサイトで CDN が有効になっている場合は、Hostinger CDN キャッシュも消去します。サーバーキャッシュをそのままにして CDN キャッシュのみを消去するには、Purge CDN cache を使用してください。サブディレクトリにある WordPress インストールのキャッシュを消去するには、directory クエリパラメーターにそのディレクトリを渡してください。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/clear
hosting_cache_status
ウェブサイトのキャッシュ状態を返します。サーバー側のキャッシュが有効かどうか、および開発モード(キャッシュなし)が有効かどうかを確認できます。アカウントのメインドメイン、追加ウェブサイト、パークドメイン、サブドメインに対応しており、それぞれ独自の設定が適用され、親ウェブサイトの設定は引き継がれません。
is_enabled は Toggle website cache によって変更される設定で、切り替えるとすぐに反映されます。開発モードが有効な間は is_cacheless_mode_enabled が true になり、is_enabled が true であってもキャッシュはバイパスされます。Toggle cacheless mode はバックグラウンドで適用されるため、このフラグが反映されるまで数分かかることがあります。
ドメインには、アカウントに登録されているウェブサイト名を正確に指定する必要があります。www. プレフィックスは付けないでください。ドメインがアカウントのウェブサイトでない場合は 404 を返します。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/status
hosting_cache_toggle-cacheless
有効フラグに基づいて、開発モード(キャッシュなし)をオンまたはオフにします。有効にすると何もキャッシュされず、ウェブサイトのすべてのキャッシュが実質的に無効になります。開発作業中、変更のテスト中、問題のデバッグ中、またはリアルタイムで更新を反映する必要がある場合に使用してください。開発作業が終了したら無効にして、キャッシュによるパフォーマンス向上を回復してください。
変更はバックグラウンドで適用され、完了まで数分かかることがあります。現在の状態を確認するには、Get cache status を使用してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cacheless-mode/toggle
hosting_cache_toggle-website
有効フラグに基づいて、ウェブサイトのサーバー側キャッシュをオンまたはオフにします。ページの読み込みを高速化し、サーバーの負荷を軽減して、ユーザーエクスペリエンスを向上させるには、有効にしてください。本番環境のウェブサイトでの使用を推奨します。無効にするとパフォーマンスに影響する可能性があります。開発中やデバッグ中に一時的にキャッシュをバイパスするには、代わりにキャッシュなしモードを切り替えてください。
キャッシュがすでに要求された状態の場合、何も行いません。現在の状態を確認するには、Get cache status を使用してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/toggle
hosting_cdn_disable
ウェブサイトのドメインで Hostinger CDN を無効にします。DNS の伝播が完了すると、ウェブサイトのコンテンツはオリジンサーバーから直接配信されます。この呼び出しは繰り返しても安全です。CDN がすでに無効になっている場合も、DNS の変更が再度適用されます。
CDN を無効にできないプラットフォーム管理ドメイン(例:*.hostingersite.com および *.app-preview.com)では、CDN がすでにオフの場合でも 422 を返します。また、アカウントを別のサーバーに移行中の場合(移行完了後に再試行してください)、または CDN プロバイダーが変更を拒否した場合も 422 を返します。ドメインがアカウントのウェブサイトでない場合は 404 を返します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/disable
hosting_cdn_enable
ウェブサイトのドメインで Hostinger CDN を有効にします。ページの読み込みを高速化し、サーバーの負荷を軽減します。アカウントのメインドメイン、パークドメイン、サブドメインに対応しています。
有効にすると、ドメインの DNS レコードが変更され、通常は数秒で完了します。その後、訪問者が CDN 経由で配信されるまで、DNS の伝播にさらに数分かかることがあります。
タイムアウト後などに呼び出しを繰り返しても安全です。CDN がすでに有効になっている場合も、DNS の変更が再度適用され、CDN の SSL 証明書が更新されます。
アカウントが無効になっている場合、アカウントを別のサーバーに移行中の場合(移行完了後に再試行してください)、または CDN プロバイダーが変更を拒否した場合は 422 を返します。ドメインがアカウントのウェブサイトでない場合は 404 を返します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/enable
hosting_cdn_purge-cache
Hostinger CDN のエッジキャッシュからウェブサイトのコンテンツのみをパージします。オリジンサーバーのキャッシュには影響しません。両方をクリアするには、Clear website cacheを使用してください。
ウェブサイトで CDN が有効になっていない場合は 422 を返します。ドメインがアカウント内のウェブサイトでない場合は 404 を返します。
- メソッド:
DELETE - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/purge
hosting_cdn_status
ウェブサイトのドメインで Hostinger CDN が有効かどうかを返します。アカウントのメインドメイン、パークドメイン、サブドメインに対応しています。
ドメインには、www.プレフィックスを付けず、アカウントに登録されているウェブサイト名を正確に指定する必要があります。ドメインがアカウント内のウェブサイトでない場合は 404 を返します。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/status
hosting_cron-jobs_list
指定したアカウントに設定されている cron ジョブの一覧を、スケジュールとコマンドを含めて返します。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_create
スケジュール式とコマンドを指定して、指定したアカウントの cron ジョブを作成します。
作成した cron ジョブを返します。これには、cron ジョブの削除や出力の取得に必要な uid が含まれます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_delete
uid で指定した cron ジョブを完全に削除します。
uid は cron ジョブ一覧のエンドポイントから返されます。
- メソッド:
DELETE - パス:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}
hosting_cron-jobs_output
uid で指定した cron ジョブの最後の実行時に取得された出力を返します。
uid は cron ジョブ一覧のエンドポイントから返されます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}/output
hosting_databases_change-password
指定したデータベースユーザーのパスワードを変更します。
データベース名には、データベース一覧のエンドポイントから返される完全な名前を指定する必要があります。 このデータベースを使用するすべてのウェブサイト設定でも、パスワードを更新する必要があります。
- メソッド:
PATCH - パス:
/api/hosting/v1/accounts/{username}/databases/{name}/change-password
hosting_databases_list
指定したアカウントのデータベース一覧を、ページネーション付きで返します。
特定のドメインに割り当てられたデータベースを検索するには、domain フィルターと is_assigned フィルターを使用します。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_create
指定したアカウントに、データベースユーザーとパスワードを設定したデータベースを作成します。
必要に応じて、データベース名とユーザー名にはアカウントのユーザー名が自動的にプレフィックスとして付加されます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_delete
データベースとそのリモート接続を完全に削除します。
データベース名には、データベース一覧のエンドポイントから返される完全な名前を指定する必要があります。
- メソッド:
DELETE - パス:
/api/hosting/v1/accounts/{username}/databases/{name}
hosting_databases_create-remote-connection
リモートホストが指定したデータベースに接続できるようにします。
IPv4/IPv6 アドレスを指定するか、任意のホストからの接続を許可するには「%」を指定します。データベース名には、データベース一覧のエンドポイントから返される完全な名前を指定する必要があります。データベースの作成は同期的に行われるため、ここで 404 が返された場合、そのユーザー名の下にその名前のデータベースが存在しないことを意味し、作成中であることを示すものではありません。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_delete-remote-connection
リモートアクセスルールを完全に削除し、指定したホストのデータベースへのリモートアクセスを取り消します。
必須の ip クエリパラメーター(IPv4/IPv6 アドレス、または「%」。list remote connections エンドポイントが返す値と完全に一致するもの)でルールを特定します。データベース名には、list databases エンドポイントが返す完全な名前を指定してください。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_list-remote-connections
指定したアカウントのリモートアクセスルールを返します。これらのルールは、アカウントのデータベースへの接続を許可されたリモートホスト(IPv4/IPv6 アドレス、または任意のホストを表す「%」)を示します。
ドメインフィルターを使用すると、特定のドメインに割り当てられたデータベースのルールのみを返せます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/databases/remote-connections
hosting_databases_repair
破損したデータベーステーブルを非同期で修復します。
データベースのエラー、クラッシュ、破損が報告された場合に使用します。 データベース名には、list databases エンドポイントが返す完全な名前を指定してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/databases/{name}/repair
hosting_databases_setup-website
ウェブサイト用の新しい MySQL データベースを作成し、接続情報をウェブサイトの環境変数に書き込んでから、アプリケーションを再起動します。プラットフォームがパスワードを生成します(指定されていない場合はデータベース名とユーザーも生成します)。パスワードは返されません。アプリケーションは環境からパスワードを読み取ります。
書き込まれる変数:DB_HOST、DB_PORT、DB_NAME、DB_USER、DB_PASSWORD、およびDATABASE_URL(mysql://user:password@host:port/name。user と password はパーセントエンコードされます)。既存の変数は保持されます。ウェブサイトにこれらの名前の変数がすでに存在する場合、この呼び出しは 422 エラーで失敗し、何も作成されません。Replace Node.js environment variables エンドポイントを使うと、これらを削除できます。
この呼び出し後、変数は通常の環境変数になります。Replace Node.js environment variables エンドポイントを使えば、ほかの環境変数と同様に変更または削除できます。
Express や NestJS のようにプロセス開始時に環境変数を読み取るアプリでは、再起動するだけで十分です。ビルド出力に変数を埋め込むフレームワーク(Next.js、NEXT_PUBLIC_*)では、新しい値が反映されるのは再ビルド後のみです(Start Node.js build エンドポイント)。
リクエスト内のパスワードは無視されます。プラットフォームが常にパスワードを生成します。オプションの name と user は識別子であり、シークレットではありません。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/databases/setup
hosting_databases_phpmyadmin-link
指定したデータベースの phpMyAdmin への直接ログインリンクを返します。
SQL クエリ、インポート、エクスポート、テーブル管理のために視覚的なデータベースインターフェースが必要な場合に使用します。 データベース名には、list databases エンドポイントが返す完全な名前を指定してください。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/databases/{name}/phpmyadmin-link
hosting_datacenters_list
利用可能なデータセンターの容量と注文したホスティングプランに基づき、ホスティングプランの設定に利用できるデータセンターの一覧を取得します。 一覧の最初の項目が、注文の要件に最も適したデータセンターです。
- Method:
GET - Path:
/api/hosting/v1/datacenters
hosting_domains_generate-free-subdomain
カスタムドメインを購入せずにホスティングサービスで使用できる、一意の無料サブドメインを生成します。 無料サブドメインを使えば、ホスティングサービスをすぐに利用開始でき、後からいつでもサイトにカスタムドメインを接続できます。
- Method:
POST - Path:
/api/hosting/v1/domains/free-subdomains
hosting_domains_list-website-parked
選択したウェブサイトに作成された、すべてのパークドメインまたはエイリアスドメインを取得します。
このエンドポイントを使用して、特定のウェブサイトのパークドメイン設定を確認できます。 各パークドメインに割り当てられた親ドメインとルートディレクトリも確認できます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_create-website-parked
選択したウェブサイトにパークドメインまたはエイリアスドメインを作成します。
ウェブサイト上でパークするドメイン名または IP アドレスを指定すると、親ドメインと同じコンテンツを提供します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_delete-website-parked
選択したウェブサイトから既存のパークドメインまたはエイリアスドメインを削除します。
このエンドポイントを使用して、不要になったパークドメインを削除します。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains/{parkedDomain}
hosting_domains_list-website-subdomains
選択したウェブサイトに作成された、すべてのサブドメインを取得します。
このエンドポイントを使用して、特定のウェブサイトのサブドメイン設定を確認できます。 各サブドメインに割り当てられた親ドメインとルートディレクトリも確認できます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_create-website-subdomain
選択したウェブサイトに新しいサブドメインを作成します。
サブドメインのプレフィックスと、任意でカスタムディレクトリまたはウェブサイトの公開ディレクトリを指定して、サブドメインのルートとして使用します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_delete-website-subdomain
選択したウェブサイトから既存のサブドメインを削除します。
このエンドポイントを使用して、不要になったサブドメインを削除します。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains/{subdomain}
hosting_domains_verify-ownership
単一のドメインの所有権を確認し、検証状況を返します。
新しいウェブサイトで使用する前に、ドメインにアクセスできるか確認するには、このエンドポイントを使用します。
ドメインにアクセスできる場合、レスポンスの is_accessible: true となります。
アクセスできない場合は、指定された TXT レコードをドメインの DNS レコードに追加して、もう一度検証してください。
新しい TXT DNS レコードが反映されるまで、最大 10 分かかる場合があります。
Hostinger の無料サブドメイン(*.hostingersite.com)を使用する場合は、この検証を省略してください。
- Method:
POST - Path:
/api/hosting/v1/domains/verify-ownership
hosting_files_list-website-and-directories
ウェブサイトのドキュメントルート配下にあるファイルとディレクトリを一覧表示します。
directory を使用して、ドキュメントルートからの相対パスでサブディレクトリを表示できます。シンボリックリンクされた項目も一覧表示されますが、そのリンク先に移動したり、解決したりすることはありません。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/domains/{domain}/files
hosting_files_website-content
ウェブサイトのドキュメントルートからの相対パスで指定した、単一ファイルの内容を取得します。
読み取り専用です。シンボリックリンク、大きすぎるファイル、テキスト以外のファイル形式、秘密情報(認証情報ファイルなど)を含むと識別されたファイルは拒否されます。これらはいずれもこのエンドポイントから返されません。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/domains/{domain}/files/content
hosting_git_delete-auto-deployment-settings
ウェブサイトの Git 自動デプロイ設定を削除します。すでにデプロイされたファイルはウェブサイトに残ります。設定を再度保存するまで、プッシュしてもデプロイされません。設定が何も構成されていない場合も成功します。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_deploy-website-repository
Git リポジトリをウェブサイトのディレクトリにクローンするか、再度プルします。ディレクトリが空、または存在しない場合は、ブランチをクローンします。このリポジトリとブランチがすでに含まれているディレクトリは、最後のコミットにリセットしてプルします。リポジトリが追跡しているファイルにサーバー上で加えた変更は破棄され、追跡していないファイルは残ります。別のリポジトリやこのリポジトリの別のブランチなど、ほかのファイルが含まれているディレクトリは拒否されます。リポジトリに composer.json がある場合、クローンまたはプルの後に composer install が実行されます。
呼び出しはデプロイが完了するまで待機し、そのログを返します。is_success が false の場合は Git または composer が失敗しており、ログに理由が記載されています。同じディレクトリに対する最初の呼び出しがサーバーの応答を待っている間は、2 回目の呼び出しは拒否されます。リクエストがタイムアウトしても、デプロイはサーバー上で完了する場合があります。その後、同じリポジトリとブランチで再度呼び出すと、プルが実行されます。
プライベートリポジトリには SSH URL と、Generate Git SSH key で生成したアカウントの Git SSH キーが必要です。このキーをデプロイキーとしてリポジトリに追加してください。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories/deploy
hosting_git_list-website-repositories
Deploy website Git repository または hPanel の Git セクションを使ってウェブサイトのディレクトリにリンクされた Git リポジトリを一覧表示します。各リポジトリのクローン URL、ブランチ、ディレクトリが含まれます。クローンに失敗したリポジトリも一覧に残り、再度デプロイするとクローンが再試行されます。GitHub および GitLab の自動デプロイはここには表示されません。Get Git auto-deployment settings を参照してください。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories
hosting_git_ssh-public-key
ホスティングアカウントの公開 SSH キーを返します。Deploy website Git repository はこのキーを使って SSH 経由でクローンとプルを行います。そのため、Git ホスト上でこのキーをデプロイキーとしてプライベートリポジトリに追加すると、そのリポジトリを利用できるようになります。アカウントにキーがまだない場合、public_key は null です。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_git_generate-ssh-key
ホスティングアカウントの SSH キーペアを作成し、公開キーを返します。アカウントにすでにキーがある場合は、そのキーを変更せずに返します。アカウント内のすべてのウェブサイトで 1 つのキーを使用します。デプロイする前に、公開キーをデプロイキーとしてプライベートリポジトリに追加してください。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_headless_submit-build-report
ヘッドレススキルが実行終了時(早期停止を含む)に書き出すビルドレポートを送信します。これにより Hostinger は、ビルドがどこで滞るかを把握できます。1 回の呼び出しにつきレポートを 1 件、リクエスト本文にレポート JSON を変更せずに指定して送信してください。ユーザーが同意した場合に限り、レポートを送信してください。
レポートは report.schema.json v1 に準拠している必要があります。無効なレポートは 422 を返し、保存されません。レポートは認証済みアカウントに紐付けられるため、アカウント情報をレポートに追加しないでください。
- Method:
POST - Path:
/api/hosting/v1/headless/agent-reports
hosting_nodejs_list-environment-variables
現在ウェブサイトに設定されている Node.js 環境変数を一覧表示します。値は常に ******** としてマスクされ、この API から読み取ることはできません。このエンドポイントは、設定されているキーの確認や変更の検証に使用してください。値の読み取りには使用しないでください。
変数を変更するには、Replace Node.js environment variables エンドポイントを使用してください。変数のセット全体が置き換えられるため、このレスポンスのマスクされた値をそのリクエストにコピーしないでください。代わりに、プロジェクトの .env ファイルまたはユーザーのプロンプトから取得した実際の値を使って、希望するセット全体を送信してください。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_replace-environment-variables
ウェブサイトの Node.js 環境変数を、指定した値に置き換えます。完全な置き換えです。リクエストに含まれていない変数は削除され、空の env_vars 配列を送信するとすべての変数が削除されます。保存すると値が書き込まれ、実行中の Node.js プロセスが再起動します。
Express や NestJS のように、プロセスの起動時に環境変数を読み込むアプリでは、再起動すれば十分です。ビルド時に変数を取り込むフレームワークでは不十分です。Next.js standalone はその一例で、ビルド時の値(NEXT_PUBLIC_* を含む)を反映するには、新たにビルドする必要があります。この呼び出しの後、Start Node.js build エンドポイントを使用して、新しい値をアプリに反映してください。
List Node.js environment variables エンドポイントは値をマスクして返すため(********)、その値をこのリクエストにコピーしないでください。必ず、プロジェクトの .env ファイルまたはユーザーのプロンプトに記載された実際の値を使って、必要な値をすべて送信してください。
- メソッド:
PUT - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_runtime-logs
Node.js アプリケーションの実行時コンソールログを、古い順に返します。各エントリにはタイムスタンプ、レベル、メッセージが含まれます。最初の呼び出しでは period(1h、1d、1w、1m のいずれか)を指定し、必要に応じて levels と limit(1~5000、デフォルトは 1000)も指定してください。一致するエントリが limit を超える場合は、新しいエントリが保持されます。
新しいエントリをポーリングするには、前回のレスポンスの total_lines + 1 を from_line として指定し、period は省略してください。period と from_line は同時に指定できません。タイムスタンプ、レベル、メッセージを含む JSON 形式ではない行はスキップされるため、total_lines がすべての生の行を数える一方で、logs に含まれるエントリ数が limit を下回ることがあります。タイムスタンプが last_deployed_at より前のエントリは、前回のデプロイに属します。アプリケーションがまだログファイルを書き込んでいない場合は、空の logs リストを返します。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_clear-runtime-logs
Node.js アプリケーションの実行時ログファイルを空にします。この操作は取り消せないため、呼び出す前にユーザーに確認してください。ログファイルがまだ存在しない場合も成功を返します。
問題を再現する前に使用すると、次の Get Node.js runtime logs の呼び出しで新しいエントリのみが返されます。ログを消去する前の from_line は再利用せず、改めて period を指定して呼び出してください。
- メソッド:
DELETE - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_restart-application
ウェブサイトの Node.js サーバープロセスを再起動します。アプリケーションの再ビルドや再デプロイは行いません。環境変数や設定の変更を反映する場合、または応答しなくなったアプリケーションを復旧する場合に使用してください。
サーバーサイドアプリケーション(Express、Next.js、NestJS など)にのみ適用されます。静的なフロントエンドアプリ(React、Vue、Vite)には永続的なサーバープロセスがないため、再起動しても効果はありません。再起動するサーバープロセスがウェブサイトにない場合も成功を返します。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/server/restart
hosting_nodejs_list-vulnerabilities
Node.js のウェブサイトで検出された既知の npm パッケージの脆弱性を、アドバイザリのメタデータ(深刻度、CVSS スコア、CVE、アドバイザリ URL)を付加して一覧表示します。結果は、深刻度の高いものから低いものへ、次に公開日の新しいものから順に並びます。絞り込むには severities クエリパラメーターを使用します。
is_patchable が true に設定された脆弱性は、更新されたパッケージバージョンを含む GitHub プルリクエストを作成する Patch Node.js Vulnerabilities エンドポイントで自動修正できます。自動修正を利用できるのは、接続済みの GitHub リポジトリからデプロイされたウェブサイトのみです。is_patching_in_progress が true に設定された脆弱性は、すでにオープン中のパッチ用プルリクエストに含まれています。パッチ用プルリクエストがオープン中の間は、マージまたはクローズされるまで、このウェブサイトに対する新しいパッチリクエストは拒否されます。
データは定期的な依存関係スキャンから取得されるため、最新のデプロイ内容が反映されるまで時間がかかることがあります。リストが空の場合、直近のスキャンで脆弱性が見つからなかったことを意味しますが、現在のデプロイに脆弱性がないことを保証するものではありません。Business および Cloud Hosting プランで利用できます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities
hosting_nodejs_patch-vulnerabilities
影響を受けるパッケージのバージョンを package.json で更新し、接続済みリポジトリに GitHub プルリクエストを作成して、選択した Node.js の脆弱性にパッチを適用します。お客様がプルリクエストを確認してマージすると、自動デプロイが開始されます。
自動修正を利用できるのは、接続済みの GitHub リポジトリからデプロイされたウェブサイトのみです。アーカイブからデプロイされたウェブサイトには自動修正の手段がないため、404 が返されます。Hostinger GitHub App にはリポジトリへの書き込みアクセス権が必要です。アクセス権がない場合、権限が不足していることを示す 403 が返されます。
is_patchable が true に設定された脆弱性のみ、パッチを適用できます。選択内にあるパッチ適用不可の ID はスキップされ、パッチ適用可能な対象のみがプルリクエストに含まれます。対象は patched_vulnerability_ids に一覧表示されます。パッチ適用可能な脆弱性が含まれない選択は、422 で拒否されます。ウェブサイトごとにオープンできるパッチ用プルリクエストは一度に 1 つのみです。次のパッチを適用する前に、プルリクエストをクローズまたはマージしてください。Business および Cloud Hosting プランで利用できます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities/patch
hosting_websites_list-setups
認証済みクライアントがアクセスできるホスティングアカウントについて、過去 24 時間以内に開始されたウェブサイトのセットアップを、新しいものから順に返します。order_id、subscription_id、または domain フィルターで一覧を絞り込めます。
ウェブサイトの作成後、またはセットアップの開始後にポーリングすることを想定しています。サーバー側のセットアップが完了する前にウェブサイトはウェブサイト一覧に表示されますが、セットアップが running の間は、そのウェブサイトを操作するエンドポイントが 404 または 409 を返すことがあります。このエンドポイントを domain フィルター付きで 10~15 秒ごとにポーリングし、ファイルのアップロード、デプロイ、データベースの作成を行う前に status: completed になるまで待ってください。failed は、セットアップが完了前に停止したか、1 時間以上進捗が報告されていないことを意味します。24 時間を超えたセットアップは一覧に表示されません。
type はセットアップ開始時に指定されたウェブサイトの種類(wordpress、headless_empty、headless_wordpress、headless_ecommerce、headless_pocketbase)です。空のウェブサイトの場合は null です。
- メソッド:
GET - パス:
/api/hosting/v1/onboardings
hosting_websites_start-setup
Web または Cloud ホスティングの注文に対するウェブサイトのセットアップを開始し、作成されたセットアップをすぐに返します。ウェブサイト自体は非同期でプロビジョニングされます。ウェブサイトのセットアップ一覧エンドポイント(hosting_websites_list-setups)を domain フィルターで10~15秒ごとにポーリングし、ファイルのアップロード、デプロイ、データベースの作成を行う前に status: completed になるまで待ってください。
空のウェブサイトを作成する場合は type を省略します。type: wordpress は、wordpress の管理者ユーザー、メールアドレス、パスワードを使用し、サイトタイトルをドメイン名として、wordpress.language が省略された場合は en_US を使用して、ウェブサイトのルートに WordPress をインストールします。ヘッドレスのタイプ(headless_empty、headless_wordpress、headless_ecommerce、headless_pocketbase)はヘッドレスウェブサイトを作成します。headless_wordpress ではさらに、生成された認証情報を使用してウェブサイトのルートにある cms ディレクトリに WordPress をインストールします。headless_empty では何もインストールされません。WordPress は後から type: headless を指定して POST /api/hosting/v1/accounts/{username}/wordpress/installations(wordpress_installations_install)でインストールできます。
生成された一時的な無料サブドメインでウェブサイトをセットアップする場合は、domain を省略します。呼び出し前に無料サブドメインを確認し、タイムアウトした呼び出しを同じドメインで照会して再試行できるようにするには、POST /api/hosting/v1/domains/free-subdomains(hosting_domains_generate-free-subdomain)で生成し、domain として指定してください。これは生成したクライアントからのみ、24時間受け付けられます。
注文にホスティングアカウントがまだない場合、セットアップではまずアカウントが作成されます。datacenter_code が指定されていればそのデータセンターが使用され、省略されていれば注文のデフォルトのデータセンターが使用されます。注文が存在しない場合、または認証済みクライアントがアクセスできない場合は404を返します。同じドメインのセットアップが実行中の場合は、Retry-After ヘッダーとともに409を返します。
- Method:
POST - Path:
/api/hosting/v1/orders/{order_id}/onboardings
hosting_orders_list
認証済みクライアントがアクセスできる注文のページ分割された一覧を取得します。
一覧に含まれるのは Web および Cloud ホスティングの注文のみです。Agency Plan の注文は GET /api/agency-hosting/v1/orders で一覧表示されます。
このエンドポイントは、ご自身のホスティングアカウントの注文に加えて、アクセス権が共有されている他のクライアントのホスティングアカウントの注文も返します。
利用可能なクエリパラメーターを使って、注文ステータスや特定の注文 ID で結果を絞り込み、目的に合った結果を取得できます。
- Method:
GET - Path:
/api/hosting/v1/orders
hosting_php_reset-extensions
ウェブサイトのすべての PHP 拡張機能をデフォルトの状態にリセットします。
拡張機能の競合からの復旧や、元の設定の復元に使用します。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions/reset
hosting_php_get
ウェブサイトの PHP 設定全体を返します。これには、現在のバージョン、利用可能なバージョン(サポート対象および対象外)、有効または無効な拡張機能、現在値、デフォルト値、型、プランの上限(max)を含むオプション、競合する拡張機能のグループが含まれます。
バージョン、拡張機能、オプションを更新する前に、現在の PHP 設定を確認するために使用します。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/details
hosting_php_info
ウェブサイトの phpinfo ページ全体(HTML)を返します。
PHP の問題のデバッグや、ウェブサイトの PHP 環境全体の確認に使用します。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/php-info
hosting_php_update-extensions
ウェブサイトの PHP 拡張機能(モジュール)を有効または無効にします。
変更前に、PHP の詳細取得エンドポイントを使用して現在の拡張機能の状態を確認してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions
hosting_php_update-options
ウェブサイトの PHP オプション(例:memory_limit、max_execution_time、upload_max_filesize)を更新します。
変更するオプションのみを options オブジェクト内に指定してください。
アカウントプランの上限を超える値は、その上限まで自動的に引き下げられるため、リクエストが成功しても適用される値が小さくなる場合があります。適用された値を確認するには、後で PHP 詳細の取得エンドポイントを呼び出してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/options
hosting_php_update-version
ウェブサイトの PHP バージョンを変更します。
ウェブサイトで利用可能なバージョンを確認するには、PHP 詳細の取得エンドポイントを使用してください。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/version
hosting_redirects_list-website
選択したウェブサイトに設定されているリダイレクトのページ分けされた一覧を返します。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_create-website
選択したウェブサイト上の URL から、別の URL または IP アドレスへのリダイレクトを作成します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_delete-website
ソース URL で特定されるリダイレクトを完全に削除します。
from の値には、リダイレクト一覧エンドポイントから返された値をそのまま指定してください。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_ssl_install
ウェブサイトの有効期間無制限の SSL 証明書をリクエストします。インストールはバックグラウンドで実行され、完了すると Get SSL status が active または failed を返します。有効な有効期間無制限の証明書があってもリクエストは拒否されず、新しいインストールがリクエストされます。これは証明書を再インストールする方法です。
無料サブドメイン(証明書はプラットフォームによって管理されています)の場合、インストールの状態が installing または waiting_for_retry の場合、ウェブサイトの証明書が失効している場合(再発行できません)、およびアップロードしたカスタム証明書がインストールされている場合(先にアンインストールする必要があります)は、422 を返します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/setup
hosting_ssl_status
ウェブサイトの SSL 状態を返します。証明書の status と provider、証明書がプラットフォーム管理の有効期間無制限のものかどうか、HTTP リクエストが HTTPS にリダイレクトされるかどうか、証明書の有効期限、および最後に発生したインストールエラーを確認できます。
installing と waiting_for_retry はインストール中であることを意味します。failed は、最後のインストールが失敗したか、installing の間にウェブサイトが 60 分間更新されなかったことを意味します。既知のメッセージがある場合は、その理由が last_error に格納されます。それ以外の場合は null です。expired は、割り当てられた証明書の有効期限が切れていることを意味します。not_installed は、証明書が割り当てられていないことを意味します。無料サブドメインではプラットフォーム管理の証明書が使用されます。インストール記録がない場合は、provider と expires_at が null の active が返されます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/status
hosting_ssl_toggle-https-redirect
is_enabled に基づいて、ウェブサイトの HTTP から HTTPS へのリダイレクトを有効または無効にします。リダイレクトがすでに指定された状態である場合は何も行いません。有効にするには証明書がインストールされている必要があり(Get SSL status の status が active または expired)、証明書がない場合は 422 を返します。無効にする操作は常に受け付けられます。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/https-redirect/toggle
hosting_ssl_uninstall
ウェブサイトに割り当てられた SSL 証明書を削除し、HTTPS リダイレクトを無効にして、保留中のインストール再試行をキャンセルします。新しいインストールが完了するまで、ウェブサイトは通常の HTTP で配信されます。呼び出しが戻るとすぐに Get SSL status は not_installed を返します。また、証明書が割り当てられていない場合も呼び出しは成功するため、繰り返し実行しても問題ありません。
無料サブドメイン(証明書はプラットフォームによって管理されます)およびインストールが installing の間は、422 を返します。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl
hosting_websites_list
認証済みクライアントがアクセスできるウェブサイト(CloudLinux、Builder、Horizons)のページ分けされた一覧を取得します。
このエンドポイントは、ホスティングアカウント内のウェブサイトに加えて、アクセスを共有している他のクライアントのホスティングアカウント内のウェブサイトも返します。
各ウェブサイトには、基盤プラットフォーム上で検出されたウェブサイトの種類(wordpress、builder、horizons、nodejs、other)を示す website_type フィールドが含まれます。vhost_type、username、root_directory など、一部のフィールドは CloudLinux のウェブサイトにのみ適用され、他のプラットフォームでは null になります。
website_types を使うと、検出された種類を指定してウェブサイトを絞り込めます。たとえば、WordPress ウェブサイトのみ(website_types=wordpress)または Node.js ウェブサイトのみ(website_types=nodejs)を一覧表示できます。ほかの利用可能なクエリパラメーターと組み合わせて、ユーザー名、注文 ID、有効状態、ドメイン名で絞り込み、より対象を絞った結果を取得できます。
サーバー側のセットアップが完了する前でも、ウェブサイトはこの一覧に表示されます。また、is_enabled は準備状況ではなく、停止状態を示します。新しく作成したウェブサイトでファイル操作、デプロイ、データベース操作が可能になるタイミングを確認するには、ウェブサイトセットアップ一覧エンドポイントをポーリングしてください。
- Method:
GET - Path:
/api/hosting/v1/websites
hosting_websites_create
非推奨です。代わりに POST /api/hosting/v1/orders/{order_id}/onboardings(ウェブサイトセットアップの開始)を使用してください。同じ domain と datacenter_code を指定でき、WordPress のインストールも可能で、作成したセットアップが返されます。
認証済みクライアントの新しいウェブサイトを作成します。
このウェブサイトを作成するホスティング注文を選択する必要があります。ドメイン名とともに、その注文を order_id として渡してください。利用可能な ID を確認するには注文を一覧表示します。ウェブサイトはその注文のホスティングプラン上にプロビジョニングされます。
Web および Cloud のホスティング注文のみ受け付けます。Agency Plan の注文でウェブサイトを作成するには、POST /api/agency-hosting/v1/orders/{order_id}/websites/setups を使用してください。
注文にホスティングアカウントがまだない場合は、まず新しいホスティングアカウントが設定されます。データセンターは、datacenter_code で指定したもの、または省略時は注文のデフォルトのデータセンターになります。その後のウェブサイトは、自動的に同じデータセンターでホスティングされます。
ウェブサイトの作成は非同期で、数分かかることがあります。10~15 秒ごとに domain フィルターを指定してウェブサイトセットアップ一覧エンドポイントをポーリングし、ファイルのアップロード、デプロイ、データベースの作成を行う前に status: completed になるまで待ってください。セットアップが running の間は、ウェブサイトを操作するエンドポイントが 404 または 409 を返すことがあります。ウェブサイト一覧の is_enabled は準備状況ではなく、停止状態を示します。
- Method:
POST - Path:
/api/hosting/v1/websites
hosting_websites_delete
このエンドポイントは、ウェブサイトとそのすべてのデータを完全に削除します。この操作は取り消せません。呼び出す前に、ユーザーが結果を理解し、続行することを明示的に確認していることを確かめてください。
ウェブサイトのすべてのファイル、データベースおよび関連する設定が削除されます。 ホスティングプラン自体は維持されるため、その後、新しいウェブサイトを作成できます。
対応するウェブサイト:ウェブホスティングプラン上のメインドメインおよびアドオンドメインのウェブサイト、ならびに Website Builder のウェブサイト。パークドメインとサブドメインは、このエンドポイントでは削除できません。ドメインには、プレビュードメインやエイリアスではなく、正確なウェブサイトのドメインを指定する必要があります。
ドメインが存在しない場合、または認証済みクライアントに属していない場合は、404 が返されます。
ウェブサイトの削除は非同期で処理され、完了まで数分かかることがあります。削除が完了する前にレスポンスが返されます。
- メソッド:
DELETE - パス:
/api/hosting/v1/websites/{domain}
hostinger-mail-mcp
mail_aliases_create-alias
指定したメールボックスのエイリアスを作成します。エイリアスアドレスは、指定したローカル部とメールボックスのドメインから構成されます。エイリアス宛てのメッセージは、メールボックスに配信されます。
- メソッド:
POST - パス:
/api/mail/v1/mailboxes/{mailboxId}/aliases
mail_aliases_delete-alias
エイリアスを削除します。エイリアスアドレス宛てのメッセージは、メールボックスに配信されなくなります。
- メソッド:
DELETE - パス:
/api/mail/v1/aliases/{aliasId}
mail_aliases_list
メールオーダーのすべてのメールボックスにわたる、エイリアスのページ分割された一覧を取得します。
- メソッド:
GET - パス:
/api/mail/v1/orders/{orderId}/aliases
mail_api-tokens_create
指定したメールオーダーの API トークンを作成します。このトークンを使用すると、Hostinger Email API にアクセスして、トークンの対象範囲に含まれるメールボックスをプロビジョニングおよび管理できます。
トークンの平文はこのレスポンスでのみ返され、再度返されることはありません。1 つのオーダーにつき、最大 10 個のトークンを作成できます。現在および将来のすべてのメールボックスを対象にするには scope.has_all_mailboxes を使用するか、scope.mailbox_ids に特定のメールボックスを列挙してください。
- メソッド:
POST - パス:
/api/mail/v1/orders/{orderId}/api-tokens
mail_api-tokens_revoke
API トークンを取り消します。トークンはただちに Hostinger Email API へのアクセス権を失います。この操作は取り消せません。
- メソッド:
DELETE - パス:
/api/mail/v1/api-tokens/{tokenId}
mail_api-tokens_list
すべてのメールオーダーにわたる Hostinger Email API トークンのページ分割された一覧を取得します。必要に応じて、オーダーで絞り込むこともできます。トークンの平文は含まれません。トークン作成時にのみ返されます。
- メソッド:
GET - パス:
/api/mail/v1/api-tokens
mail_autoreplies_create
指定したメールボックスの自動返信を作成します。1 つのメールボックスに設定できる自動返信は 1 つだけです。自動返信をただちに有効にするには starts_at を省略し、無期限に有効にするには ends_at を省略してください。
- メソッド:
POST - パス:
/api/mail/v1/mailboxes/{mailboxId}/autoreplies
mail_autoreplies_update
自動返信を、指定した内容とスケジュールで置き換えます。省略したオプションフィールドはクリアされます。自動返信をただちに有効にするには starts_at を省略し、無期限に有効にするには ends_at を省略してください。
- メソッド:
PUT - パス:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_delete
メールボックスの自動返信を削除します。メールボックスはただちに自動返信を送信しなくなります。
- メソッド:
DELETE - パス:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_list
メールオーダーのすべてのメールボックスにわたる、自動返信のページ分割された一覧を取得します。
- メソッド:
GET - パス:
/api/mail/v1/orders/{orderId}/autoreplies
mail_catchalls_create-catch-all
ドメイン内の不明なアドレス宛てのすべてのメッセージを、指定したメールボックスに転送するキャッチオールを作成します。メールボックスのアドレスに確認メールが届き、確認後にのみキャッチオールが有効になります。1つのドメインに設定できるキャッチオールは1つだけです。
- Method:
POST - Path:
/api/mail/v1/mailboxes/{mailboxId}/catchalls
mail_catchalls_delete-catch-all
キャッチオールを削除します。ドメイン内の不明なアドレス宛てのメッセージは、メールボックスに転送されなくなります。
- Method:
DELETE - Path:
/api/mail/v1/catchalls/{catchallId}
mail_catchalls_list-catch-alls
メールオーダーに含まれるすべてのメールボックスのキャッチオールを、ページ分割された一覧として取得します。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/catchalls
mail_catchalls_resend-catch-all-confirmation
未確認のキャッチオールのメールボックスアドレスに、確認メールを再送します。
- Method:
POST - Path:
/api/mail/v1/catchalls/{catchallId}/confirmation/resend
mail_forwarders_create
指定したメールボックスから宛先アドレスへの転送設定を作成します。宛先に確認メールが届き、確認後にのみ転送が有効になります。
- Method:
POST - Path:
/api/mail/v1/mailboxes/{mailboxId}/forwarders
mail_forwarders_delete
転送設定を削除します。メールボックスから宛先アドレスへのメッセージ転送は、直ちに停止します。
- Method:
DELETE - Path:
/api/mail/v1/forwarders/{forwarderId}
mail_forwarders_list
メールオーダーに含まれるすべてのメールボックスの転送設定を、ページ分割された一覧として取得します。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/forwarders
mail_forwarders_resend-confirmation
未確認の転送設定の宛先アドレスに、確認メールを再送します。
- Method:
POST - Path:
/api/mail/v1/forwarders/{forwarderId}/confirmation/resend
mail_forwarders_update-keep-copy-setting
転送されたメッセージのコピーをメールボックスに保存する設定を、有効または無効にします。
- Method:
PATCH - Path:
/api/mail/v1/forwarders/{forwarderId}/keep-copy
mail_logs_list-access
指定したメールオーダーに紐づくドメインのアクセスログを、ページ分割された一覧として取得します。アカウント、日付範囲、プロトコル、ステータス、削除フラグによる絞り込みに対応しています。結果はタイムスタンプの降順で並べ替えられます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/logs/access
mail_logs_list-action
指定したメールオーダーのアカウント操作ログ(管理操作およびユーザー操作)を、ページ分割された一覧として取得します。アカウント、日付範囲、ステータスによる絞り込みに対応しています。結果はタイムスタンプの降順で並べ替えられます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/logs/action
mail_logs_list-inbound
指定したメールオーダーに紐づくドメインの受信メール配信ログを、ページ分割された一覧として取得します。アカウント、日付範囲、ステータス、送信者、受信者による絞り込みに対応しています。結果はタイムスタンプの降順で並べ替えられます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/logs/inbound
mail_logs_list-mailbox-action
指定したメールオーダー内のメールボックスの操作ログ(メッセージおよびメールボックスのイベント)を、ページ分割された一覧として取得します。メールボックスのメールアドレスは、オーダーのドメインに属している必要があります。日付範囲およびイベントタイプによる絞り込みに対応しています。結果はタイムスタンプの降順で並べ替えられます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/logs/mailbox-actions
mail_logs_list-outbound
指定したメールオーダーに紐づくドメインの送信メール配信ログを、ページ分割された一覧として取得します。アカウント、日付範囲、ステータス、送信者、受信者による絞り込みに対応しています。結果はタイムスタンプの降順で並べ替えられます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/logs/outbound
mail_mailboxes_list
メールオーダーに属するメールボックスのページネーション付き一覧を取得します。
このエンドポイントを使用すると、メールサービスのメールボックスのステータス、有効なプロトコル、関連付けられたリソース数、定期的に同期される使用量を確認できます(使用量はリアルタイムの値より遅れる場合があります)。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_create-mailbox
指定したメールオーダーにメールボックスを作成します。完全なメールアドレスは、指定したローカル部とオーダーのドメインを組み合わせて構成されます。
- Method:
POST - Path:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_delete-mailbox
メールボックスを削除します。メールボックスは論理削除され、完全に削除されるまでの限られた期間、復元できます。
- Method:
DELETE - Path:
/api/mail/v1/mailboxes/{mailboxId}
mail_mailboxes_change-mailbox-password
メールボックスのパスワードを変更します。
- Method:
PATCH - Path:
/api/mail/v1/mailboxes/{mailboxId}/password
mail_orders_list
アカウントに関連付けられたメールオーダーのページネーション付き一覧を取得します。
このエンドポイントを使用すると、メールサービスのステータス、プラン、関連付けられたドメイン、有効期限の詳細を確認できます。
- Method:
GET - Path:
/api/mail/v1/orders
mail_orders_plan
指定したメールオーダーの購入時のプランを取得します。ドメイン単位およびメールボックス単位のクォータ、上限、利用可能なプロトコルが含まれます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/plan
mail_webhooks_create
指定したメールボックスに Webhook を作成します。生成されたシークレットはこのレスポンスでのみ返され、各配信時にベアラートークンとして送信されます。
- Method:
POST - Path:
/api/mail/v1/mailboxes/{mailboxId}/webhooks
mail_webhooks_list-delivery-logs
指定したメールオーダーの Webhook 配信ログのページネーション付き一覧を取得します。配信結果、所要時間、再試行回数が含まれます。メールボックスによる絞り込みに対応しています。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/webhooks/delivery-logs
mail_webhooks_get
単一の Webhook の詳細を取得します。Webhook シークレットは含まれません。Webhook の作成時またはシークレットの再生成時にのみ返されます。
- Method:
GET - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_delete
Webhook を完全に削除します。この操作は取り消せません。削除後は、その URL にイベント通知が届かなくなります。
- Method:
DELETE - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_update
Webhook を部分的に更新します。リクエスト本文に含まれるフィールドのみが変更され、省略されたフィールドは現在の値を保持します。説明をクリアするには、"description": null を指定します。
- Method:
PATCH - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_list
指定したメールオーダーに属する Webhook のページネーション付き一覧を取得します。メールボックスおよびステータスによる絞り込みに対応しています。Webhook シークレットは含まれません。Webhook の作成時またはシークレットの再生成時にのみ返されます。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/webhooks
mail_webhooks_regenerate-secret
Webhook のシークレットを再生成します。以前のシークレットは直ちに無効になります。新しいシークレットはこのレスポンスでのみ返され、各配信時にベアラートークンとして送信されます。
- Method:
POST - Path:
/api/mail/v1/webhooks/{webhookId}/regenerate-secret
mail_webhooks_test
Webhook の URL にテスト配信を送信し、結果を返します。テストリクエストには、上流でレート制限が適用されます。
- Method:
POST - Path:
/api/mail/v1/webhooks/{webhookId}/test
hostinger-reach-mcp
reach_automations_get
単一のオートメーションを取得します。オートメーションに登録された連絡先数、処理中の連絡先数、完了した連絡先数、途中で失敗した連絡先数も含まれます。
これはオートメーション自体について説明するものです。実行されるワークフローを確認するには、ステップエンドポイントを使用してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}
reach_automations_list
プロファイル内のオートメーションをページ分割して取得します。
各オートメーションには、登録された連絡先数、処理中の連絡先数、完了した連絡先数、途中で失敗した連絡先数が含まれます。これらの数値は連絡先の進行状況を示すものであり、メールのエンゲージメント指標ではありません。開封数、クリック数、配信停止数を確認するには、キャンペーン統計エンドポイントを使用してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations
reach_automations_list-steps
オートメーションのワークフローを、ステップのフラットなリストとして取得します。
ステップは直線ではなくツリーを構成しています。分岐を再構築するには parent_uuid をたどり、同じ親を持つステップの順序を決めるには step_order を使用してください。ステップがまだないオートメーションは、空のリストを返します。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps
reach_campaigns_get
単一のキャンペーンを取得します。送信者、件名、テンプレート参照、ターゲティング、配信状況が含まれます。
キャンペーンの設定内容と現在の進捗状況を確認できます。開封数、クリック数、配信停止数を確認するには、キャンペーン統計エンドポイントを使用してください。メールの内容は含まれません。HTMLを読むには、template_uuid をメールテンプレート取得エンドポイントに渡してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}
reach_campaigns_list
プロファイル内のキャンペーンをページ分割して取得します。
各キャンペーンには、主要なエンゲージメント率が含まれます。ステータスで絞り込むと、下書き、配信予約済み、配信中、配信済みのキャンペーンを見つけられます。配信が完了したキャンペーンのステータスは publish である点にご注意ください。デフォルトでは通常のキャンペーンのみが返されます。オートメーションから送信されたメールやダブルオプトイン確認メールを取得するには、type を渡してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_create-draft
プロファイルにキャンペーンを作成します。
キャンペーンは下書きとして作成されるため、送信されることも、連絡先に影響することもありません。オーディエンスもまだ設定されていません。ターゲティングとスケジュール設定はこのリクエストの対象外です。下書きの仕上げと送信は、Reach のインターフェースから行います。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_performance
キャンペーンの配信数、開封数、クリック数、配信停止数と、それぞれに対応する率を取得します。
各件数はイベントの生の数ではなく、重複を除いた連絡先数です。そのため、同じメールを5回開封した連絡先も1件として数えられます。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics
reach_contacts_delete
指定した UUID の連絡先を削除します。
このエンドポイントは、メールマーケティングシステムから連絡先を完全に削除します。
非推奨です。 このエンドポイントではプロファイルを指定できないため、常にクライアントのデフォルトプロファイルが対象となり、ほかのプロファイルの連絡先は削除できません。代わりに DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} を使用してください。
- Method:
DELETE - Path:
/api/reach/v1/contacts/{uuid}
reach_contact-fields_delete
カスタム連絡先フィールドを削除します。
連絡先が保持しているそのフィールドの値もすべて削除されます。また、選択肢型の場合は、その選択肢も削除されます。連絡先自体には影響しません。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_update
カスタムコンタクトフィールドの名前を変更し、選択肢のあるタイプでは選択肢セットを置き換えます。
UUID が付与された選択肢は保持され、ラベルが変更されます。UUID のない選択肢は新規作成され、リストから除外された既存の選択肢は、コンタクトが保持するその選択肢の値とともに削除されます。フィールドタイプとスラッグは変更できません。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_list
プロファイルに定義されているカスタムコンタクトフィールドを取得します。
カスタムフィールドを使うと、コンタクトに独自の属性を保存できます。返される UUID は、コンタクトの値を設定する際にコンタクト更新エンドポイントへ渡すものです。また、選択肢フィールドには選択可能な項目も一覧表示されます。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contact-fields_create
プロファイルに新しいカスタムコンタクトフィールドを定義します。
slug はラベルから生成され、フィールドタイプと同様に、後から変更することはできません。返された UUID を使ってコンタクトに値を設定します。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contacts_list-groups
すべてのコンタクトグループの一覧を取得します。
このエンドポイントは、コンタクトの整理に使用できるコンタクトグループの一覧を返します。
- Method:
GET - Path:
/api/reach/v1/contacts/groups
reach_contacts_list
コンタクトの一覧を取得します。グループと購読ステータスで絞り込むこともできます。
このエンドポイントは、基本情報を含むページ分割されたコンタクト一覧を返します。 グループ UUID と購読ステータスでコンタクトを絞り込めます。
非推奨です。 このエンドポイントではプロファイルを指定できないため、常にクライアントのデフォルトプロファイルにフォールバックし、他のプロファイルのコンタクトを一覧表示できません。代わりに GET /api/reach/v1/profiles/{profileUuid}/contacts を使用してください。このエンドポイントではグループによる絞り込みがタグによる絞り込みに置き換わっています。
- Method:
GET - Path:
/api/reach/v1/contacts
reach_contacts_create
メールマーケティングシステムに新しいコンタクトを作成します。
このエンドポイントを使うと、名前、メールアドレス、姓などの基本情報を含む新しいコンタクトを作成できます。
ダブルオプトインが有効な場合、 コンタクトは保留中のステータスで作成され、確認メールが送信されます。
- Method:
POST - Path:
/api/reach/v1/contacts
reach_contacts_get
1 件のコンタクトの詳細情報をすべて取得します。
コンタクト自身の属性に加えて、割り当てられたタグと、プロファイルのカスタムコンタクトフィールドに保持されている値も返します。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_delete-profile
プロファイルからコンタクトを完全に削除します。
コンタクトは、カスタムフィールドの値およびタグの割り当てとともに削除されます。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_update
コンタクトの属性とカスタムフィールドの値を更新します。
リクエストボディに含まれるプロパティのみが変更されるため、単一の属性を変更する場合は部分的なボディで十分です。プロパティに null を送信すると、その値がクリアされます。
レスポンスにはコンタクトの基本属性が含まれます。タグ、カスタムフィールドの値、ソース、メモを取得するには、GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} を呼び出してください。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_create-in-bulk
1 回の呼び出しで、プロファイルに複数のコンタクトを作成します。
コンタクトはバックグラウンドでインポートされるため、成功レスポンスはインポートの完了ではなく、受け付けられたことを意味します。メールアドレスがプロファイル内にすでに存在するコンタクトは現在の値が保持され、カスタムフィールドを含め、まだ空の値のみが入力されます。ダブルオプトインが有効な場合、新しいコンタクトは保留中の状態で作成され、確認メールが送信されます。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/bulk
reach_contacts_list-profile
プロファイルに属する連絡先のページ分割された一覧を取得します。
連絡先は、購読ステータス、タグ、メールアドレスの検索語句で絞り込めます。
レスポンスの meta.total フィールドには、フィルターに一致する連絡先の数が格納されるため、
フィルターを指定せずにこのエンドポイントを呼び出すと、プロファイル内の連絡先の総数を取得できます。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_contacts_create-bulk
メールマーケティングシステムに新しい連絡先を作成します。
このエンドポイントでは、名前、メールアドレス、姓などの基本情報を指定して、新しい連絡先を作成できます。
ダブルオプトインが有効な場合、連絡先は保留中のステータスで作成され、 確認メールが送信されます。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_segments_list
すべての連絡先セグメントの一覧を取得します。
このエンドポイントは、連絡先の整理に使用できるセグメントの一覧を返します。
非推奨です。 このエンドポイントではプロファイルを指定できないため、常に
クライアントのデフォルトプロファイルにフォールバックし、他のプロファイルのセグメントを一覧表示できません。代わりに
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments を使用してください。
- Method:
GET - Path:
/api/reach/v1/segmentation/segments
reach_segments_create
新しい連絡先セグメントを作成します。
このエンドポイントでは、連絡先の整理に使用できる新しいセグメントを作成できます。 セグメントには、メールアドレス、名前、購読ステータスなどの条件を設定できます。
非推奨です。 このエンドポイントではプロファイルを指定できないため、常に
クライアントのデフォルトプロファイルにフォールバックし、他のプロファイルにセグメントを作成できません。代わりに
POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments を使用してください。
- Method:
POST - Path:
/api/reach/v1/segmentation/segments
reach_segments_count-profile-contacts
セグメントに現在一致する連絡先の件数を、一覧を取得せずに数えます。
件数だけが必要な場合は、セグメントの連絡先エンドポイントをページ分割して取得するよりも効率的です。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count
reach_segments_list-profile-contacts
指定したプロファイルの特定のセグメントに関連付けられた連絡先を取得します。
このエンドポイントでは、特定のプロファイルに限定し、UUIDで識別される 特定のセグメントに属する連絡先を取得して絞り込めます。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts
reach_segments_profile
プロファイルの単一のセグメントと、そのセグメントを定義する条件を取得します。
現在それらの条件に一致する連絡先を取得するには、セグメントの連絡先 エンドポイントを使用してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_update-profile
セグメントの名前を変更したり、セグメントを定義する条件を置き換えたりします。
name は常に必須です。条件に変更を加えずに名前だけを変更する場合は、conditions を省略します;
指定した場合は既存の条件と統合されず、すべて置き換えられます。
連絡先自体は変更されませんが、セグメントに一致する連絡先はすぐに変わる場合があります。
- Method:
PUT - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_delete-profile
セグメントを削除します。
削除されるのはセグメントの定義のみです。そのセグメントに一致していた連絡先は変更されません。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_list-filter-attributes
セグメント条件でフィルタリングできるすべての属性と、各属性が受け付ける演算子、必要な値の形式、値に制約がある場合は許可される値を一覧表示します。
この一覧はプロフィールごとに異なります。プロフィールのカスタム連絡先フィールド、タグ、直近で公開された20件のキャンペーンが含まれるため、有効な属性をハードコードすることはできません。セグメントを作成または更新する前に読み込み、有効な attribute、operator、value の組み合わせを確認してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes
reach_segments_preview-contacts-matching-conditions
セグメントを保存せずに、条件セットに一致する連絡先をプレビューします。
リクエストボディには、セグメントの作成または更新時に受け付けるものと同じ条件セットを指定します。これにより、フィルターを保存する前に、対象となる連絡先とその件数を確認できます。データは保存されず、連絡先も変更されません。
最初にセグメントフィルター属性のエンドポイントを呼び出し、有効な attribute、operator、value の組み合わせを確認してください。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts
reach_segments_list-profile
プロフィールで定義されたセグメントのページ分割された一覧を取得します。
各エントリーには、現在一致する連絡先の件数が含まれます。この件数は保存されるのではなく、読み取り時に再計算されます。count_type を使って、一致する連絡先すべてを数えるか、購読中の連絡先のみを数えるかを指定してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_create-profile
プロフィールにセグメントを作成します。
セグメントは固定された連絡先リストではなく、保存された条件セットです。そのため、連絡先の変化に応じて所属メンバーも変わります。セグメントを作成しても、連絡先は変更されません。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_list-contacts
特定のセグメントに関連付けられた連絡先を取得します。
このエンドポイントでは、UUIDで指定された特定のセグメントに属する連絡先を取得し、フィルタリングできます。
非推奨です。 このエンドポイントではプロフィールを指定できないため、常にクライアントのデフォルトプロフィールにフォールバックし、他のプロフィールのセグメントを読み取ることはできません。代わりに GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts を使用してください。
- Method:
GET - Path:
/api/reach/v1/segmentation/segments/{segmentUuid}/contacts
reach_segments_get
特定のセグメントの詳細を取得します。
このエンドポイントは、UUIDで指定された単一のセグメントに関する情報を取得します。セグメントは、特定の条件に基づいて連絡先を整理、グループ化するために使用されます。
非推奨です。 このエンドポイントではプロフィールを指定できないため、常にクライアントのデフォルトプロフィールにフォールバックし、他のプロフィールのセグメントを読み取ることはできません。代わりに GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid} を使用してください。
- Method:
GET - Path:
/api/reach/v1/segmentation/segments/{segmentUuid}
reach_tags_assign-contact-to
単一の連絡先にタグを割り当てます。
一括エンドポイントとは異なり、この処理はキューに追加されず、すぐに適用されます。連絡先がすでに持っているタグを割り当てても、重複は作成されずに成功します。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_remove-contact-from
単一の連絡先からタグを削除します。
一括エンドポイントとは異なり、この処理はキューに追加されず、すぐに適用されます。タグも連絡先も削除されません。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_assign-contacts-to
複数のコンタクトに一度にタグを割り当てます。
特定のコンタクトを対象にするには contact_uuids を渡し、プロフィール内のすべてのコンタクトを対象にするには
all_contacts を渡します。処理はキューに登録されるため、成功レスポンスは処理が完了したことではなく、
受け付けられたことを意味します。すでにタグが付いているコンタクトには何も行いません。
- メソッド:
POST - パス:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_remove-contacts-from
複数のコンタクトから一度にタグを削除します。
特定のコンタクトを対象にするには contact_uuids を渡し、プロフィール内のすべてのコンタクトを対象にするには
all_contacts を渡します。処理はキューに登録されるため、成功レスポンスは処理が完了したことではなく、
受け付けられたことを意味します。タグ自体とコンタクトは削除されません。
- メソッド:
DELETE - パス:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_delete
タグを削除し、そのタグが付いているすべてのコンタクトからタグを削除します。
コンタクト自体は削除されません。この操作は冪等です。プロフィール内に存在しないタグを削除しても成功します。
- メソッド:
DELETE - パス:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_rename
タグの名前を変更します。
そのタグが割り当てられているコンタクトには影響しません。名前はプロフィール内で一意であるため、 すでに使用されている名前への変更は拒否されます。
- メソッド:
PATCH - パス:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_list-profile
プロフィールに定義されているすべてのタグを取得します。
Reach ではタグを使ってコンタクトをグループ化し、コンタクトリストのフィルタリングやセグメントの作成に利用できます。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/tags
reach_tags_create-or-find
プロフィールにタグを作成します。
プロフィール内にすでに存在する名前のタグは重複して作成されず、代わりに既存のタグが返されるため、 この呼び出しは安全に繰り返せます。リクエスト内のタグは、今回作成されたものも既存のものもすべて返されます。
- メソッド:
POST - パス:
/api/reach/v1/profiles/{profileUuid}/tags
reach_forms_get
単一のフォームを取得します。ホストされたテンプレートの URL と、そのフォームが収集したコンタクトに適用するタグも返されます。
レスポンスにすぐ使える埋め込み用スニペットは含まれません。テンプレート HTML を自分で配信するか、 フォームの UUID を使って独自の埋め込みを作成してください。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_delete
フォームとそのテンプレートを完全に削除します。
すでに送信データを収集したフォームは削除できません。収集したコンタクトが気付かれないまま破棄されないようにするためです。 新たな送信を停止するには、フォームを一時停止してください。閲覧数だけでは削除は妨げられません。
- メソッド:
DELETE - パス:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_update
フォームの名前やステータスを変更します。
draft または paused のフォームを active にすると公開され、最後に保存したデザインが公開されて、
訪問者が送信できるようになります。paused と draft はフォームへの送信を停止します。公開されるまでは、
訪問者はフォームにアクセスできません。フォームがすでに active の状態で保存されたデザインの変更は、
フォームを一時停止してから再び active にするまで公開されません。名前を変更しても、自動生成される
form:{name} タグの名前は変更されません。
- メソッド:
PATCH - パス:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_duplicate
同じ名前とデザインの新しい下書きフォームにコピーします。
コピーは元のフォームの自動生成 form:{name} タグを共有しますが、その他の送信者タグはコピーされません。
ステータスを active にするまではコピーは公開されません。
- メソッド:
POST - パス:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/duplicate
reach_forms_list
プロフィール内のサインアップフォームをページネーション付きで取得します。
各フォームには、レンダリングに使用するテンプレートへの参照が含まれています。フォームの詳細を取得すると、直接使用できるテンプレート URL と、フォームから登録された連絡先に付与されるタグを確認できます。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/forms
reach_forms_create
空のドラフトフォームを作成します。
Reach は、すべての送信者に付与される自動タグ form:{name} も追加します。ドラフトにはデザインがなく、訪問者はアクセスできません。フォームテンプレート更新操作でデザインを保存し、その後、ステータスを active に設定してフォームを公開してください。フォームの作成で AI クレジットは消費されません。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/forms
reach_forms_add-submitter-tags
フォームにタグを追加し、今後そのフォームを送信するすべての連絡先に付与します。
フォームにすでに設定されているタグはスキップされます。存在しないタグは拒否されます。以前に送信した連絡先にはタグは付与されません。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/tags
reach_forms_remove-submitter-tag
今後フォームを送信する連絡先へのタグ付与を停止します。
フォームにそのタグが設定されていなくても成功します。すでにタグが付与された連絡先からタグが削除されることはなく、タグ自体も削除されません。自動タグ form:{name} は削除できず、競合エラーが返されます。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/tags
reach_forms_update-template
content をフォームの最新デザインとして保存し、保存済みのバージョンを返します。
HTML はサニタイズされ、プランで削除が許可されていない限り、Reach の署名が追加されます。訪問者は、必須の email フィールドと、任意の name、surname、phone フィールドを使ってフォームを送信します。サニタイズ後のデザインには、フォームコンテナ(data-reach-form)、メール入力欄(data-reach-field="email")、送信ボタン(data-reach-submit)が含まれている必要があります。含まれていない場合、リクエストは 422 で失敗し、errors.content に missing_form_container、missing_email_field、および/または missing_submit_button が列挙されます。
draft または paused のフォームは、ステータスが active に設定されてデザインが公開されるまでアクセスできません。すでに active のフォームでは、保存したデザインはフォームを一度一時停止してから再び active に設定するまで公開されません。デザインの保存で AI クレジットは消費されません。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/template
reach_profiles_connected-sending-domain
プロフィールに接続されている送信ドメイン、その認証ステータス、および一時停止中の送信者アドレスを取得します。
ドメインが接続され、有効になって初めてキャンペーンを送信できるため、キャンペーンを作成する前にこの前提条件を確認する最も手軽な方法です。ドメインが接続されていないプロフィールでは、すべてのフィールドが null の同じ形式のデータが返されます。ステータスの根拠となる個別の MX、SPF、DKIM、DMARC レコードを確認するには、DNS ステータスエンドポイントを使用してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_connect-sending-domain
プロフィールに送信ドメインを接続し、そのドメインのアドレスからメールを送信できるようにします。
接続しただけでは、ドメインから送信できる状態にはなりません。次に DNS ステータスエンドポイントを確認し、不足しているレコードを確認してください。アカウントが所有するドメイン、またはすでに認証済みのドメインはすぐに接続されます。それ以外のドメインでは TXT による所有権認証が開始され、409 が返されます。Reach で認証を完了してから、もう一度リクエストしてください。プロフィールまたは別のプロフィールにすでにドメインが設定されている場合、ドメインがブロックされている場合、または所有権を認証できない場合は 422 が返されます。すでに接続されているドメインが置き換えられることはありません。
成功すると、ドラフトおよびスケジュール済みキャンペーンと、公開済みのオートメーションメールおよびダブルオプトインメールの送信者アドレスが、バックグラウンドで新しいドメインに切り替わります。@ より前の部分は維持されます。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_delete-sending-domain
プロファイルから送信ドメインの接続を解除します。
ドメインのレコードが削除されるため、その後プロファイルには送信ドメインがなくなり、ドメインを再接続するまでキャンペーンを送信できません。キャンペーン、オートメーション、設定にすでに保存されている送信者アドレスは変更されず、削除されたドメインを参照し続けます。プロファイルに接続されていないドメインを指定した場合も成功するため、成功しても何かが削除されたとは限りません。DNS プロバイダーの DNS レコードは削除されません。ドメインを切り替えるには、現在のドメインを削除して新しいドメインを接続します。呼び出す前に、顧客にドメインを確認してください。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_domain-dns-status
プロファイルのドメインに関する DNS 設定状況を取得します。
このエンドポイントは、MX、SPF、DKIM、DMARC レコードの状態と、実際に見つかったレコード、およびメールを正しく配信するために必要な推奨レコードを返します。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/domains/dns-status
reach_profiles_list-plan-feature-access
プロファイルが利用できるプラン機能を一覧表示します。
これは機能のロック状況を示すものであり、利用枠ではありません。available は現在その機能を利用できることを意味し、locked は基本プランに含まれていないため、アップグレードが必要であることを意味します。残りのメール数、受信者数、AI クレジットを確認するには、代わりに上限エンドポイントを使用してください。
オートメーションの有効化に対応していないプランでオートメーションを設定するなど、後から有効化できないものを作成する前に確認すると便利です。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/features
reach_profiles_remaining-plan-limits
現在の期間におけるプランの残り利用枠を取得します。
これを使ってアラートを設定する前に、2 点に注意してください。期間は請求日の応当日ではなく暦月単位なので、サブスクリプションの開始日にかかわらず、カウンターは毎月 1 日にリセットされます。また、利用状況は注文単位で追跡されるため、同じ注文のプロファイルはすべて 1 つの利用枠を共有し、ここでは同じ数値が返されます。現在の期間の情報のみ取得でき、過去の利用状況は保持されません。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/limits
reach_profiles_list
このエンドポイントは、クライアントが利用できるすべてのプロファイルと、その基本情報を返します。
- Method:
GET - Path:
/api/reach/v1/profiles
reach_profiles_settings
プロファイルに保存されている送信者情報とブランドの詳細を取得します。
顧客に尋ねる代わりに、キャンペーンを作成する前にデフォルトの送信者情報を読み取り、メールコンテンツを生成する際にはブランド情報を再利用してください。設定を一度も入力していないプロファイルでは、どのフィールドも null の場合があります。このエンドポイントでは送信ドメインが認証済みかどうかは確認されません。その確認には、接続済みの送信ドメインを取得するエンドポイントを使用してください。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/settings
reach_profiles_update-settings
プロファイルのデフォルトの送信者情報とブランドの詳細を変更します。
変更するフィールドだけを送信してください。省略したフィールドはすべて現在の値を維持し、null または空文字列を指定するとテキストフィールドがクリアされます。デフォルトの送信者情報は、その後作成されるキャンペーンの初期値になります。既存のキャンペーンの送信者情報は変更されません。sender_email に指定できるのは @ より前の部分だけです。Reach はこれをプロファイルに接続された送信ドメインと組み合わせるため、そのドメイン以外のアドレスは設定できません。送信ドメインの接続には別のエンドポイントを使用し、接続済みドメインをここで変更することはできません。変更後の設定を返します。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/settings
reach_integrations_disconnect-ecommerce-store
プロフィールからeコマースストアを切断します。
Reachはストアの顧客と注文を受信しなくなり、商品とクーポンはReachから削除されます。連絡先と過去の注文は残ります。store_idはeコマースストア一覧エンドポイントから取得してください。ストアのステータスがconnected_to_other_profileの場合は、そのプロフィールを指定してこのエンドポイントを呼び出してください。このプロフィールに接続されていないストアに対しても成功するため、成功したことだけでは切断が行われた証明にはなりません。呼び出す前に、ストアとプランを顧客に確認してください。
- メソッド:
DELETE - パス:
/api/reach/v1/profiles/{profileUuid}/ecommerce/stores/{storeId}
reach_integrations_list-ecommerce-stores
顧客のHostinger eコマースストアをすべて取得します。各ストアにはstore_idと、パスで指定したプロフィールに対するconnection_statusが含まれます。
ストアは最大1つのプロフィールにのみ接続できます。connected_to_other_profileではそのプロフィールが特定されないため、各プロフィールに対してこのエンドポイントを呼び出して確認してください。eコマースサービスに接続できない場合は、エラーではなく空のリストが返されます。store_idをeコマースストア切断エンドポイントに渡してください。AI Website Builderサイトを接続すると、そのサイトで販売しているストアが接続されます。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/ecommerce/stores
reach_templates_list-email
プロフィール内のメールテンプレート一覧を、最終更新日時の新しい順に取得します。
テンプレートは、キャンペーンの作成に使用する再利用可能なメール本文です。リストはページ分割されず、HTMLコンテンツは含まれず、メタデータのみが返されます。キャンペーンの作成時にテンプレートのuuidをtemplate_uuidとして使用してください。テンプレートのHTMLを読むには、必要な場合に限りメールテンプレート取得エンドポイントを使用してください。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_create-email
プロフィールにメールテンプレートを作成します。
テンプレートにはキャンペーンで再利用するHTML本文が含まれるため、キャンペーンがまだ存在しない場合でも作成できます。返されるのはテンプレートのメタデータのみです。返されたuuidは、キャンペーンのtemplate_uuidとして参照できるように保持してください。
- メソッド:
POST - パス:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_email
プロフィール内の1つのメールテンプレートを、template_contentに含まれる完全なHTMLとともに取得します。
キャンペーンのメールコンテンツはテンプレートです。キャンペーンで送信される内容を読むには、キャンペーンを取得して、そのtemplate_uuidをここに渡してください。HTMLは大きくなる場合があるため、コンテンツ自体が必要な場合に限って取得してください。テンプレートの閲覧や選択には使用しないでください。メールテンプレート一覧エンドポイントなら、コンテンツを取得せずに一覧を確認できます。{{name}}などのパーソナライズタグは、置換されずに返されます。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/templates/{templateUuid}
reach_integrations_list-connected-websites
プロフィールに接続されているウェブサイトを取得します。各サイトにはdomainとplatform_typeが含まれます。
ドメインは最大1つのプロフィールにのみ接続できるため、サイトがどのプランに属しているかを確認するには、各プロフィールに対してこのエンドポイントを呼び出してください。ここに表示されるのは接続済みのサイトのみであり、顧客が所有するすべてのウェブサイトではありません。また、eコマースストアは含まれません。eコマースストアについては、eコマースストア一覧エンドポイントを使用してください。domainをWordPressサイト切断エンドポイントまたはAI Website Builderサイト切断エンドポイントに渡してください。
- メソッド:
GET - パス:
/api/reach/v1/profiles/{profileUuid}/websites
reach_integrations_connect-ai-website-builder-site
お客様が手動で作成した AI Website Builder サイトをプロフィールに接続し、サイトの登録者が Reach に送信されるようにします。
お客様がそのドメインの AI Website Builder サイトを所有していない場合は、見つからないというエラーになります。
ドメインがいずれかのプロフィールに接続されている場合は、DOMAIN_ALREADY_EXISTS エラーになります。サイトを別のプランに移動するには、
まず古いプロフィールから接続を解除してください。このプロフィールに AI Website Builder サイトがすでにある場合は、
WEBSITE_CONNECTION_ALREADY_EXISTS エラーになります。
サイトで販売している eCommerce ストアがどこにも接続されていない場合は、そちらも接続されます。
WordPress サイトと、エージェント型 AI Website Builder で作成したサイトは、ここから接続できません。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/websites/website-builder
reach_integrations_disconnect-ai-website-builder-site
プロフィールから AI Website Builder サイトの接続を解除します。サイトから Reach への登録者の送信が停止します。
接続済みウェブサイト一覧のエンドポイントから domain を取得してください。ビルダーで
すでに削除されたサイトにも使用できます。このプロフィールにドメインが接続されていない場合は、
見つからないというエラーになります。連絡先と接続済みの eCommerce ストアはそのまま残ります。サイトは
再接続されるまで接続が解除されたままになるため、呼び出す前にお客様にサイトとプランを確認してください。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/websites/website-builder
reach_integrations_disconnect-wordpress-site
プロフィールから WordPress サイトの接続を解除します。
サイト上の Reach プラグインによる登録者とストアデータの送信が停止し、サイトの
商品とクーポンは Reach から削除されます。連絡先と過去の注文はそのまま残ります。接続済みウェブサイト一覧のエンドポイントから domain を
取得してください。このプロフィールにドメインが接続されていない場合は、見つからないというエラーになります。この操作は API から元に戻せません。お客様は
WordPress プラグインから再接続する必要があるため、呼び出す前にお客様にサイトとプランを確認してください。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/websites/wordpress
hostinger-vps-mcp
vps_data-centers_list
利用可能なすべてのデータセンターを取得します。
VPS インスタンスをデプロイする前に、ロケーションの選択肢を確認するために使用します。
- Method:
GET - Path:
/api/vps/v1/data-centers
vps_docker_containers
仮想マシン上の特定の Docker Compose プロジェクトに属するすべてのコンテナの一覧を取得します。
このエンドポイントは、現在のステータス、ポートマッピング、実行時設定など、 各コンテナの詳細情報を返します。
Docker Compose プロジェクト内のすべてのサービスの健全性と状態を監視するために使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers
vps_docker_get
docker-compose.yml ファイルの内容、プロジェクトのメタデータ、現在のデプロイステータスなど、プロジェクトの完全な情報を取得します。
このエンドポイントは、特定の Docker Compose プロジェクトの完全な設定と状態の詳細を提供します。
プロジェクト設定の確認、compose ファイルのレビュー、またはプロジェクト全体の健全性の確認に使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}
vps_docker_delete
仮想マシンから Docker Compose プロジェクトを完全に削除し、すべてのコンテナを停止して、 ネットワーク、ボリューム、イメージなどの関連リソースをクリーンアップします。
この操作は取り消せず、プロジェクトのデータはすべて削除されます。
プロジェクトを完全に削除してシステムリソースを解放する場合に使用します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down
vps_docker_list
仮想マシンに現在デプロイされているすべての Docker Compose プロジェクトの一覧を取得します。
このエンドポイントは、各プロジェクトの名前、ステータス、ファイルパス、およびコンテナの一覧(名前、イメージ、ステータス、ヘルス、ポートの詳細を含む)などの基本情報を返します。このエンドポイントではコンテナの統計情報は省略されます。統計情報を含むコンテナの詳細情報が必要な場合は、Get project containers エンドポイントを使用してください。
VPS インスタンス上のすべての Docker プロジェクトの概要を把握するには、こちらを使用してください。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_create
docker-compose.yaml の内容から新しいプロジェクトをデプロイするか、URL から内容をダウンロードします。
URL には、https://github.com/[user]/[repo] 形式の GitHub リポジトリ URL を指定でき、その場合は master ブランチ内の docker-compose.yaml ファイルが自動的に解決されます。それ以外の URL を指定する場合は、docker-compose.yaml ファイルの内容を返す必要があります。
同じ名前のプロジェクトがすでに存在する場合、既存のプロジェクトは置き換えられます。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_logs
Docker Compose プロジェクト内のすべてのサービスから、集約されたログエントリを取得します。
このエンドポイントは、各コンテナの最近のログ出力を、サービス名とタイムスタンプごとに整理して返します。レスポンスには、すべてのサービスにわたる直近 300 件のログエントリが含まれます。
プロジェクトスタック全体のデバッグ、アプリケーションの動作監視、問題のトラブルシューティングに使用してください。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs
vps_docker_restart
コンテナを正しい依存関係の順序で停止して起動することで、Docker Compose プロジェクト内のすべてのサービスを再起動します。
この操作では、データボリュームとネットワーク構成を維持したまま、実行中のコンテナを更新します。
構成の変更を適用したり、サービスの障害から復旧したりする場合に使用してください。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart
vps_docker_start
現在停止している Docker Compose プロジェクト内のすべてのサービスを起動します。
この操作では、compose ファイルで定義された正しい依存関係の順序でコンテナを起動します。
以前停止したプロジェクトを再開する場合や、システムの再起動後にサービスを起動する場合に使用してください。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start
vps_docker_stop
コンテナの構成とデータボリュームを維持したまま、Docker Compose プロジェクト内の実行中のサービスをすべて停止します。
この操作では、コンテナを依存関係とは逆の順序で正常にシャットダウンします。
データや構成を削除せずにプロジェクトを一時停止する場合に使用してください。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop
vps_docker_update
最新のイメージバージョンを取得し、新しい構成でコンテナを再作成することで、Docker Compose プロジェクトを更新します。
この操作では、compose ファイルの変更を適用しながら、データボリュームを維持します。
アプリケーションの更新をデプロイする場合、構成の変更を適用する場合、またはコンテナイメージを最新バージョンに更新する場合に使用してください。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update
vps_firewall_activate
指定した仮想マシンのファイアウォールを有効にします。
仮想マシンで同時に有効にできるファイアウォールは 1 つだけです。
VPS インスタンスにファイアウォールルールを適用するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}
vps_firewall_deactivate
指定した仮想マシンのファイアウォールを無効にします。
VPS インスタンスのファイアウォール保護を解除するには、このエンドポイントを使用してください。
- Method:
POST - Path:
/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}
vps_firewall_get
IDでファイアウォールと関連するルールを取得します。
このエンドポイントを使用して、特定のファイアウォール設定とルールを確認します。
- Method:
GET - Path:
/api/vps/v1/firewall/{firewallId}
vps_firewall_delete
指定したファイアウォールを削除します。
このファイアウォールが有効になっている仮想マシンでは、自動的にファイアウォールが無効になります。
このエンドポイントを使用して、使用されていないファイアウォール設定を削除します。
- Method:
DELETE - Path:
/api/vps/v1/firewall/{firewallId}
vps_firewall_list
利用可能なすべてのファイアウォールを取得します。
このエンドポイントを使用して、既存のファイアウォール設定を確認します。
- Method:
GET - Path:
/api/vps/v1/firewall
vps_firewall_create
新しいファイアウォールを作成します。
このエンドポイントを使用して、VPS のセキュリティを強化するための新しいファイアウォール設定を行います。
- Method:
POST - Path:
/api/vps/v1/firewall
vps_firewall_update-rule
指定したファイアウォールの特定のファイアウォールルールを更新します。
このファイアウォールが有効になっている仮想マシンは、ファイアウォールとの同期が解除されるため、手動で再同期する必要があります。
このエンドポイントを使用して、既存のファイアウォールルールを変更します。
- Method:
PUT - Path:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_delete-rule
指定したファイアウォールから特定のファイアウォールルールを削除します。
このファイアウォールが有効になっている仮想マシンは、ファイアウォールとの同期が解除されるため、手動で再同期する必要があります。
このエンドポイントを使用して、特定のファイアウォールルールを削除します。
- Method:
DELETE - Path:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_replace-all-rules-in-group
指定したファイアウォールグループ内のすべてのファイアウォールルールを、ルールを1つずつ作成または削除するのではなく、指定したルールセットで単一のアトミック操作として置き換えます。
このファイアウォールグループを使用する仮想マシンは、ルールの置き換え後に同期する必要があります。すぐに同期を実行するには、「sync」パラメーターを渡してください。
- Method:
PUT - Path:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_create-rule
指定したファイアウォールに新しいファイアウォールルールを作成します。
デフォルトでは、ファイアウォールはすべての受信トラフィックをドロップするため、使用するすべてのポートに対して許可ルールを追加する必要があります。
このファイアウォールが有効になっている仮想マシンは、ファイアウォールとの同期が解除されるため、手動で再同期する必要があります。
このエンドポイントを使用して、ファイアウォールに新しいセキュリティルールを追加します。
- Method:
POST - Path:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_sync-to-all-assigned-v-ms
ファイアウォールのルールを、割り当てられているすべての仮想マシンに同期します。
新しいルールが追加、削除、または更新されると、ファイアウォールと仮想マシンの同期が解除されることがあります。
このエンドポイントを使用して、更新されたファイアウォールルールを、そのファイアウォールが割り当てられているすべての VPS インスタンスに適用します。
- Method:
POST - Path:
/api/vps/v1/firewall/{firewallId}/sync
vps_firewall_sync
非推奨:代わりに POST /api/vps/v1/firewall/{firewallId}/sync を使用してください。このエンドポイントは、ファイアウォールが割り当てられているすべての仮想マシンにファイアウォールを同期します。
指定した仮想マシンのファイアウォールを同期します。
新しいルールが追加、削除、または更新されると、ファイアウォールと仮想マシンの同期が解除されることがあります。
このエンドポイントを使用して、更新されたファイアウォールルールを VPS インスタンスに適用します。
- Method:
POST - Path:
/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}
vps_post-install-scripts_get
IDでポストインストールスクリプトを取得します。
このエンドポイントを使用して、特定の自動化スクリプトの詳細を確認します。
- Method:
GET - Path:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_update
特定のポストインストールスクリプトを更新します。
このエンドポイントを使用して、既存の自動化スクリプトを変更します。
- Method:
PUT - Path:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_delete
アカウントからポストインストールスクリプトを削除します。
このエンドポイントを使用して、使用していない自動化スクリプトを削除します。
- Method:
DELETE - Path:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_list
アカウントに関連付けられたポストインストールスクリプトを取得します。
このエンドポイントを使用して、VPS のデプロイに利用できる自動化スクリプトを確認します。
- Method:
GET - Path:
/api/vps/v1/post-install-scripts
vps_post-install-scripts_create
アカウントに新しいポストインストールスクリプトを追加します。このスクリプトは、仮想マシンのインストール後に使用できます。
スクリプトの内容は、実行可能属性を設定した状態でファイル /post_install に保存され、
仮想マシンのインストール後に一度実行されます。
スクリプトの出力は /post_install.log にリダイレクトされます。スクリプトの最大サイズは 48KB です。
このエンドポイントを使用して、VPS のセットアップタスク用の自動化スクリプトを作成します。
- Method:
POST - Path:
/api/vps/v1/post-install-scripts
vps_public-keys_attach
非推奨:代わりに POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys を使用してください。
アカウント内の既存の公開鍵を、指定した仮想マシンに追加します。
1 台の仮想マシンに複数の鍵を追加できます。
このエンドポイントを使用して、VPS インスタンスの SSH 鍵認証を有効にします。
- Method:
POST - Path:
/api/vps/v1/public-keys/attach/{virtualMachineId}
vps_public-keys_delete
非推奨:アカウントレベルの公開鍵に直接置き換えられる機能はありません。ルート SSH 鍵は、仮想マシンごとに
DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys を使用して管理するようになりました。
アカウントから公開鍵を削除します。
アカウントから公開鍵を削除しても、仮想マシンからは削除されません
このエンドポイントを使用して、使用していない SSH 鍵をアカウントから削除します。
- Method:
DELETE - Path:
/api/vps/v1/public-keys/{publicKeyId}
vps_public-keys_list
非推奨:アカウントレベルの公開鍵に直接置き換えられる機能はありません。ルート SSH 鍵は、仮想マシンごとに
GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys を使用して管理するようになりました。
アカウントに関連付けられた公開鍵を取得します。
このエンドポイントを使用して、VPS 認証に利用できる SSH 鍵を確認します。
- Method:
GET - Path:
/api/vps/v1/public-keys
vps_public-keys_create
非推奨:アカウントレベルの公開鍵に直接置き換えられる機能はありません。ルート SSH 鍵は、仮想マシンごとに
POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys を使用して管理するようになりました。
アカウントに新しい公開鍵を追加します。
このエンドポイントを使用して、VPS 認証用の SSH 鍵を登録します。
- Method:
POST - Path:
/api/vps/v1/public-keys
vps_ssh-keys_list-virtual-machine
指定した仮想マシンに現在設定されている SSH 公開鍵を取得します。
root ユーザーの鍵のみが一覧表示されます。
このエンドポイントを使用して、VPS インスタンスの認証に利用できる SSH 鍵を確認します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_add-virtual-machine
指定した仮想マシンに 1 つ以上の SSH 公開鍵を追加します。
鍵は root ユーザーに追加され、パスワードなしの SSH 認証に使用できます。
仮想マシンに現在設定されている SSH 鍵の完全な一覧を返します。
このエンドポイントを使用して、VPS インスタンスの SSH 鍵認証を有効にします。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_remove-virtual-machine
指定した仮想マシンから 1 つ以上の SSH 公開鍵を削除します。
削除された鍵は、root ユーザーとして SSH 認証に使用できなくなります。
仮想マシンに設定されている残りの SSH 鍵の一覧を返します。
このエンドポイントを使用して、VPS インスタンスへの SSH 鍵アクセスを取り消します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_templates_get
仮想マシン用の特定の OS テンプレートの詳細情報を取得します。
デプロイ前に特定のテンプレート仕様を確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/templates/{templateId}
vps_templates_list
仮想マシンで利用可能な OS テンプレートを取得します。
VPS インスタンスの作成または再作成前に、オペレーティングシステムの選択肢を確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/templates
vps_actions_get
指定した仮想マシンで実行された特定のアクションの詳細情報を取得します。
特定の VPS 操作のステータスと詳細を監視するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}
vps_actions_list
指定した仮想マシンで実行されたアクションを取得します。
アクションとは、仮想マシンに対して実行された操作やイベントのことで、マシンの起動、停止、変更などが含まれます。このエンドポイントを使うと、アクション名、タイムスタンプ、ステータスなど、各アクションの詳細を含む履歴を確認できます。
VPS 操作の履歴を確認し、問題をトラブルシューティングするには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions
vps_virtual-machines_attached-public-keys
非推奨です。代わりに GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys を使用してください。
指定した仮想マシンに紐付けられた公開鍵を取得します。
特定の VPS インスタンスに設定された SSH キーを確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys
vps_backups_list
指定した仮想マシンのバックアップを取得します。
VPS データの復旧に利用できるバックアップポイントを確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups
vps_backups_restore
指定した仮想マシンのバックアップを復元します。
その後、システムは復元処理を開始します。処理にかかる時間はバックアップのサイズによって異なります。
仮想マシン上のすべてのデータがバックアップのデータで上書きされます。
バックアップポイントから VPS データを復旧するには、このエンドポイントを使用します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore
vps_virtual-machines_set-hostname
指定した仮想マシンのホスト名を設定します。
ホスト名を変更しても、PTR レコードは自動的に更新されません。 仮想マシンにホスト名でアクセスできるようにするには、ドメインの A/AAAA レコードも仮想マシンの IP を指すように設定する必要があります。
VPS インスタンスにカスタムホスト名を設定するには、このエンドポイントを使用します。
- Method:
PUT - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_reset-hostname
指定した仮想マシンのホスト名と PTR レコードをデフォルト値にリセットします。
VPS インスタンスのホスト名設定をデフォルトに戻すには、このエンドポイントを使用します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_get
指定した仮想マシンの詳細情報を取得します。
VPS の設定とステータスを包括的に確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}
vps_virtual-machines_list
利用可能なすべての仮想マシンを取得します。
利用可能な VPS インスタンスを確認するには、このエンドポイントを使用します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines
vps_virtual-machines_purchase
新しい仮想マシンを購入してセットアップします。
何らかの理由で仮想マシンのセットアップに失敗した場合は、 hPanelにログインし、手動でセットアップを完了してください。
支払い方法が指定されていない場合は、デフォルトの支払い方法が自動的に使用されます。
応答が202 Acceptedの場合、支払い処理中のため、仮想マシンはセットアップされていません。
hPanelにログインし、手動でセットアップを完了してください。
このエンドポイントを使用して、新しいVPSインスタンスを作成します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines
vps_monarx_scan-metrics
指定した仮想マシンにインストールされているマルウェアスキャナーMonarxのスキャン指標を取得します。
スキャン指標には、Monarxが実行したマルウェアスキャンに関する詳細情報が含まれます。スキャンの回数、検出された脅威、その他の関連統計情報などです。この情報は、仮想マシンのセキュリティ状態を監視し、マルウェアスキャナーの有効性を評価するうえで役立ちます。
このエンドポイントを使用して、VPSのセキュリティスキャン結果と脅威の検出状況を監視します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_install
指定した仮想マシンにMonarxマルウェアスキャナーをインストールします。
Monarxは、仮想マシン上のマルウェア感染を検出し、防止するために設計されたセキュリティツールです。Monarxをインストールすると、仮想マシンのセキュリティを強化し、悪意のあるソフトウェアから確実に保護できます。
このエンドポイントを使用して、VPSインスタンスのマルウェア対策を有効にします。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_uninstall
指定した仮想マシンからMonarxマルウェアスキャナーをアンインストールします。
Monarxがインストールされていない場合でも、リクエストは処理されますが、何も変更されません。
このエンドポイントを使用して、VPSインスタンスからマルウェアスキャナーを削除します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_virtual-machines_metrics
指定した仮想マシンの過去の指標を取得します。
以下の指標が含まれます。
- CPU使用率
- メモリ使用率
- ディスク使用率
- ネットワーク使用率
- 稼働時間
このエンドポイントを使用して、VPSのパフォーマンスとリソース使用状況を経時的に監視します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/metrics
vps_virtual-machines_set-nameservers
指定した仮想マシンのネームサーバーを設定します。
ネームサーバーの設定が正しくないと、仮想マシンでドメイン名を解決できなくなる可能性があるため、ご注意ください。
このエンドポイントを使用して、VPSインスタンスのカスタムDNSリゾルバーを設定します。
- Method:
PUT - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers
vps_ptr_create
指定した仮想マシンのPTR(ポインター)レコードを作成または更新します。
このエンドポイントを使用して、VPSのIPアドレスの逆引きDNSを設定します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_ptr_delete
指定した仮想マシンのPTR(ポインター)レコードを削除します。
削除すると、仮想マシンのIPアドレスへの逆引きDNSで、以前に設定したホスト名が返されなくなります。
このエンドポイントを使用して、VPSインスタンスの逆引きDNS設定を削除します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_virtual-machines_set-panel-password
指定した仮想マシンのパネルパスワードを設定します。
仮想マシンがパネル OS を使用していない場合でも、リクエストは処理されますが、何も変更されません。 パスワードの要件は、仮想マシン再作成エンドポイントと同じです。
このエンドポイントを使用して、VPS インスタンスのコントロールパネルへのアクセス認証情報を設定します。
- Method:
PUT - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password
vps_recovery_start
指定した仮想マシンのリカバリモードを開始します。
リカバリモードは、ファイルシステムの修復、データの復元、仮想マシンの正常な起動を妨げる問題のトラブルシューティングなどのシステムレスキュー操作を実行できる特別な状態です。
仮想マシンはリカバリディスクイメージから起動し、元のディスクイメージは/mntディレクトリにマウントされます。
このエンドポイントを使用して、VPS インスタンスでシステムレスキュー操作を有効にします。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_recovery_stop
指定した仮想マシンのリカバリモードを停止します。
仮想マシンがリカバリモードでない場合、この操作は失敗します。
このエンドポイントを使用してシステムレスキューモードを終了し、VPS を通常の動作に戻します。
- Method:
DELETE - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_virtual-machines_recreate
仮想マシンを一から再作成します。
再作成処理では、オペレーティングシステムを再インストールし、 仮想マシンを初期状態にリセットします。 スナップショットがある場合は削除されます。
パスワードの要件
パスワードは、漏えいしたパスワードのデータベースと照合されます。 パスワードの要件は次のとおりです。
- 12 文字以上
- 大文字を 1 文字以上含む
- 小文字を 1 文字以上含む
- 数字を 1 文字以上含む
- 公開状態で漏えいしていないこと
この操作は取り消せず、仮想マシンに保存されているすべてのデータが失われます!
このエンドポイントを使用して、OS を新規インストールし、VPS インスタンスを完全に再構築します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/recreate
vps_virtual-machines_restart
指定した仮想マシンを完全に停止してから起動し、再起動します。
仮想マシンが停止している場合は起動します。
このエンドポイントを使用して、VPS インスタンスを再起動します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/restart
vps_virtual-machines_set-root-password
指定した仮想マシンの root パスワードを設定します。
パスワードの要件は、仮想マシン再作成エンドポイントと同じです。
このエンドポイントを使用して、VPS インスタンスの管理者認証情報を更新します。
- Method:
PUT - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/root-password
vps_virtual-machines_setup
initial状態の新しく購入した仮想マシンをセットアップします。
このエンドポイントを使用して、購入した VPS インスタンスを設定し、初期化します。
- Method:
POST - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/setup
vps_snapshots_get
指定した仮想マシンのスナップショットを取得します。
このエンドポイントを使用して、現在の VPS スナップショット情報を表示します。
- Method:
GET - Path:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_create
指定した仮想マシンのスナップショットを作成します。
スナップショットは、特定の時点における仮想マシンの状態とデータを記録します。必要に応じて、仮想マシンをその状態に復元できます。 この操作は、バックアップやシステムの復旧、仮想マシンの現在の状態に影響を与えずに変更をテストする場合に役立ちます。
新しいスナップショットを作成すると、既存のスナップショットが上書きされます!
このエンドポイントを使用して、バックアップと復旧のために VPS の状態を記録します。
- メソッド:
POST - パス:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_delete
指定した仮想マシンのスナップショットを削除します。
このエンドポイントを使用して、VPS のスナップショットを削除します。
- メソッド:
DELETE - パス:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_restore
スナップショットを使用して、指定した仮想マシンを以前の状態に復元します。
スナップショットから復元すると、仮想マシンをその状態に戻せます。システムの復旧や変更の取り消し、テストに役立ちます。
このエンドポイントを使用して、VPS インスタンスを以前に保存した状態に戻します。
- メソッド:
POST - パス:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore
vps_virtual-machines_start
指定した仮想マシンを起動します。
仮想マシンがすでに稼働している場合も、リクエストは処理されますが、状態に変化はありません。
このエンドポイントを使用して、停止中の VPS インスタンスを起動します。
- メソッド:
POST - パス:
/api/vps/v1/virtual-machines/{virtualMachineId}/start
vps_virtual-machines_stop
指定した仮想マシンを停止します。
仮想マシンがすでに停止している場合も、リクエストは処理されますが、状態に変化はありません。
これはコンピューティングのみの電源状態の変更であり、請求には影響しません。今後の請求を停止するには、対象のサブスクリプションの自動更新を無効にしてください。
このエンドポイントを使用して、稼働中の VPS インスタンスを停止します。
- メソッド:
POST - パス:
/api/vps/v1/virtual-machines/{virtualMachineId}/stop
hostinger-wordpress-mcp
wordpress_ai-content_generate-images
指定した WordPress インストールについて、プロンプトと画像タイプに基づいて 1 枚以上の画像の生成を開始します。生成は非同期で実行されます。レスポンスはすぐに返され、status: in-progress と generation_id が含まれます。status が completed または failed になるまで、数秒ごとに GET /api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id} をポーリングしてください。
生成が完了すると、有効期限とともに一時的な画像 URL が返されます。有効期限が切れる前に画像をダウンロードしてください。画像は指定されたアスペクト比に一致し、指定サイズを下回ることはありません。ロゴは透明画像として、マークの範囲にトリミングされます。
インストールごとに実行できる画像生成は一度に 1 件のみです。生成が進行中の場合、エンドポイントは実行中の生成 ID を含まない 409 を返します。そのため、202 を受け取れなかった呼び出し元は、新しい生成を開始する前に、完了するまで(数分かかる場合があります)待つ必要があります。エンドポイントのリクエスト制限は毎分 10 回です。
パスには WordPress インストールの識別子(software)を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate
wordpress_ai-content_generation-result
指定した WordPress インストールで開始された AI コンテンツ生成の結果を取得します。たとえば、POST /api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate で開始された画像生成などが対象です。
生成が実行中の間は status: in-progress のみが返されます。数秒おきにポーリングしてください。completed になると、result に type に応じた形式で生成コンテンツが格納されます。image-generation の場合は、有効期限とともに一時的な画像 URL が格納されます。website-generation の場合は、生成されたウェブサイトドキュメントが格納されます(Hostinger WordPress プラグインから開始)。failed になった生成には result がありません。不明な生成 ID または期限切れの生成 ID を指定すると、404 が返されます。
パスに WordPress インストール(ソフトウェア)識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id}
wordpress_ai-tools_show-option-status
指定した WordPress インストールの Hostinger Tools プラグインにおける、現在の AI オプションのステータスを表示します。option で絞り込むと単一のオプションが返されます。省略すると、すべてのオプションが返されます。
パスに WordPress インストール(ソフトウェア)識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_ai-tools_set-option-status
指定した WordPress インストールの Hostinger Tools プラグインにおける AI オプションを有効または無効にします。
パスに WordPress インストール(ソフトウェア)識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
PATCH - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_installations_check-if-are-valid
1 つ以上の WordPress インストールが有効で、正常に動作しているか確認します。ファイルの不足、プラグインやテーマの破損、その他同様の問題によって発生したインストールの不具合を検出します。
本文に WordPress インストール(ソフトウェア)識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/wordpress/installations/check-is-valid
wordpress_installations_delete
指定した WordPress インストールを削除します。ファイルとデータベースの削除は任意です。プラグイン、テーマ、ステージングウェブサイト、その他の関連データを含む、関連するすべてのコンポーネントが削除されます。
パスに WordPress インストール(ソフトウェア)識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
DELETE - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}
wordpress_installations_detect
アカウント内の WordPress インストールを検出するためのバックグラウンドスキャンを開始します。
この操作は非同期です。成功応答は、スキャンがキューに追加されたことを示すだけです。スキャン完了後に検出されたインストールを取得するには、GET /api/hosting/v1/wordpress/installations をポーリングしてください。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/wordpress/installations/detect
wordpress_installations_import-website
WordPress ウェブサイトを指定したドメインにインポートします。
警告:ウェブサイトの既存のコンテンツは上書きされ、元に戻すことはできません。このエンドポイントを呼び出す前に、意図した操作であることを確認してください。
このエンドポイントを使うと、ウェブサイトのディレクトリにアップロード済みのアーカイブファイルとデータベースファイルから、WordPress ウェブサイトをインポートできます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/import
wordpress_installations_install
既存のウェブサイトに WordPress をインストールします。
このエンドポイントを呼び出す前に、ウェブサイトが作成済みである必要があります。まず新しいウェブサイトを作成するには、POST /api/hosting/v1/orders/{order_id}/onboardings
(hosting_websites_start-setup)を使用し、domain フィルターを指定して GET /api/hosting/v1/onboardings
(hosting_websites_list-setups)をポーリングし、status が
completed になるまで確認します。
type: headless を送信すると、ヘッドレスウェブサイト(たとえば、type: headless_empty を指定して
hosting_websites_start-setup で作成したウェブサイト)をヘッドレス WordPress
ウェブサイトに変更できます。WordPress は Hostinger のヘッドレス
MU プラグインとともに cms ディレクトリにインストールされ、ウェブサイトはヘッドレス WordPress ウェブサイトとしてマークされます。directory は併用できません。対象のウェブサイトはすでにヘッドレスである必要があります。ヘッドレスインストールではルートの .htaccess が書き換えられるため、それ以外のウェブサイトではリクエストが 422 で拒否されます。
続行する前に、ユーザー名とドメインでフィルターした GET /api/hosting/v1/wordpress/installations(wordpress_installations_list)を呼び出し、対象のドメイン/パスに WordPress がすでにインストールされているか確認してください。WordPress がすでに存在し、overwrite が false(デフォルト)の場合、非同期ジョブは失敗します。
この操作は非同期です。成功応答は、インストールジョブがキューに追加されたことを示すだけで、WordPress の準備が完了したことを意味するものではありません。インストールには通常 1~2 分かかります。ユーザー名とドメインでフィルターした GET /api/hosting/v1/wordpress/installations
(wordpress_installations_list)をポーリングして進行状況を確認してください。インストールがリストに表示されたら、WordPress の準備は完了です。
アカウントがプランで許可されているデータベースをすべて使用している場合、database.name がアカウント上の既存のデータベースでない限り、422 が返されます。
- メソッド:
POST - パス:
/api/hosting/v1/accounts/{username}/wordpress/installations
wordpress_installations_list
認証済みクライアントがアクセスできる、共有およびクラウドのウェブホスティングアカウント(username で識別される /api/hosting/v1 ファミリー)上の WordPress インストールを一覧表示します。
Agency Plan のウェブサイトは含まれません。Agency Plan のウェブサイト上で WordPress を操作するには、GET /api/agency-hosting/v1/websites?website_types=wordpress で一覧を取得し、 GET /api/agency-hosting/v1/websites/{website_uid}/wordpress/settings で詳細を確認してください。Agency Plan のウェブサイトしか持たないアカウントでは、このエンドポイントから空のリストが返されます。
このエンドポイントは、既存の WordPress インストールを確認したり、インストールエンドポイントの呼び出し後にインストール状況をポーリングしたりするために使用します。新たにリクエストしたインストールがこのリストに表示されたら、WordPress の準備は完了です。ユーザー名とドメインでフィルターすると、特定のウェブサイトに結果を絞り込めます。
各インストールには valid フラグが含まれます。無効な場合は、その理由を説明する validationError も含まれます。
- メソッド:
GET - パス:
/api/hosting/v1/wordpress/installations
wordpress_installations_list-core-updates
指定したインストールで利用可能な WordPress コアの更新を一覧表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/updates
wordpress_installations_jwt-token
指定した WordPress インストールに対するリクエスト(MCP(Model Context Protocol)エンドポイントを含む)の認証に使用する JWT トークンを返します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- メソッド:
GET - パス:
/api/hosting/v1/accounts/{username}/wordpress/{software}/jwt-token
wordpress_installations_show-core-version
指定したインストールの WordPress コアバージョンと、それに影響する既知の脆弱性を表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/version
wordpress_installations_update-core
指定したインストールの WordPress コアを更新します(マイナーアップデートまたは特定のバージョンへの更新)。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。レスポンスが成功した場合でも、更新ジョブがキューに追加されたことを示すだけです。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/update
wordpress_litespeed-cache_purge-lite-speed
指定した WordPress インストールの LiteSpeed Cache を消去します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/purge
wordpress_litespeed-cache_show-lite-speed-status
指定した WordPress インストールの LiteSpeed Cache のステータスを表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/status
wordpress_login_create-links
指定した WordPress インストールの一時的な自動ログインリンクを作成します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/login/links
wordpress_maintenance_show-status
指定した WordPress インストールのメンテナンスモードのステータスを表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/status
wordpress_maintenance_toggle
enabled フラグに基づいて、指定した WordPress インストールのメンテナンスモードを有効または無効にします。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/toggle
wordpress_object-cache_show-memcached-status
指定した WordPress インストールの Memcached オブジェクトキャッシュのステータスを表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/status
wordpress_object-cache_toggle-memcached
enabled フラグに基づいて、指定した WordPress インストールの Memcached オブジェクトキャッシュを有効または無効にします。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。この識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/toggle
wordpress_plugins_activate
WordPress インストールで、インストール済みのプラグインを有効化します。
パスには、WordPress インストールの識別子(software)を指定します。この識別子は、GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
この操作は非同期です。成功レスポンスは、有効化ジョブがキューに登録されたことのみを意味します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/activate
wordpress_plugins_deactivate
WordPress インストールで、インストール済みのプラグインを無効化します。
パスには、WordPress インストールの識別子(software)を指定します。この識別子は、GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
この操作は非同期です。成功レスポンスは、無効化ジョブがキューに登録されたことのみを意味します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/deactivate
wordpress_plugins_deploy
アップロード済みのディレクトリから WordPress プラグインをデプロイします。
このエンドポイントを使用すると、ウェブサイトのディレクトリにアップロード済みの WordPress プラグインをデプロイできます。 プラグインは有効化され、WordPress 管理パネルで利用できるようになります。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/plugins/deploy
wordpress_plugins_install
既存の WordPress インストールに、1 つ以上のプラグインをインストールします。
パスには、WordPress インストールの識別子(software)を指定します。この識別子は、GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。インストール可能なプラグインのスラッグを確認するには、GET /api/hosting/v1/wordpress/plugins を使用します。
この操作は非同期です。成功レスポンスは、インストールジョブがキューに登録されたことのみを意味し、プラグインの準備が完了したことを示すものではありません。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install
wordpress_plugins_list
WordPress インストールで、まだインストールされていない、インストールが推奨されるプラグインを一覧表示します。
パスには、WordPress インストールの識別子(software)を指定します。この識別子は、GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/available
wordpress_plugins_list-installed
WordPress インストールにインストール済みのプラグインを、ステータス、利用可能な更新、既知の脆弱性とともに一覧表示します。
パスには、WordPress インストールの識別子(software)を指定します。この識別子は、GET /api/hosting/v1/wordpress/installations の id フィールドから取得できます。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins
wordpress_plugins_search
WordPress.org のプラグインディレクトリを検索し、インストール可能なプラグインを探します。
返された slug の値は、POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install で使用します。
- Method:
GET - Path:
/api/hosting/v1/wordpress/plugins
wordpress_plugins_list-suggested
ウェブサイトの種類ごとに分類された、おすすめプラグインを一覧表示します。
返された slug の値は、POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install で使用します。
- Method:
GET - Path:
/api/hosting/v1/wordpress/plugins/suggested
wordpress_plugins_check-if-woo-commerce-is-installed
ドメイン内のいずれかの WordPress インストールに WooCommerce がインストールされているか確認します。必要に応じて、ドメインを指定して確認対象を絞り込めます。
- Method:
GET - Path:
/api/hosting/v1/wordpress/plugins/is-woocommerce-installed
wordpress_plugins_uninstall
WordPress インストールから 1 つ以上のプラグインをアンインストールします。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功応答は、アンインストールジョブがキューに登録されたことを示すだけです。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/uninstall
wordpress_plugins_update-hostinger
WordPress インストール上の Hostinger プラグインを最新バージョンに更新します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功応答は、更新ジョブがキューに登録されたことを示すだけです。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/hostinger/update
wordpress_plugins_update
WordPress インストールにインストールされている 1 つ以上のプラグインを最新バージョンに更新します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功応答は、更新ジョブがキューに登録されたことを示すだけです。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/update
wordpress_themes_activate
WordPress インストールにインストールされているテーマを有効化します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功応答は、有効化ジョブがキューに登録されたことを示すだけです。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/activate
wordpress_themes_deploy
アップロード済みのディレクトリから WordPress テーマをデプロイします。
このエンドポイントでは、ウェブサイトのディレクトリにアップロード済みの WordPress テーマをデプロイできます。デプロイ後にテーマを有効化することもできます。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/themes/deploy
wordpress_themes_install
既存の WordPress インストールにテーマをインストールします。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
Hostinger のテーマ(hostinger-blog、hostinger-affiliate-theme、hostinger-ai-theme)の場合、任意の palette、layout、font フィールドはカスタムインストーラーに渡されます(デフォルト:palette1、layout1、default)。それ以外のテーマでは無視されます。
この操作は非同期です。成功応答は、インストールジョブがキューに登録されたことを示すだけであり、テーマが使用可能になったことを示すものではありません。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install
wordpress_themes_list-installed
WordPress インストールにインストールされているテーマを、それぞれのステータス、利用可能な更新、既知の脆弱性とともに一覧表示します。
パスには WordPress インストール(ソフトウェア)の識別子を指定してください。GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes
wordpress_themes_list
インストール可能な WordPress テーマを一覧表示します。
返された slug の値を POST /api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install で使用してください。
- Method:
GET - Path:
/api/hosting/v1/wordpress/themes
wordpress_themes_uninstall
WordPress インストールから 1 つ以上のテーマをアンインストールします。
パスに WordPress インストール(ソフトウェア)の識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功レスポンスは、アンインストールジョブがキューに追加されたことのみを意味します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/uninstall
wordpress_themes_update
WordPress インストールにインストールされている 1 つ以上のテーマを最新バージョンに更新します。
パスに WordPress インストール(ソフトウェア)の識別子を指定してください。識別子は GET /api/hosting/v1/wordpress/installations から取得できます(id フィールド)。
この操作は非同期です。成功レスポンスは、更新ジョブがキューに追加されたことのみを意味します。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/update
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。