Certificate
Attributes
| Name | Type | Description |
|---|---|---|
| status | string | See Glossary - Certificate Status |
| common_name | string | Certificate common name |
| sans | array | Certificate SANs |
| serial | string | Certificate serial ID |
| customer_id | integer | Certificate customer ID |
| validity_start | string | Certificate validity start date |
| validity_end | string | Certificate validity end date |
| csr | string | (hidden) Certificate order CSR |
| x509 | string | (hidden) Certificate X.509 |
| cacert_inter | string | (hidden) Certificate chain intermediate certificate (X.509) |
| cacert_root | string | (hidden) Certificate chain root certificate (X.509) |
| pem | string | (hidden) Certificate chain in PEM format |
| pkcs12 | string | (hidden) Certificate chain in PKCS#12 format (base64 encoded, encrypted with passphrase) |
| pkcs7 | string | (hidden) Certificate chain in PKCS#7 format (base64 encoded) |
tip
For (hidden) attributes, see Introduction - Fields
Relationships
| Name | Resource type | Description |
|---|---|---|
| product | product | Product with which this certificate was ordered |
| organization | organization | Organization related to this certificate |
| contacts | contact (list) | Contacts related to this certificate. (meta.contact_type add context to the relationship) |
| comments | comment (list) | Comments on this certificate |
| current-order | order | (optional) Order currently related to this certificate (eg: reissue, renew) |
Sample
{
"data": {
"type": "certificate",
"id": "ABC012",
"links": {
"self": "https://api.nameshield.net/ssl/v2/certificates/ABC012"
},
"attributes": {
"status": "active",
"common_name": "donnelly.com",
"sans": [
"dolorem.donnelly.com"
],
"serial": "263ED182F7FB230E0AD3DDAEA3DF7D88",
"customer_id": 9954,
"validity_start": "2023-03-28",
"validity_end": "2024-03-28"
},
"relationships": {
"organization": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/certificates/ABC012/organization"
},
"data": {
"type": "organization",
"id": "ABC012"
}
},
"comments": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/certificates/ABC012/comments"
},
"data": [
{
"type": "comment",
"id": "ABC012"
}
]
},
"product": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/certificates/ABC012/product"
},
"data": {
"type": "product",
"id": "1"
}
},
"contacts": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/certificates/ABC012/contacts"
},
"data": [
{
"type": "contact",
"id": "ABC012",
"meta": {
"contact_type": "admin"
}
},
{
"type": "contact",
"id": "ABC012",
"meta": {
"contact_type": "tech"
}
}
]
},
"current-order": {
"links": {
"related": "https://api.nameshield.net/ssl/v2/certificates/ABC012/current-order"
},
"data": {
"type": "order",
"id": "ABC012"
}
}
}
}
}