GET/partners/customers/{domainId}/upgrade-domain

アップグレードするドメインを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/upgrade-domain

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domain string 

アップグレード後のドメイン名

 
isActiveDomain boolean 

ドメイン所有権有効フラグ


default : false 
cnameHost string 

CNMAE ホスト名

 
cnameTarget string 

CNAM E 対象

 
txtHost string 

TXT ホスト名

 
txtToken string 

TXT トークン

 
mxRecordHost string 

MX record ホスト名

 
mxRecordValue object (mxRecordValue) 

MX record 値

 

mxRecordValue

PropertyTypeDescription
priority10 string 

優先順位 10

 
priority20 string 

優先順位 20

 

Response Example

example

1{2  "domain": "example.com",3  "isActiveDomain": true,4  "cnameHost": "XXXXXXXXXXXX",5  "cnameTarget": "XXXXXXXXXXXX",6  "txtHost": "XXXXXXXXXXXX",7  "txtToken": "XXXXXXXXXXXX",8  "mxRecordHost": "XXXXXXXXXXXX",9  "mxRecordValue": {10    "priority10": "XXXXXXXXXXXX",11    "priority20": "XXXXXXXXXXXX"12  }13}