バリュードメインAPIドキュメント (1.0.0)

Download OpenAPI specification:Download

概要

このAPIを使用することで、お客様のシステムからバリュードメインの機能を利用することができます。

API認証

このAPIはBearer認証で保護されています。予めトークンを発行しAuthorizationヘッダーに付与してAPIを利用いたします。

Authorization: Bearer <token>

APIの利用

エンドポイント：https://api.value-domain.com/v1/

HTTPプロトコルのGET,POST,PUT,DELETEメソッドでレスポンスを送信します。

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

ドメイン

ドメイン　情報（一覧）取得・新規作成・変更・削除

ドメインの情報一覧取得

リクエスト

GET /domains

概要

アカウントで管理しているドメインの情報一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains

API本番用

https://api.value-domain.com/v1/domains

Request samples

Copy

$apikey = 'Your APIKEY';

$url = "https://api.value-domain.com/v1";
$path = "/domains";
$method = "GET";
$postfields = array();
$post_query = json_encode($postfields);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . $path);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
if ($method!=='GET') {
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $post_query);
  curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);//FIXME use http version 1.1
}
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 120);

$headers = array();
$headers[] = "Content-Type: application/json";
if ($method!=='GET') {
  $headers[] = 'Content-Length: ' . strlen($post_query);
}
$headers[] = 'Authorization: Bearer ' . $apikey;
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
  echo 'Connection Error: ' . curl_errno($ch) . ' - ' . curl_error($ch);exit;
}
$info = curl_getinfo($ch);

curl_close($ch);

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999998,
"domainname": "example.com",
"registrar": "GMO",
"expirationdate": "2024-04-01",
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10
},
{"domainid": 9999999,
"domainname": "example2.com",
"registrar": "GMO",
"expirationdate": "2024-05-01",
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10
}
],
"request_id": "20190502412345678"
}

ドメインの新規登録

リクエスト

POST /domains

概要

ドメイン名を登録し、ネームサーバと担当者情報の割り当てを行う

Authorizations:

bearerAuth

Request Body schema: application/json

ドメイン情報

registrar	string Default: "GMO" レジストラ 'GMO'のみ対応しています (e.g. GMO)
sld required	string セカンドレベルドメインご希望のドメイン名を指定します (e.g. example)
tld required	string トップレベルドメインご希望のドメイン名を指定します (e.g. com)
years	integer Default: 1 登録年数複数年指定することができます 1〜10年 (e.g. 1)
ns required	array ネームサーバー名ネームサーバーを指定します (e.g. ['ns1.value-domain.com, ns2.value-domain.com'])
whois_proxy	integer Default: 0 Whois代行設定 Whois情報を弊社の代理名義にします 1:する, 0:しない (e.g. 1)
contact required	object 登録者情報(アルファベット) registrant : 登録者情報 admin : 管理担当者情報 tech : 技術担当者情報 billing : 経理担当者情報

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

post /domains

API本番用

https://api.value-domain.com/v1/domains

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"registrar": "GMO",
"sld": "string",
"tld": "string",
"years": 1,
"ns": 
["ns1.value-domain.com",
"ns2.value-domain.com",
"ns3.value-domain.com"
],
"whois_proxy": 1,
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"sld": "example",
"tld": "com"
},
"request_id": "20190502412345678"
}

ドメインの情報取得

リクエスト

GET /domains/{domain}

概要

アカウントで管理しているドメインの情報取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}

API本番用

https://api.value-domain.com/v1/domains/{domain}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"registrar": "GMO",
"expirationdate": "2024-04-01",
"status": "TRANSFER_LOCK",
"transfer_lock": 0,
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10,
"ns": 
["ns1.value-domain.com",
"ns2.value-domain.com",
"ns3.value-domain.com"
],
"whoisproxy": "1",
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
},
"request_id": "20190502412345678"
}

ドメインの削除

リクエスト

DELETE /domains/{domain}

概要

アカウントで管理しているドメインをアカウントから削除します。 ※ドメイン自体は有効期限まで削除されません。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

delete /domains/{domain}

API本番用

https://api.value-domain.com/v1/domains/{domain}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com"
},
"request_id": "20190502412345678"
}

ドメイン/移管申請

ドメイン移管申請　情報（一覧）取得・新規作成・削除

アカウントのドメイン移管申請の情報一覧取得

リクエスト

GET /domains/transfer

概要

