API DOCUMENTATION

API ドキュメント

Value Domain One が提供する VDAPI のリファレンスです。いずれも OAuth2 で取得した Bearer access_token による認証が必要です。

REST 形式の API
OpenAPI 3.1 の仕様書
ログインなしで読める

ドメインの空き状況を調べる例例

リクエスト

curl -H "Authorization: Bearer {access_token}" \  "https://api-one.value-domain.com/v2/domainsearch?domainnames=example.com"

応答（一部）

{  "results": [    {      "domainname": "example.com",      "status": "211 Domain name not available"    }  ]}

ドメイン空き状況検索（GET /v2/domainsearch）の例です。応答は一部だけを載せています。status の 210 は空いている、211 は空いていないという意味です。example.com は説明のために予約された名前で、取得できません。

API の使い方

ドキュメントを開く

下の一覧から、使う API のドキュメント（ドメイン・サーバー契約・One レンタルサーバー設定）を開きます。
認証のヘッダーを付けて呼ぶ

https://api-one.value-domain.com/v2 のエンドポイントに、Authorization: Bearer {access_token} のヘッダーを付けてリクエストします。
ステータスを確かめる

エラーのときは、HTTP のステータスで理由がわかります。共通のエラー応答は下の表のとおりです。

VDAPI v2 ドキュメント

Value Domain One コントロールパネルでの契約・ドメイン設定操作を REST 形式の API で操作できます。

ドキュメント	内容	URL
VDAPI v2 — ドメイン契約・設定編	VDAPI v2 ドメインの契約・whois/NS/DNS 等ドメイン設定操作の API ドキュメント	`/doc/api/v2/domain`
VDAPI v2 — サーバー契約編	VDAPI v2 サーバー（oneserver / coreserver / valueserver / xrea）契約関連の API ドキュメント ※サーバー設定操作 API は「サーバー API ドキュメント」の対象サーバーのドキュメントをご確認ください。	`/doc/api/v2/server`
VDAPI v2 — アカウント編	VDAPI v2 API トークン（個別 API キー）の一覧・発行・権限更新・失効と scope カタログ取得の API ドキュメント	`/doc/api/v2/account`

サーバー API ドキュメント

サーバー設定操作系の API ドキュメント。 Oneレンタルサーバー・コアサーバー(v1)・XREA 対象（コアサーバー v2 はサーバー API 非対応です）。サーバーコントロールパネルでの設定操作を API で操作できます。

ドキュメント	内容	URL
VDAPI v2 — Oneレンタルサーバー設定編	VDAPI v2 Oneレンタルサーバー設定操作系（ドメイン / メール / PHP / FTP / ユーザー / ツール / セキュリティ / バックアップ / アプリ / サーバー / データベース）の API ドキュメント。	`/doc/api/v2/oneserver-panel`
コアサーバー(v1) API ドキュメント（別のサイト）		`https://apidoc.coreserver.jp/`
XREA API ドキュメント（別のサイト）		`https://apidoc.xrea.com/`

VDAPI v1 ドキュメント

VDAPI v1 旧仕様 API。v2 をお使いください。

ドキュメント	内容	URL
VDAPI v1 — ドメイン契約・設定編（別のサイト）	VDAPI v1 ドメインの契約・whois/NS/DNS 等ドメイン設定操作の API ドキュメント	`https://www.value-domain.com/api/doc/domain/`
VDAPI v1 — サーバー契約編（別のサイト）	VDAPI v1 サーバー（coreserver.v1 / valueserver / xrea）契約関連の API ドキュメント ※coreserver.v2 / oneserver は v1 対象外	`https://www.value-domain.com/api/doc/server/`

注記

VDAPI v2 の各ページは OpenAPI 3.1 仕様を Scalar API Reference で描画しています。
Try it out（ブラウザからの API 実行）は本ページでは無効化しています。
VDAPI v1 のドキュメントは www.value-domain.com 上で公開されています。

API トークンと権限（scope）

トークンごとに、使える操作を選ぶ

API トークンは、One パネルの「API トークン」の画面で発行します。トークンの文字は発行したときに一度だけ表示されるので、安全な場所に保存してください。

トークンには権限（scope）を付けます。トークンは、その scope の範囲でのみ API を呼び出せます。最小限の権限だけを付けることをおすすめします。

scope の action の意味
action	意味
read	参照のみ
write	設定変更（金銭・所有権移動を含まない）
contract	課金（取得・更新・プラン変更・解約）
transfer	移管・所有権移動
manage	API キー管理

API でできること

対象	できること	ドキュメント
ドメイン	取得・新規登録・削除、移管申請、有効期限の取得・延長、自動更新と移管ロックの取得・変更	ドメイン契約・設定編
ドメインの設定	WHOIS情報・ネームサーバー・DNS・ダイナミックDNS・DNSSEC の取得・変更、プライベートネームサーバーの管理	ドメイン契約・設定編
空き状況	ドメイン名の空き確認（カンマ区切りで複数）	ドメイン契約・設定編
サーバーの契約	One レンタルサーバー・コアサーバー・XREA・バリューサーバーの構築・契約内容の変更、有効期限・自動更新の確認と変更	サーバー契約編
One レンタルサーバーの設定	ドメイン / メール / PHP / FTP / ユーザー / ツール / セキュリティ / バックアップ / アプリ / サーバー / データベース	One レンタルサーバー設定編
API のログ	API リクエストのログの取得	各編
API トークン	API トークン（個別 API キー）の一覧・発行・権限更新・失効と scope カタログの取得	アカウント編

エラーのときの応答

状況	HTTP	説明
バリデーション失敗	400	Bad Request
認証なし / トークン無効	401	Unauthorized
アクセス禁止	403	Forbidden
リソース不存在	404	Not Found
サーバー内部エラー	500	Internal Server Error
サービス利用不可	503	Service Unavailable
タイムアウト	504	Gateway Timeout

ドメイン・サーバー契約・One レンタルサーバー設定の各編で共通です。

よくあるご質問

AI エージェントから操作するときの料金はかかりますか？

MCPサーバー利用料は無料です（AIトークン料金はお客様ご負担）。One MCP を使うと、Claude や Cursor などの MCP 対応 AI エージェントから、ドメインの空き確認・取得・DNSレコード設定までを自然言語で実行できます。

ドキュメントのページから API を試せますか？

いいえ。ドキュメントのページでは、ブラウザからの API の実行（Try it out）を無効にしています。リクエストの例は curl の形で表示します。

VDAPI v1 と v2 のどちらを使えばよいですか？

v2 をお使いください。v1 は旧仕様の API で、ドキュメントは www.value-domain.com で公開しています。

ドキュメントを読むのにログインは必要ですか？

いいえ。このページと各 API のドキュメントのページは、ログインせずに読めます。API を呼び出すときは、リクエストごとに認証が必要です。

OpenAPI の仕様書のファイルは取得できますか？

はい。各ドキュメントのページの URL の末尾に /spec.yaml を付けると、OpenAPI 3.1 の仕様書（YAML）を取得できます。例: /doc/api/v2/domain/spec.yaml

空き状況は一度に複数のドメインを調べられますか？

はい。ドメイン空き状況検索（GET /v2/domainsearch）の domainnames に、ドメイン名をカンマ区切りで渡せます。日本語ドメインは Punycode で入力します。

アカウントを作成して、API を使い始める

無料でアカウント作成