Available since version 2021.

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

createCAList()


This application is used to create a CA list.


Required parameters:

  • name - a name of the certificate. String.
  • ca_list- value of CA list. String. The value depends on CA list type:
    • base64-encoded CA list in PEM format for 'Uploaded' type
    • path to folder for 'Local Folder' type


Optional parameters:



Returns:

  • result - OK - String.
  • i_ca_list - id of the created CA list. Integer.


  • XMLRPC fault in case of any error.

updateCAList()


This application is used to update an existing CA list.


Required parameters:

  • i_ca_list - id of the updated CA list. Integer.


Optional parameters:

  • name - a name of the certificate. String.
  • i_ca_list_type - type of the CA list. See getSystemDictionary(ca_list_types). Integer.
  • i_ssl_use_domain_type - type of the domain type. See getSystemDictionary(ssl_use_domain_types). Integer. ca_list must be provided. Available starting from Sippy2023
  • ca_list - value of CA list. String. The value depends on CA list type - see createCAList() for details. i_ssl_use_domain_type must be provided.


Returns:

  • result - OK - String.
  • i_ca_list - id of the updated CA list. Integer.


  • XMLRPC fault in case of any error.

deleteCAList()


This application is used to delete an existing CA list.


Required parameters:

  • i_ca_list - id of the deleted CA list. Integer.


Returns:

  • result - OK - String.
  • i_ca_list - id of the deleted CA list. Integer.


  • XMLRPC fault in case of any error.

getCAListInfo()


This application is used to get CA list details.


Required parameters:

  • i_ca_list - id of the CA list. Integer.


Returns:

  • result - OK - String.
  • ca_list - detailed info of the CA list. Structure.


  • XMLRPC fault in case of any error.

getCAListsList()


This application is used to get CA lists 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.



Returns:

  • result - OK - String.
  • ca_lists - list of detailed entries as getCAListInfo returns. Array.


  • XMLRPC fault in case of any error.