Skip to contentSkip to navigationSkip to topbar
Rate this page:
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 page anchor

Get the current Enforced TLS settings.

Request URL

request-url page anchor

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


_10
HTTP/1.1 200
_10
{
_10
"require_tls": true,
_10
"require_valid_cert": false,
_10
"version": 1.1
_10
}


Change the Enforced TLS settings

URI ParameterRequiredRequirementsDescription
require_tlsFalsetrue or falseRequire recipient TLS support
require_valid_certFalsetrue or falseRequire certificates to be valid
versionFalse1.1, 1.2, 1.3The minimum required TLS certificate version.

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


_10
{
_10
"require_tls": true
_10
}


_10
HTTP/1.1 200
_10
{
_10
"require_tls": true,
_10
"require_valid_cert": false,
_10
"version": 1.1
_10
}


Rate this page: