The certificate object provides methods to manage (create, update, cancel etc.) your SSL certificates.
Cancel pending certificate requests
Table 2.47. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate | int | true |
Order a certificate
Table 2.48. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
productId | ID of the product to be purchased | int | true | |
csr | Certificate signing request (CSR) | text | false | |
commonName | Main domain of the certificate | text255 | false | |
period | Term of the certificate (1 or 2 years) | int | false | 1 |
validationEmail | Email address used to verify, that the user has control over the domain, which is specified in the CSR | false | ||
ownerc | Contact ID of the owner of the certificate | int | false | |
adminc | Contact ID to use as admin | int | false | |
techc | Contact ID to use as tech | int | false | |
numberOfSan | Maximum number of SAN to be purchased (if no value is specified, freeSanIncluded of product will be set) | int | false | 0 |
hosting | Indicates, if the certificate is bought together with a hosting package | boolean | false | false |
autorenew | Should autorenew be activated? | boolean | false | |
testing | Execute order in testing mode (no order will be submitted) | boolean | false | false |
Table 2.49. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
certificateId | ID of the certificate | int | |
status | Status of the certificate | text255 | |
price | Total price of the certificate with SAN and included VAT | int | |
missing | The remaining values needed to complete the order. Use the updateorder function to deliver the remaining values | array_text |
Get info about a product
Table 2.51. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
id | ID of the product | int | |
name | Name of the product | text255 | |
brand | Brand of the product | text255 | |
description | Product description | text255 | |
type | Certificate type (DV, OV, EV) | text255 | |
san | Number of SAN, that can be purchased with this product | int | |
freeSanIncluded | Number of free SAN | int | |
wildcard | Indicates if a product is a wildcard certificate | boolean | |
issuanceTime | Issuance time until certificate is available | text255 | |
issuanceTimeUnit | Time unit of the issuance time | text255 | |
warranty | This 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 | |
warrantyCurrency | Currency of the warranty | text255 | |
freeReissue | Indicates whether a reissue of the certificate is free | boolean | |
price1year | Price of the certificate for a 1 year term (without VAT) | float | |
currency | Currency of the prices | text255 | |
pricePerSan1Year | Price per SAN for a 1 year term | float |
Info about a purchased certificate
Table 2.52. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate | int | true |
Table 2.53. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
id | ID of the certificate | int | |
productId | ID of the product | int | |
creationDate | Date of the creation of the order | dateTime | |
expirationDate | Expiration date of the certificate | dateTime | |
updatedAt | Date of the last update of the certificate | dateTime | |
period | Term of the certificate (1 or 2 years) | int | |
csr | Certificate signing request (CSR) | text | |
certificate | SSL Certificate | text | |
caChain | Root and intermediate certificates of the CA | text | |
validationEmail | Email address used to verify, that the user has control over the domain, which is specified in the CSR | ||
ownerc | Contact ID of the owner of the certificate | int | |
adminc | Contact ID to use as admin | int | |
techc | Contact ID to use as tech | int | |
status | Status of the certificate | text255 | |
commonName | Main domain of the certificate specified in CSR | array_text | |
numberOfSan | Maximum number of SAN (specified in CSR) you can use | int | |
active | Indicates if the certificate is usable | boolean | |
name | Name of the product | text255 | |
brand | Brand of the product | text255 | |
type | Certificate type (DV, OV, EV) | text255 | |
renewedFrom | ID of the predecessor certificate | int | |
hosting | Indicates if hosting option is used | boolean | |
autorenew | Indicates if certificate is renewed automatically | boolean | |
tracenumber | Order reference | text | |
san | SAN included | array_text |
Get a list of all your purchased certificates
Table 2.54. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
showInactive | Should inactive certificates be listed too? | boolean | false | false |
ownerc | Filter by owner handle ID | text255 | false | |
adminc | Filter by admin handle ID | text255 | false | |
techc | Filter by tech handle ID | text255 | false | |
validationEmail | Filter by validationEmail | text255 | false | |
status | Filter by status | text255 | false | |
commonName | Filter by commonName | text255 | false | |
sortColumn | Sort result according to a specified column | text255 | false | |
order | Sort the specified column in ascending (ASC) or descending (DESC) order | text255 | false |
Table 2.55. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
id | ID of the certificate | int | |
productId | ID of the product | int | |
creationDate | Date of the creation of the order | dateTime | |
expirationDate | Expiration date of the certificate | dateTime | |
updatedAt | Date of the last update of the certificate | dateTime | |
csr | Certificate signing request (CSR) | text | |
certificate | SSL Certificate | text | |
caChain | Root and intermediate certificates of the CA | text | |
validationEmail | Email address used to verify, that the user has control over the domain, which is specified in the CSR | ||
ownerc | Contact ID of the owner of the certificate | int | |
adminc | Contact ID to use as admin | int | |
techc | Contact ID to use as tech | int | |
status | Status of the certificate | text255 | |
commonName | Main domain of the certificate specified in CSR | array_text | |
numberOfSan | Maximum number of SAN (specified in CSR) you can use | int | |
active | Indicates if the certificate is usable | boolean | |
hosting | Indicates if certificate is used for hosting | boolean | |
autorenew | Indicates if the certificate will be renewed automatically | boolean | |
name | Name of the product | text255 | |
brand | Brand of the product | text255 | |
type | Certificate type (DV, OV, EV) | text255 |
Get a list of all certificate-products with prices
Table 2.56. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
name | Name of the product | text255 | false | |
brand | Brand of the product | text255 | false | |
type | Certificate type (DV, OV, EV) | text255 | false | |
wildcard | Indicates if a product is a wildcard certificate | boolean | false | |
sortColumn | Sort result according to a specified column | text255 | false | |
order | Sort the specified column in ascending (ASC) or descending (DESC) order | text255 | false |
Table 2.57. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
id | ID of the product | int | |
name | Name of the product | text255 | |
brand | Brand of the product | text255 | |
description | Product description | text255 | |
type | Certificate type (DV, OV, EV) | text255 | |
san | Number of SAN, that can be purchased with this product | int | |
freeSanIncluded | Number of free SAN | int | |
wildcard | Indicates if a product is a wildcard certificate | boolean | |
issuanceTime | Issuance time until certificate is available | text255 | |
issuanceTimeUnit | Time unit of the issuance time | text255 | |
warranty | This 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 | |
warrantyCurrency | Currency of the warranty | text255 | |
freeReissue | Indicates whether a reissue of the certificate is free | boolean | |
price1year | Price of the certificate for a 1 year term (without VAT) | float | |
currency | Currency of the prices | text255 | |
pricePerSan1Year | Price per SAN for a 1 year term | float |
List missing data for completing a specified request
Table 2.58. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate | int | true |
Table 2.59. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
certificateId | ID of the certificate | text | |
missing | Array of missing values for requesting certificate (csr, validationEmail, ownerc, adminc, techc) | array_text |
Request log of all certificates or of a specific certificate.
Table 2.60. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate | int | false |
Table 2.61. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
certificateId | ID of the certificate | int | |
commonName | Main domain of the certificate specified in CSR | array_text | |
creationDate | Date of the creation of log entry | dateTime | |
status | Status of the certificate | text255 | |
price | Total price of the certificate with SAN and included VAT | float | |
netto | Total price of the certificate with SAN and no included VAT | float | |
vat | Your Value added tax percentage | float | |
statusDetails | Details of certificate status | text1024 | |
name | Name of the product | text255 | |
brand | Brand of the product | text255 |
Renew a certificate
Table 2.62. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate to be renewed | int | true | |
csr | Certificate signing request (CSR) | text | false | |
commonName | Main domain of the certificate | text255 | false | |
validationEmail | Email address used to verify, that the user has control over the domain, which is specified in the CSR | false | ||
ownerc | Contact ID of the owner of the certificate | int | false | |
adminc | Contact ID to use as admin | int | false | |
techc | Contact ID to use as tech | int | false | |
numberOfSan | Maximum number of SAN to be purchased (if no value is specified, freeSanIncluded of product will be set) | int | false | 0 |
autorenew | Should autorenew be activated? | boolean | false | |
testing | Execute order in testing mode (no order will be submitted) | boolean | false | false |
Submit missing information of your certificate request.
Table 2.66. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
certificateId | ID of the certificate | int | true | |
csr | Certificate signing request (CSR) | text | false | |
validationEmail | Email address used to verify, that the user has control over the domain, which is specified in the CSR | false | ||
ownerc | Contact ID of the owner of the certificate | int | false | |
adminc | Contact ID to use as admin | int | false | |
techc | Contact ID to use as tech | int | false | |
hosting | Indicates, if the certificate is bought together with a hosting package | boolean | false | false |
autorenew | Should autorenew be activated? | boolean | false |
Table 2.67. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
certificateId | ID of the certificate | int | |
status | Status of the certificate | text255 | |
missing | The remaining values needed to complete the order. Use the updateorder function to deliver the remaining values | array_text |