HTTPS Edge Mutual TLS Module
Replace HTTPS Edge Mutual TLS Module
Request
PUT /edges/https/{id}/mutual_tls
Example Request
curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"certificate_authority_ids":["ca_2gsqMtgyKvyoLUkdfcEv0EhIfXS"],"enabled":true}' \
https://api.ngrok.com/edges/https/edghts_2gsqMs3s6DlGbMVj1TSILPxpWBm/mutual_tls
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
certificate_authority_ids | List<string> | list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection |
Response
Returns a 200 response on success
Example Response
{
"certificate_authorities": [
{
"id": "ca_2gsqMtgyKvyoLUkdfcEv0EhIfXS",
"uri": "https://api.ngrok.com/certificate_authorities/ca_2gsqMtgyKvyoLUkdfcEv0EhIfXS"
}
],
"enabled": true
}
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
certificate_authorities | Ref | PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together. |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Get HTTPS Edge Mutual TLS Module
Request
GET /edges/https/{id}/mutual_tls
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2gsqMs3s6DlGbMVj1TSILPxpWBm/mutual_tls
Response
Returns a 200 response on success
Example Response
{
"certificate_authorities": [
{
"id": "ca_2gsqMtgyKvyoLUkdfcEv0EhIfXS",
"uri": "https://api.ngrok.com/certificate_authorities/ca_2gsqMtgyKvyoLUkdfcEv0EhIfXS"
}
],
"enabled": true
}
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
certificate_authorities | Ref | PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together. |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Delete HTTPS Edge Mutual TLS Module
Request
DELETE /edges/https/{id}/mutual_tls
Example Request
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2gsqMs3s6DlGbMVj1TSILPxpWBm/mutual_tls
Response
Returns a 204 response with no body on success