Domain
Attributes
| Name | Type | Description |
|---|---|---|
| name | string | Domain name |
| authority_name | string | Authority name |
| customer_id | integer | Domain customer ID |
| status | string | See Glossary - Domain Status |
| validation_method | string | See Glossary - Domain Control Validation Method |
| valid_until | string | Validation valid until |
| dcv | object | See DCV |
Relationships
| Name | Resource type | Description |
|---|---|---|
| organization | organization | (optional) Organization related to this domain |
DCV
| Name | Type | Description |
|---|---|---|
| status | string | See Glossary - DCV Status |
| token | string | DCV token (in VALIDATE_DNS, VALIDATE_DNS_CNAME, VALIDATE_HTTP) |
| expires_at | string | DCV expiration date (in VALIDATE_DNS, VALIDATE_DNS_CNAME, VALIDATE_HTTP) |
| created_at | string | DCV creation date |
| verification_value | string | URL verification CNAME (in VALIDATE_DNS_CNAME) |
| name_scope | string | Email scope domain (in VALIDATE_EMAIL) |
| base_emails | array | Emails addresses approval (in VALIDATE_EMAIL) |
| token_url | string | URL 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"
}
}
}
}
}