Skip to main content

Certificate

Attributes

NameTypeDescription
statusstringSee Glossary - Certificate Status
common_namestringCertificate common name
sansarrayCertificate SANs
serialstringCertificate serial ID
customer_idintegerCertificate customer ID
validity_startstringCertificate validity start date
validity_endstringCertificate validity end date
csrstring(hidden) Certificate order CSR
x509string(hidden) Certificate X.509
cacert_interstring(hidden) Certificate chain intermediate certificate (X.509)
cacert_rootstring(hidden) Certificate chain root certificate (X.509)
pemstring(hidden) Certificate chain in PEM format
pkcs12string(hidden) Certificate chain in PKCS#12 format (base64 encoded, encrypted with passphrase)
pkcs7string(hidden) Certificate chain in PKCS#7 format (base64 encoded)
tip

For (hidden) attributes, see Introduction - Fields

Relationships

NameResource typeDescription
productproductProduct with which this certificate was ordered
organizationorganizationOrganization related to this certificate
contactscontact (list)Contacts related to this certificate. (meta.contact_type add context to the relationship)
commentscomment (list)Comments on this certificate
current-orderorder(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"
}
}
}
}
}