アカウントのドメイン移管申請の情報を一覧取得します。

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/transfer

API本番用

https://api.value-domain.com/v1/domains/transfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 0,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXX",
"status": "STAY",
"expirationdate": "",
"failurereason": "",
"starttime": "2019-10-04 18:27:20"
},
{"domainid": 0,
"domainname": "example2.com",
"transferorderid": "GMO-XXXXXXXXXXXXXX",
"status": "FAILED",
"expirationdate": "",
"failurereason": "移管コードエラーです。",
"starttime": "2019-11-04 18:27:20"
}
],
"request_id": "20190502412345678"
}

ドメイン移管申請の情報一覧取得

リクエスト

GET /domains/{domain}/transfer

概要

ドメインのドメイン移管申請の情報を一覧取得します。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/transfer

API本番用

https://api.value-domain.com/v1/domains/{domain}/transfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 0,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXX",
"status": "STAY",
"expirationdate": "",
"failurereason": "",
"starttime": "2019-10-04 18:27:20"
},
{"domainid": 0,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXX",
"status": "FAILED",
"expirationdate": "",
"failurereason": "移管コードエラーです。",
"starttime": "2019-11-04 18:27:20"
}
],
"request_id": "20190502412345678"
}

ドメイン移管申請の新規登録

リクエスト

POST /domains/{domain}/transfer

概要

アカウントで管理していないドメインをアカウントへ移管する申請を行います。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

registrar	string Default: "GMO" レジストラ 'GMO'のみ対応しています (e.g. GMO)
authcode	string 移管コード
ns	Array of strings ネームサーバー名ネームサーバーを指定します (e.g. ['ns1.value-domain.com, ns2.value-domain.com'])
whois_proxy	integer Whois代行設定 Whois情報を弊社の代理名義にします 1:する, 0:しない (e.g. 1)
contact	object 登録者情報(アルファベット) registrant : 登録者情報 admin : 管理担当者情報 tech : 技術担当者情報 billing : 経理担当者情報

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

post /domains/{domain}/transfer

API本番用

https://api.value-domain.com/v1/domains/{domain}/transfer

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"registrar": "GMO",
"authcode": "XXXXXXXXXXX",
"ns": 
["ns1.value-domain"
],
"whois_proxy": 1,
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXXXXXXXXX"
},
"request_id": "20190502412345678"
}

ドメイン移管申請の情報取得

リクエスト

GET /domains/{domain}/transfer/{transferorderid}

概要

ドメイン移管申請の情報を取得します。

Authorizations:

bearerAuth

path Parameters

domain required	string 「登録済みドメインの一覧の取得」APIから取得ドメインIDとドメイン名のどちらでも指定可能
transferorderid required	string 移管申請ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/transfer/{transferorderid}

API本番用

https://api.value-domain.com/v1/domains/{domain}/transfer/{transferorderid}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXXXXXXXXX"
},
"request_id": "20190502412345678"
}

ドメイン移管申請の削除

リクエスト

DELETE /domains/{domain}/transfer/{transferorderid}

概要

ドメイン移管申請を削除します。

Authorizations:

bearerAuth

path Parameters

domain required	string 「登録済みドメインの一覧の取得」APIから取得ドメインIDとドメイン名のどちらでも指定可能
transferorderid required	string 移管申請ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

delete /domains/{domain}/transfer/{transferorderid}

API本番用

https://api.value-domain.com/v1/domains/{domain}/transfer/{transferorderid}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"transferorderid": "GMO-XXXXXXXXXXXXXXXXXXXXX"
},
"request_id": "20190502412345678"
}

ドメイン/有効期限

ドメインの有効期限　情報（一覧）取得・変更（延長）

ドメイン有効期限の一覧取得

リクエスト

GET /domains/expiration

概要

ドメイン有効期限の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/expiration

API本番用

https://api.value-domain.com/v1/domains/expiration

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 999999998,
"domainname": "example.com",
"expirationdate": "2024-01-01"
},
{"domainid": 999999999,
"domainname": "example2.com",
"expirationdate": "2025-01-01"
}
],
"request_id": "20190502412345678"
}

ドメイン有効期限の取得

リクエスト

GET /domains/{domain}/expiration

概要

ドメイン有効期限の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/expiration

API本番用

https://api.value-domain.com/v1/domains/{domain}/expiration

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"expirationdate": "2024-04-01"
},
"request_id": "20190502412345678"
}

ドメイン有効期限の変更（延長）

