Ihr Browser lässt keine Web-Fonts zu. Unsere Webseiten nutzen Web-Fonts basierte Icons. Um unseren Service zu verbessern, erlauben Sie bitte Ihrem Browser Web-Fonts zu benutzen.
Wir stellen ein!
Deutsch | English | Español

2.4. Certificate

The certificate object provides methods to manage (create, update, cancel etc.) your SSL certificates.

2.4.1. certificate.cancel

Cancel pending certificate requests

2.4.1.1. Input

Table 2.36. Parameters

ParameterDescriptionTypeRequiredDefault
certificateIdID of the certificate int true 

2.4.1.2. Output

No additional return parameters

2.4.2. certificate.create

Order a certificate

2.4.2.1. Input

Table 2.37. Parameters

ParameterDescriptionTypeRequiredDefault
productIdID of the product to be purchased int true 
csrCertificate signing request (CSR) text false 
periodTerm of the certificate (1 or 2 years) int false1
validationEmailEmail address used to verify, that the user has control over the domain, which is specified in the CSR email false 
ownercContact ID of the owner of the certificate int false 
admincContact ID to use as admin int false 
techcContact ID to use as tech int false 
numberOfSanMaximum number of SAN to be purchased (if no value is specified, freeSanIncluded of product will be set) int false0
testingExecute order in testing mode (no order will be submitted) boolean falsefalse

2.4.2.2. Output

Table 2.38. Parameters

ParameterDescriptionTypeOptional
certificateIdID of the certificate int  
statusStatus of the certificate text255  
priceTotal price of the certificate with SAN and included VAT int  
missingThe remaining values ​​needed to complete the order. Use the updateorder function to deliver the remaining values array_text  

2.4.3. certificate.getProduct

Get info about a product

2.4.3.1. Input

Table 2.39. Parameters

ParameterDescriptionTypeRequiredDefault
productIdID of the product int true 

2.4.3.2. Output

Table 2.40. Parameters

ParameterDescriptionTypeOptional
idID of the product int  
nameName of the product text255  
brandBrand of the product text255  
descriptionProduct description int  
typeCertificate type (DV, OV, EV) text255  
sanNumber of SAN, that can be purchased with this product int  
freeSanIncludedNumber of free SAN int  
wildcardIndicates if a product is a wildcard certificate boolean  
issuanceTimeIssuance time until certificate is available text255  
issuanceTimeUnitTime unit of the issuance time text255  
warrantyThis is the highest possible amount of financial reimbursement to a client when a certificate is issued to an unauthorised party, leading to financial loss for the client int  
warrantyCurrencyCurrency of the warranty text255  
freeReissueIndicates whether a reissue of the certificate is free bool  
price1yearPrice of the certificate for a 1 year term (without VAT) float  
price2yearPrice of the certificate for a 2 year term (without VAT) float  
currencyCurrency of the prices text255  
pricePerSan1YearPrice per SAN for a 1 year term float  
pricePerSan2YearPrice of per SAN for a 2 year term float  

2.4.4. certificate.info

Info about a purchased certificate

2.4.4.1. Input

Table 2.41. Parameters

ParameterDescriptionTypeRequiredDefault
certificateIdID of the certificate int true 

2.4.4.2. Output

Table 2.42. Parameters

ParameterDescriptionTypeOptional
idID of the certificate int  
productIdID of the product int  
creationDateDate of the creation of the order datetime  
expirationDateExpiration date of the certificate datetime  
updatedAtDate of the last update of the certificate datetime  
periodTerm of the certificate (1 or 2 years) int  
csrCertificate signing request (CSR) text  
certificateSSL Certificate text  
caChainRoot and intermediate certificates of the CA text  
validationEmailEmail address used to verify, that the user has control over the domain, which is specified in the CSR email  
ownercContact ID of the owner of the certificate int  
admincContact ID to use as admin int  
techcContact ID to use as tech int  
statusStatus of the certificate text255  
commonNameMain domain of the certificate specified in CSR array_text  
numberOfSanMaximum number of SAN (specified in CSR) you can use int  
activeIndicates if the certificate is usable boolean  
nameName of the product text255  
brandBrand of the product text255  
typeCertificate type (DV, OV, EV) text255  

2.4.5. certificate.list

Get a list of all your purchased certificates

2.4.5.1. Input

Table 2.43. Parameters

ParameterDescriptionTypeRequiredDefault
showInactiveShould inactive certificates be listed too? bool falsefalse
ownercFilter by owner handle ID text255 false 
admincFilter by admin handle ID text255 false 
techcFilter by tech handle ID text255 false 
validationEmailFilter by validationEmail text255 false 
statusFilter by status text255 false 
commonNameFilter by commonName text255 false 
sortColumnSort result according to a specified column text255 false 
orderSort the specified column in ascending (ASC) or descending (DESC) order text255 false 

