Available since version 2021.


All applications bellow support trusted mode, i_customer = 1 should be supplied in that mode.


createSSLCertificate()


This application is used to create an SSL certificate.


Required parameters:

  • name - a name of the certificate. String.
  • common_name - common name (CN) of the certificate. String.


Optional parameters:

  • i_ssl_certificate_type - type of the certificate. See getSystemDictionary(ssl_certificate_types). Integer. Default is 'Upload Own'.
  • alt_dns_names - Subject Alternative Names of the certificate. Array of strings.
  • certificate - base64-encoded SSL certificate in PEM format. String.
  • key - base64-encoded private key in PEM format. String.
  • i_environment - create the certificate in i_environment environment. Integer.



Returns:

  • result - OK - String.
  • i_ssl_certificate - id of the created certificate. Integer.
  • relay_result - result of relayed request, included only when the certificate is created in another environment. Structure.


  • XMLRPC fault in case of any error.


A table with match for required and optional parameters based on i_ssl_certificate_type



Upload OwnLets Encrypt
nameMandatoryMandatory
common_nameMandatoryMandatory
i_ssl_certificate_typeOptionalMandatory
alt_dns_namesOptionalOptional
certificateMandatoryOptional
keyMandatoryOptional
i_environmentOptionalOptional

updateSSLCertificate()


This application is used to update an existing SSL certificate.


Required parameters:

  • i_ssl_certificate - id of the updated certificate. Integer.


Optional parameters:

  • name - a name of the certificate. String.
  • common_name - common name (CN) of the certificate. String.
  • i_ssl_certificate_type - type of the certificate. See getSystemDictionary(ssl_certificate_types). Integer.
  • alt_dns_names - Subject Alternative Names of the certificate. Array of strings.
  • certificate - base64-encoded SSL certificate in PEM format. String.
  • key - base64-encoded private key in PEM format. String.
  • i_environment - update the certificate in i_environment environment. Integer.



Returns:

  • result - OK - String.
  • i_ssl_certificate - id of the updated certificate. Integer.
  • relay_result - result of relayed request, included only when the certificate is updated in another environment. Structure.


  • XMLRPC fault in case of any error.

deleteSSLCertificate()


This application is used to delete an existing SSL certificate.


Required parameters:

  • i_ssl_certificate - id of the updated certificate. Integer.


Optional parameters:

  • i_environment - delete the certificate in i_environment environment. Integer.



Returns:

  • result - OK - String.
  • i_ssl_certificate - id of the deleted certificate. Integer.
  • relay_result - result of relayed request, included only when the certificate is deleted in another environment. Structure.


  • XMLRPC fault in case of any error.

getSSLCertificateInfo()


This application is used to get SSL certificate details.


Required parameters:

  • i_ssl_certificate - id of the certificate. Integer.


Optional parameters:

  • i_environment - get the certificate in i_environment environment. Integer.



Returns:

  • result - OK - String.
  • ssl_certificate - detailed info of the certificate. Structure.
  • relay_result - result of relayed request, included only when the requested certificate is in another environment. Structure.


  • XMLRPC fault in case of any error.

getSSLCertificatesList()


This application is used to get SSL certificates list.


Optional parameters:

  • name_pattern - Pattern to filter certificates by name (SQL syntax for ILIKE operator is used). String.
  • limit - Limit result by limit entries. Integer.
  • offset - Skip first offset entries in result. Integer.
  • i_environment - get the certificate in i_environment environment. Integer.



Returns:

  • result - OK - String.
  • ssl_certificates - list of detailed entries as getSSLCertificateInfo returns. Array.
  • relay_result - result of relayed request, included only when the requested certificates a in another environment. Structure.


  • XMLRPC fault in case of any error.