リクエスト

PUT /domains/expiration

概要ドメイン有効期限の変更（延長）

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

years

integer

延長年数 1~9
※ドメインの最大更新可能年数の範囲内

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/expiration

API本番用

https://api.value-domain.com/v1/domains/{domain}/expiration

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"years": 1
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"expirationdate": "2024-04-01"
},
"request_id": "20190502412345678"
}

ドメイン/自動更新

ドメインの自動更新設定　情報（一覧）取得・変更

ドメイン自動更新の一覧取得

リクエスト

GET /domains/autorenew

概要

ドメイン自動更新の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/autorenew

API本番用

https://api.value-domain.com/v1/domains/autorenew

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10
}
],
"request_id": "20190502412345678"
}

ドメイン自動更新の取得

リクエスト

GET /domains/{domain}/autorenew

概要

ドメイン自動更新の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/autorenew

API本番用

https://api.value-domain.com/v1/domains/{domain}/autorenew

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10
},
"request_id": "20190502412345678"
}

ドメイン自動更新の変更

リクエスト

PUT /domains/{domain}/autorenew

概要

ドメイン自動更新の変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ドメイン自動更新

autorenew_all	integer 自動更新ドメイン全体設定 0:自動更新しないA（ドメイン設定を優先） 9:自動更新しないB（ドメイン設定を無視） 10:自動更新するA（ドメイン設定を優先） 11:自動更新するB（ドメイン設定を無視）
autorenew_domain	integer 自動更新ドメイン個別設定 0:全体設定に従う 9:自動更新しない 10:自動更新する

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/autorenew

API本番用

https://api.value-domain.com/v1/domains/{domain}/autorenew

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"autorenew_all": 1,
"autorenew_domain": 10
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"autorenew": 1,
"autorenew_all": 10,
"autorenew_domain": 10
},
"request_id": "20190502412345678"
}

ドメイン/移管ロック

ドメインの移管ロック　情報（一覧）取得・変更

ドメイン移管ロックの一覧取得

リクエスト GET /domains/transferlock

概要

ドメイン移管ロックの一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/transferlock

API本番用

https://api.value-domain.com/v1/domains/transferlock

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"transfer_lock": 1,
"authcode": "abcdefg12345"
}
],
"request_id": "20190502412345678"
}

ドメイン移管ロックの取得

リクエスト

GET /domains/{domain}/transferlock

概要

ドメイン移管ロックの取得

※ domainは「登録済みドメインの一覧取得API」から取得します domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/transferlock

API本番用

https://api.value-domain.com/v1/domains/{domain}/transferlock

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"transfer_lock": 1,
"authcode": "abcdefg12345"
},
"request_id": "20190502412345678"
}

ドメイン移管ロックの変更

リクエスト

PUT /domains/{domain}/transferlock

概要

ドメイン移管ロックの変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ドメイン移管ロック

transfer_lock

integer

移管ロック
1:有効 0:無効

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/transferlock

API本番用

https://api.value-domain.com/v1/domains/{domain}/transferlock

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"transfer_lock": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"transfer_lock": 1,
"authcode": "abcdefg12345"
},
"request_id": "20190502412345678"
}

ドメイン/Whois

ドメインのWhois情報情報（一覧）取得・変更

whoisの一覧取得

リクエスト

GET /domains/whois

概要

whoisの一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/whois

API本番用

https://api.value-domain.com/v1/domains/whois

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"whoisproxy": "1",
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
}
],
"request_id": "20190502412345678"
}

whoisの取得

リクエスト

GET /domains/{domain}/whois

概要

whoisの取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/whois

API本番用

https://api.value-domain.com/v1/domains/{domain}/whois

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"whoisproxy": "1",
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
},
"request_id": "20190502412345678"
}

whoisの変更

リクエスト

PUT /domains/whois

概要 whoisの変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

whois_proxy	integer Whois代行設定 Whois情報を弊社の代理名義にします 1:する, 0:しない ※変更しない場合はパラメーターを送信しないこと (e.g. 1)
contact	object 登録者情報(アルファベット)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/whois

API本番用

