SSL Certificates

(ms.ssl_certificates)

SSL(Secure Sockets Layer) is the standard security technology for establishing an encrypted link between a web server and a browser. This link ensures that all data passed between the web server and browsers remain private and integral.



Fields

ValueDescription
domain   
Type: string
Required
The valid domain name on which you want to SSL.
type   
Type: string
Required
Define the type of SSL you want. It can either be Custom SSL or StoreHippo SSL.
email   
Type: string
Required
A valid email id related to that domain.
ssl_key   
Type: string
Required
This field is displayed when custom SSL is selected. SSL key of the domain is provided here.
ssl_certificate   
Type: string
Required
This field is displayed when custom SSL is selected. SSL certificate of your domain which you will get from your domain provider is provided here.
active   
Type: string
status   
Type: string
It defines the status of the SSL certificate configured on the domain.
secure_redirect   
Type: string
It stores if the HTTP is redirected to HTTPS to make the store URL secure.

Commands (Endpoints)

POST /api/1/entity/ms.ssl_certificates   
Creates a new ssl certificate
DEL /api/1/entity/ms.ssl_certificates/{resource_id}   
Deletes a ssl certificate
PUT /api/1/entity/ms.ssl_certificates/{resource_id}   
Updates an existing ssl certificate
GET /api/1/entity/ms.ssl_certificates/{resource_id}   
Retrieves a single ssl certificate
GET /api/1/entity/ms.ssl_certificates   
Retrieves a list of ssl certificates