mTLS API

This feature is part of VTEX Shield. If you're already a VTEX client and would like to adopt VTEX Shield for your business, contact our Commercial Support. Additional fees may apply. If you're not a VTEX client yet but are interested in this solution, please complete our contact form.

The Mutual Transport Layer Security (mTLS) API enables merchants to manage SSL certificates for mutual TLS authentication with VTEX services. This API supports the creation and revocation of certificates signed by VTEX's internal Certificate Authority (CA).

With this API you can:

• Generate signed certificates for merchant applications.
• Revoke certificates that are no longer needed or have been compromised.

Start here: Check out our complete guide to implementing mTLS.

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