https://api.value-domain.com/v1/domains/{domain}/whois

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"whois_proxy": 1,
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"whoisproxy": "1",
"contact": 
{"registrant": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"admin": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"tech": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
},
"billing": 
{"firstname": "Taro",
"lastname": "Yamada",
"organization": "personal",
"country": "JP",
"postalcode": "530-0011",
"state": "Osaka",
"city": "Osaka-shi Kita-ku",
"address1": "3-1 Ofuka-cho nomo",
"address2": "Grand Front Osaka Tower B 23F",
"email": "yamada@example.com",
"phone": "+81.612345678",
"fax": "+81.612345678"
}
}
},
"request_id": "20190502412345678"
}

ドメイン/ネームサーバー

ドメインのネームサーバー　情報（一覧）取得・変更

ネームサーバーの一覧取得

リクエスト

GET /domains/nameserver

概要

ネームサーバーの一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/nameserver

API本番用

https://api.value-domain.com/v1/domains/nameserver

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"ns": 
["ns1.value-domain"
]
}
],
"request_id": "20190502412345678"
}

ネームサーバーの取得

リクエスト

GET /domains/{domain}/nameserver

概要

ネームサーバーの取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/nameserver

API本番用

https://api.value-domain.com/v1/domains/{domain}/nameserver

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ns": 
["ns1.value-domain"
]
},
"request_id": "20190502412345678"
}

ネームサーバーの変更

リクエスト

PUT /domains/{domain}/nameserver

概要

ネームサーバーの変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ネームサーバー情報

ns	Array of strings ネームサーバー (e.g. [ns1.value-domain, ns2.value-domain])

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/nameserver

API本番用

https://api.value-domain.com/v1/domains/{domain}/nameserver

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ns": 
["ns1.value-domain.com"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ns": 
["ns1.value-domain"
]
},
"request_id": "20190502412345678"
}

ドメイン/DNS

ドメインのDNS設定　情報（一覧）取得・変更

DNS設定の一覧取得

リクエスト

GET /domains/dns

概要

DNS設定の一覧取得

注意

ns_type:valuedomain1 valuedomain11 のみ対応

他社ネームサーバーや gmo enom のネームサーバー使用時は valuedomain11 の内容が返却されます。

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/dns

API本番用

https://api.value-domain.com/v1/domains/dns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"ns_type": "valuedomain1",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
}
],
"request_id": "20190502412345678"
}

DNS設定の取得

リクエスト

GET /domains/{domain}/dns

概要

DNS設定の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

注意

ns_type:valuedomain1 valuedomain11 のみ対応

他社ネームサーバーや gmo enom のネームサーバー使用時は valuedomain11 の内容が返却されます。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/dns

API本番用

https://api.value-domain.com/v1/domains/{domain}/dns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ns_type": "valuedomain1",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
},
"request_id": "20190502412345678"
}

DNS設定の変更

リクエスト

PUT /domains/{domain}/dns

概要

DNS設定の変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

注意

ns_type:valuedomain1 valuedomain11 のみ対応

gmo enom のネームサーバー未対応

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ns_type	string ネームサーバータイプ valuedomain1: ns1-5.value-domain.com valuedomain11: ns11-13.value-domain.com gmo: 01-04.dnsv.jp enom: dns1-5.name-services.com (e.g. valuedomain1)
records	string DNSレコードレコードごとに改行区切りタイプターゲット内容
ttl	integer TTL

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/dns

API本番用

https://api.value-domain.com/v1/domains/{domain}/dns

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ns_type": "valuedomain1",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ns_type": "valuedomain1",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
},
"request_id": "20190502412345678"
}

ドメイン/DynamicDNS

ドメインのダイナミックDNS設定　情報（一覧）取得・変更

ダイナミックDNS設定の一覧取得

リクエスト

GET /domains/dynamicdns

概要

ダイナミックDNS設定の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/dynamicdns

API本番用

https://api.value-domain.com/v1/domains/dynamicdns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"dynamicdns": "1",
"password": "abcdef123456",
"url": "https://dyn.value-domain.com/cgi-bin/dyn.fcg"
}
],
"request_id": "20190502412345678"
}

ダイナミックDNS設定の取得

リクエスト

GET /domains/{domain}/dynamicdns

概要

ダイナミックDNS設定の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/dynamicdns

API本番用

https://api.value-domain.com/v1/domains/{domain}/dynamicdns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"dynamicdns": "1",
"password": "abcdef123456",
"url": "https://dyn.value-domain.com/cgi-bin/dyn.fcg"
},
"request_id": "20190502412345678"
}

ダイナミックDNS設定の変更

リクエスト

PUT /domains/{domain}/dynamicdns

概要

ダイナミックDNS設定の変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