2.4.5.2. Output

Table 2.44. Parameters

ParameterDescriptionTypeOptional
idID of the certificate int  
productIdID of the product int  
creationDateDate of the creation of the order datetime  
expirationDateExpiration date of the certificate datetime  
updatedAtDate of the last update of the certificate datetime  
periodTerm of the certificate (1 or 2 years) int  
csrCertificate signing request (CSR) text  
certificateSSL Certificate text  
caChainRoot and intermediate certificates of the CA text  
validationEmailEmail address used to verify, that the user has control over the domain, which is specified in the CSR email  
ownercContact ID of the owner of the certificate int  
admincContact ID to use as admin int  
techcContact ID to use as tech int  
statusStatus of the certificate text255  
commonNameMain domain of the certificate specified in CSR array_text  
numberOfSanMaximum number of SAN (specified in CSR) you can use int  
activeIndicates if the certificate is usable boolean  
nameName of the product text255  
brandBrand of the product text255  
typeCertificate type (DV, OV, EV) text255  

2.4.6. certificate.listProducts

Get a list of all certificate-products with prices

2.4.6.1. Input

Table 2.45. Parameters

ParameterDescriptionTypeRequiredDefault
nameName of the product text255 false 
brandBrand of the product text255 false 
typeCertificate type (DV, OV, EV) text255 false 
wildcardIndicates if a product is a wildcard certificate boolean false 
sortColumnSort result according to a specified column text255 false 
orderSort the specified column in ascending (ASC) or descending (DESC) order text255 false 

2.4.6.2. Output

Table 2.46. Parameters

ParameterDescriptionTypeOptional
idID of the product int  
nameName of the product text255  
brandBrand of the product text255  
descriptionProduct description int  
typeCertificate type (DV, OV, EV) text255  
sanNumber of SAN, that can be purchased with this product int  
freeSanIncludedNumber of free SAN int  
wildcardIndicates if a product is a wildcard certificate boolean  
issuanceTimeIssuance time until certificate is available text255  
issuanceTimeUnitTime unit of the issuance time text255  
warrantyThis is the highest possible amount of financial reimbursement to a client when a certificate is issued to an unauthorised party, leading to financial loss for the client int  
warrantyCurrencyCurrency of the warranty text255  
freeReissueIndicates whether a reissue of the certificate is free bool  
price1yearPrice of the certificate for a 1 year term (without VAT) float  
price2yearPrice of the certificate for a 2 year term (without VAT) float  
currencyCurrency of the prices text255  
pricePerSan1YearPrice per SAN for a 1 year term float  
pricePerSan2YearPrice of per SAN for a 2 year term float  

2.4.7. certificate.listRemainingNeededData

List missing data for completing a specified request

2.4.7.1. Input

Table 2.47. Parameters

ParameterDescriptionTypeRequiredDefault
certificateIdID of the certificate int true 

2.4.7.2. Output

Table 2.48. Parameters

ParameterDescriptionTypeOptional
certificateIdID of the certificate text  
missingArray of missing values for requesting certificate (csr, validationEmail, ownerc, adminc, techc) array_text  

2.4.8. certificate.log

Request log of all certificates or of a specific certificate.

2.4.8.1. Input

Table 2.49. Parameters

ParameterDescriptionTypeRequiredDefault
certificateIdID of the certificate int false 

2.4.8.2. Output

Table 2.50. Parameters

ParameterDescriptionTypeOptional
certificateIdID of the certificate int  
commonNameMain domain of the certificate specified in CSR array_text  
creationDateDate of the creation of log entry datetime  
statusStatus of the certificate text255  
priceTotal price of the certificate with SAN and included VAT float  
nettoTotal price of the certificate with SAN and no included VAT float  
vatYour Value added tax percentage float  
statusDetailsDetails of certificate status text1024  
nameName of the product text255  
brandBrand of the product text255  

2.4.9. certificate.updateOrder

Submit missing information of your certificate request.

2.4.9.1. Input

Table 2.51. Parameters

ParameterDescriptionTypeRequiredDefault
certificateIdID of the certificate int true 
csrCertificate signing request (CSR) text false 
validationEmailEmail address used to verify, that the user has control over the domain, which is specified in the CSR email false 
ownercContact ID of the owner of the certificate int false 
admincContact ID to use as admin int false 
techcContact ID to use as tech int false 

2.4.9.2. Output

Table 2.52. Parameters

ParameterDescriptionTypeOptional
certificateIdID of the certificate int  
statusStatus of the certificate text255  
missingThe remaining values ​​needed to complete the order. Use the updateorder function to deliver the remaining values array_text