This feature is part of VTEX Shield. If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact Commercial Support. Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our contact form.
By default, VTEX uses SSL certificates issued by Let's Encrypt, an open-source solution widely adopted in the market. This approach guarantees security, reliability, and compatibility with most browsers.
However, some stores require custom SSL certificates for specific compliance reasons, internal security requirements, or certification entities that offer additional warranties.
To meet this requirement, the SSL Certificates page allows you to install a new custom SSL certificate and manage existing certificates.
The page displays the following information in a table:
Columns | Description |
---|---|
Domain | Host address, consisting of subdomain, domain and top-level domain. For example: www.mystore.com. Learn more about the structure of this address in Configuring the store domain. |
CA | Certificate Authority. |
Installed on | Date the certificate was installed. |
Expires on | Date the certificate expires. |
Status | Certificate status, which can be:
|
Prerequisites
Before installing a custom certificate, the following requirements must be met:
-
Be a user associated with a role from the License Manager resources listed below to view and manage the information on the page:
- Product: CDN API
- Category: Certificate management
- Resources: Update certificate and View certificate
-
Have a
.KEY
file with the certificate private key up to 1 MB saved on your device. -
Have a
.CRT
file with the certificate up to 1 MB saved on your device.
Installing a new SSL certificate
Follow the instructions below to install a new custom certificate on VTEX:
- In the VTEX Admin, go to Store settings > Shield > SLL Certificates.
- Click
Install new
. - In the Hosts field, select one or more hosts to apply the certificate. Only the hosts previously added to your account will be displayed.
- Under Private key, click
Choose a file
to select a.key
file up to 1 MB saved on your device. - In Certificate, click
Choose a file
to select a.crt
file up to 1 MB saved on your device. - Click
Install
.
If the configuration is successful, you will be redirected to the certificate list page, where you can view the selected hosts.
The installation may take 7 days to complete, and during this time, the status of the hosts will be Installing. After the installation is complete, the status of the hosts will change to Active.
To learn how to resolve installation errors, see the troubleshooting guide ℹ️ Error installing custom SSL certificate.