dynamicdns	integer ダイナミックDNS設定 0:無効 1:有効 (e.g. 1)
password	string ダイナミックDNS設定パスワード ※ダイナミックDNS設定画面でのログインに必要

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/dynamicdns

API本番用

https://api.value-domain.com/v1/domains/{domain}/dynamicdns

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"dynamicdns": "1",
"password": "abcdef123456"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"dynamicdns": "1",
"password": "abcdef123456",
"url": "https://dyn.value-domain.com/cgi-bin/dyn.fcg"
},
"request_id": "20190502412345678"
}

ドメイン/DNSSEC

ドメインのDNSSEC設定　情報（一覧）取得・変更

DNSSEC設定の一覧取得

リクエスト

GET /domains/dnssec

概要

DNSSEC設定の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/dnssec

API本番用

https://api.value-domain.com/v1/domains/dnssec

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"ds_records": 
{"keytag": 12345,
"alg": 13,
"digesttype": 2,
"digest": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}
],
"request_id": "20190502412345678"
}

DNSSEC設定の取得

リクエスト

GET /domains/{domain}/dnssec

概要

DNSSEC設定の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/dnssec

API本番用

https://api.value-domain.com/v1/domains/{domain}/dnssec

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ds_records": 
{"keytag": 12345,
"alg": 13,
"digesttype": 2,
"digest": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"request_id": "20190502412345678"
}

DNSSEC設定の変更

リクエスト

PUT /domains/{domain}/dnssec

概要

DNSSEC設定の変更

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ds_records

Array of objects (DSRecords)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/dnssec

API本番用

https://api.value-domain.com/v1/domains/{domain}/dnssec

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ds_records": 
[
{"keytag": 12345,
"alg": 13,
"digesttype": 2,
"digest": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"ds_records": 
{"keytag": 12345,
"alg": 13,
"digesttype": 2,
"digest": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"request_id": "20190502412345678"
}

ドメイン/プライベートネームサーバー

ドメインのプライベートネームサーバー　情報（一覧）取得・新規作成・変更・削除

プライベートネームサーバーの一覧取得

リクエスト

GET /domains/{domain}/privatenameserver

概要

ドメインに登録されているプライベートネームサーバーの一覧取得

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/privatenameserver

API本番用

https://api.value-domain.com/v1/domains/{domain}/privatenameserver

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"hostname": "example",
"ipv4": "xxx.xxx.xxx.xxx",
"ipv6": "2400:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx"
}
],
"request_id": "20190502412345678"
}

プライベートネームサーバーの新規登録

リクエスト

POST /domains/{domain}/privatenameserver

概要

ドメイン名のプライベートネームサーバーを新規作成する。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

hostname	string ネームサーバー名
ipv4	string IPアドレス(IPv4) ※ipv4とipv6はどちらか一方のみ設定できます。
ipv6	string IPアドレス(IPv6) ※ipv4とipv6はどちらか一方のみ設定できます。

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

post /domains/{domain}/privatenameserver

API本番用

https://api.value-domain.com/v1/domains/{domain}/privatenameserver

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"hostname": "example",
"ipv4": "xxx.xxx.xxx.xxx",
"ipv6": "2400:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"hostname": "example",
"ipv4": "xxx.xxx.xxx.xxx",
"ipv6": "2400:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx"
},
"request_id": "20190502412345678"
}

プライベートネームサーバーの情報取得

リクエスト

GET /domains/{domain}/privatenameserver/{hostname}

概要

ホスト名のプライベートネームサーバーの情報取得

Authorizations:

bearerAuth

path Parameters

domain required	string 「登録済みドメインの一覧の取得」APIから取得ドメインIDとドメイン名のどちらでも指定可能
hostname required	string プライベートネームサーバーホスト名

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/privatenameserver/{hostname}

API本番用

https://api.value-domain.com/v1/domains/{domain}/privatenameserver/{hostname}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"hostname": "example",
"ipv4": "xxx.xxx.xxx.xxx",
"ipv6": "2400:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx"
},
"request_id": "20190502412345678"
}

プライベートネームサーバーの削除

リクエスト

DELETE /domains/{domain}/privatenameserver/{hostname}

概要

ホスト名のプライベートネームサーバーを削除します。

Authorizations:

bearerAuth

path Parameters

domain required	string 「登録済みドメインの一覧の取得」APIから取得ドメインIDとドメイン名のどちらでも指定可能
hostname required	string プライベートネームサーバーホスト名

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

