The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MutualTlsAuthenticationInput",
"title": "MutualTlsAuthenticationInput",
"type": "object",
"properties": {
"truststoreUri": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."
}
]
},
"truststoreVersion": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket"
}
]
}
},
"description": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API."
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.