On this page

Enforced TLS

The Enforced TLS settings specify whether or not the recipient is required to support TLS or have a valid certificate. The Enforced TLS endpoint supports retrieving and updating TLS settings.

(error)

Danger

If either require_tls or require_valid_cert is set to true, the recipient must support TLS 1.1 or higher or have a valid certificate. If these conditions are not met, we drop the message and send a block event with "TLS required but not supported" as the description.

GET

Get the current Enforced TLS settings.

Request URL

GET https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1

Response

1HTTP/1.1 200
2{
3    "require_tls": true,
4    "require_valid_cert": false,
5    "version": 1.1
6}

PATCH

Change the Enforced TLS settings

URI Parameter	Required	Requirements	Description
require_tls	False	true or false	Require recipient TLS support
require_valid_cert	False	true or false	Require certificates to be valid
version	False	1.1, 1.2, 1.3	The minimum required TLS certificate version.

Request URL

PATCH https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1

Request Body

1{
2  "require_tls": true
3}

Response

1HTTP/1.1 200
2{
3    "require_tls": true,
4    "require_valid_cert": false,
5    "version": 1.1
6}