delete /domains/{domain}/privatenameserver/{hostname}

API本番用

https://api.value-domain.com/v1/domains/{domain}/privatenameserver/{hostname}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"hostname": "ns1.example.com"
},
"request_id": "20190502412345678"
}

ドメイン/所有権（ユーザー間移動）

ドメインの所有権　情報（一覧）取得・変更

ドメイン所有権情報の一覧取得

リクエスト

GET /domains/localtransfer

概要

ドメイン所有権情報の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/localtransfer

API本番用

https://api.value-domain.com/v1/domains/localtransfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"username": "valuedomainuser"
}
],
"request_id": "20190502412345678"
}

ドメイン所有権情報の取得

リクエスト

GET /domains/{domain}/localtransfer

概要

ドメイン所有権情報の取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}/localtransfer

API本番用

https://api.value-domain.com/v1/domains/{domain}/localtransfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"username": "valuedomainuser"
},
"request_id": "20190502412345678"
}

ドメイン所有権の変更（ユーザー間移動）

リクエスト

PUT /domains/{domain}/localtransfer

概要

ドメイン所有権の変更（ユーザー間移動）

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ドメイン所有権の変更（ユーザー間移動）

username	string 変更先のユーザー名 (e.g. tovaluedomainuser)
message	string 変更先のユーザーへ表示するメッセージ (e.g. Give this domain to you.)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /domains/{domain}/localtransfer

API本番用

https://api.value-domain.com/v1/domains/{domain}/localtransfer

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "tovaluedomainuser",
"message": "Give this domain to you."
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"username": "tovaluedomainuser",
"message": "Give this domain to you."
},
"request_id": "20190502412345678"
}

ドメイン無料ネームサーバー

ドメイン無料ネームサーバー　情報（一覧）取得・新規作成・変更・削除

無料ネームサーバーの情報一覧取得

リクエスト

GET /freedns

概要

アカウントで管理している無料ネームサーバーの情報一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /freedns

API本番用

https://api.value-domain.com/v1/freedns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999998,
"domainname": "example.com",
"records": "xxxxxxxx",
"ttl": "120"
},
{"domainid": 9999999,
"domainname": "example2.com",
"records": "xxxxxxxxxx",
"ttl": "3600"
}
],
"request_id": "20190502412345678"
}

無料ネームサーバーの情報取得

リクエスト

GET /freedns/{domain}

概要

アカウントで管理している無料ネームサーバーの情報取得

※ domainは「登録済み無料ネームサーバーの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメイン無料ネームサーバーの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /freedns/{domain}

API本番用

https://api.value-domain.com/v1/freedns/{domain}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
},
"request_id": "20190502412345678"
}

無料ネームサーバーの新規登録

リクエスト

POST /freedns

概要

無料ネームサーバーの新規作成

注意

他社管理ドメインをバリュードメインのネームサーバーで使用するための仮登録を行います。
認証方法を選択し仮登録を行った後、本登録が必要となります。
ネームサーバーの設定マニュアルはこちら

Authorizations:

bearerAuth

Request Body schema: application/json

ドメイン情報

sld	string セカンドレベルドメイン
tld	string トップレベルドメイン
auth	string ドメイン所有者の認証方法 TXTレコード認証メール認証ウェブ認証ネームサーバー認証 (e.g RFD_TXT RFD_MAIL RFD_WEB RFD_NS)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

post /freedns/{domain}

API本番用

https://api.value-domain.com/v1/freedns/{domain}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"sld": "example",
"tld": "com",
"auth": "RFD_TXT"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
},
"request_id": "20190502412345678"
}

無料ネームサーバー DNS設定の変更

リクエスト

PUT /freedns/{domain}

概要

無料ネームサーバーのDNS設定の変更

※ domainは「登録済み無料ネームサーバーの一覧取得API」から取得します

domainId と domainNameのどちらでも可

注意

ns_type:valuedomain1 のみ対応

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメイン無料ネームサーバーの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

records	string DNSレコードレコードごとに改行区切りタイプターゲット内容
ttl	integer TTL

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /freedns/{domain}

API本番用

https://api.value-domain.com/v1/freedns/{domain}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"records": "a * 133.130.104.122\nmx @ 10\ntxt @ v=spf1 ip4:133.130.104.111 ~all",
"ttl": "1200"
},
"request_id": "20190502412345678"
}

無料ネームサーバーの削除

