Skip to main content

Domain

Attributes

NameTypeDescription
namestringDomain name
authority_namestringAuthority name
customer_idintegerDomain customer ID
statusstringSee Glossary - Domain Status
validation_methodstringSee Glossary - Domain Control Validation Method
valid_untilstringValidation valid until
dcvobjectSee DCV

Relationships

NameResource typeDescription
organizationorganization(optional) Organization related to this domain

DCV

NameTypeDescription
statusstringSee Glossary - DCV Status
tokenstringDCV token (in VALIDATE_DNS, VALIDATE_DNS_CNAME, VALIDATE_HTTP)
expires_atstringDCV expiration date (in VALIDATE_DNS, VALIDATE_DNS_CNAME, VALIDATE_HTTP)
created_atstringDCV creation date
verification_valuestringURL verification CNAME (in VALIDATE_DNS_CNAME)
name_scopestringEmail scope domain (in VALIDATE_EMAIL)
base_emailsarrayEmails addresses approval (in VALIDATE_EMAIL)
token_urlstringURL token (in VALIDATE_HTTP)

Sample

{
"data": {
"type": "domain",
"id": "ABC012",
"links": {
"self": "https://api.nameshield.net/ssl/v2/domains/ABC012"
},
"attributes": {
"name": "test.fr",
"authority_name": "Digicert",
"customer_id": 9954,
"status": "active",
"validation_method": "VALIDATE_DNS",
"valid_until": "2023-06-07T08:57:25.000000Z",
"dcv": {
"status": "complete",
"token": "zijfoizjefjoz",
"expires_at": "2023-06-07T08:57:25.000000Z",
"created_at": "2023-06-07T08:57:25.000000Z"
}
},
"relationships": {
"organization": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/domains/ABC012/organization"
},
"data": {
"type": "organization",
"id": "ABC012"
}
}
}
}
}