SSL Certificates API
The SSL Certificates API allows VTEX users to programmatically manage SSL certificates for their store domains. It enables users to list all installed certificates and install or renew certificates using JSON or multipart form data.
The API provides detailed metadata about each certificate, including issuer, subject, validity period, installation status, and more. This helps ensure secure HTTPS connections for custom domains, automating certificate lifecycle management and supporting integration with external certificate authorities or automation tools.
Learn more about Custom SSL certificates.
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.
Index
SSL Certificates
Common parameters
| Parameter name | Description | Type |
|---|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. | Server variable |
{{environment}} |
Environment to use. Used as part of the URL. The default value is vtexcommercestable. |
Server variable |
X-VTEX-API-AppKey |
Unique identifier of the API key. | Authentication header |
X-VTEX-API-AppToken |
Secret token of the API key. | Authentication header |
VtexIdclientAutCookie |
User token, valid for 24 hours. | Authentication header |
Endpoints
SSL Certificates
| Summary | Method | Path |
|---|---|---|
| List SSL certificates | GET | /api/edge/certificates |
| Install or renew SSL certificate | PUT | /api/edge/certificates |
| Get SSL certificate by ID | GET | /api/edge/certificates/{certificateId} |