リクエスト

DELETE /freedns/{domain}

概要

アカウントで管理している無料ネームサーバーをアカウントから削除します。

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメイン無料ネームサーバーの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

delete /freedns/{domain}

API本番用

https://api.value-domain.com/v1/freedns/{domain}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com"
},
"request_id": "20190502412345678"
}

ドメイン無料ネームサーバー/所有権（ユーザー間移動）

ドメイン無料ネームサーバーの所有権（ユーザー間移動）　情報（一覧）取得・変更

ドメイン無料ネームサーバーの所有権情報の一覧取得

リクエスト

GET /freedns/localtransfer

概要

ドメイン無料ネームサーバーの所有権情報の一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /freedns/localtransfer

API本番用

https://api.value-domain.com/v1/freedns/localtransfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"domainid": 9999999,
"domainname": "example.com",
"username": "valuedomainuser"
}
],
"request_id": "20190502412345678"
}

ドメイン無料ネームサーバーの所有権情報の取得

リクエスト

GET /freedns/{domain}/localtransfer

概要

ドメイン無料ネームサーバーの所有権情報の取得

※ domainは「登録済みドメイン無料ネームサーバーの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメイン無料ネームサーバーの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /freedns/{domain}/localtransfer

API本番用

https://api.value-domain.com/v1/freedns/{domain}/localtransfer

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"username": "valuedomainuser"
},
"request_id": "20190502412345678"
}

ドメイン無料ネームサーバーの所有権の変更（ユーザー間移動）

リクエスト

PUT /freedns/{domain}/localtransfer

概要

ドメイン無料ネームサーバーの所有権の変更（ユーザー間移動）

※ domainは「登録済みドメイン無料ネームサーバーの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:

bearerAuth

path Parameters

domain

required

string

「登録済みドメイン無料ネームサーバーの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Request Body schema: application/json

ドメイン無料ネームサーバー所有権の変更（ユーザー間移動）

username	string 変更先のユーザー名 (e.g. tovaluedomainuser)
message	string 変更先のユーザーへ表示するメッセージ (e.g. Give this domain to you.)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

put /freedns/{domain}/localtransfer

API本番用

https://api.value-domain.com/v1/freedns/{domain}/localtransfer

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "tovaluedomainuser",
"message": "Give this domain to you."
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"domainid": 9999999,
"domainname": "example.com",
"username": "tovaluedomainuser",
"message": "Give this domain to you."
},
"request_id": "20190502412345678"
}

ドメイン空き状況検索

リクエスト

GET /domainsearch

概要

ドメイン空き状況検索

query Parameters

domainnames

required

string

ドメイン名（カンマ区切りで複数入力可能）
※日本語ドメインはPunyCodeで入力
(e.g. example.com,example2.com,.xn--r8jqs6k2dyb.com)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domainsearch

API本番用

https://api.value-domain.com/v1/domainsearch

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"domainname": "example.com",
"sld": "string",
"tld": "string",
"status": "211 Domain name not available"
}
],
"request_id": "20190502412345678"
}

APIログ

APIログ　情報（一覧）取得

APIログの一覧取得

リクエスト

GET /logs

概要

APIログの一覧取得

Authorizations:

bearerAuth

query Parameters

limit	integer 取得件数
page	integer ページ番号
order	string 並び順 ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /logs

API本番用

https://api.value-domain.com/v1/logs

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"paging": 
{"max": 0,
"limit": 0,
"page": 0
},
"results": 
[
{"request_id": "2019xxxxxxxxxxxxxxxxxxxxxxxV",
"datetime": "2019-10-31 16:56:06",
"method": "POST",
"path": "/v1/freedns",
"request": "",
"response": "",
"addr": "xxx.xxx.xxx.xxx"
}
],
"request_id": "20190502412345678"
}

APIログの取得

リクエスト

GET /logs/{request_id}

概要

APIログの取得

Authorizations:

bearerAuth

path Parameters

request_id

required

string

「APIログの一覧の取得」APIから取得

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /logs/{request_id}

API本番用

https://api.value-domain.com/v1/logs/{request_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
{"request_id": "2019xxxxxxxxxxxxxxxxxxxxxxxV",
"datetime": "2019-10-31 16:56:06",
"method": "POST",
"path": "/v1/freedns",
"request": "",
"response": "",
"addr": "xxx.xxx.xxx.xxx"
},
"request_id": "20190502412345678"
}