ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

Certificates

Certificates.add

add new ssl-certificate entry for given domain by either id or domainname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the domain-id
domainnamestringoptional, the domainname
ssl_cert_filestring
ssl_key_filestring
ssl_ca_filestringoptional
ssl_cert_chainfilestringoptional

Response

string as json-encoded array

Certificates.update

update ssl-certificate entry for given domain by either id or domainname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the domain-id
domainnamestringoptional, the domainname
ssl_cert_filestring
ssl_key_filestring
ssl_ca_filestringoptional
ssl_cert_chainfilestringoptional

Response

string as json-encoded array

Certificates.listing

lists all certificate entries

Permission

admin customer

Parameter

FieldTypeDescription
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

Certificates.get

return ssl-certificate entry for given domain by either id or domainname

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the domain-id
domainnamestringoptional, the domainname

Response

string as json-encoded array

Certificates.listingCount

returns the total number of certificates for the given user

Permission

admin customer

Response

string as json-encoded response message

Certificates.delete

delete certificates entry by id

Parameter

FieldTypeDescription
idint

Response

string as json-encoded array