TLS Edge Mutual TLS Module

Replace TLS Edge Mutual TLS Module

Request

PUT /edges/tls/{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_2k5oks78Zk3Z9rCzanH3ocuVLpG"],"enabled":true}' \
https://api.ngrok.com/edges/tls/edgtls_2k5okqxiV3BqKj5CMVKND122vqF/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_2k5oks78Zk3Z9rCzanH3ocuVLpG",
			"uri": "https://api.ngrok.com/certificate_authorities/ca_2k5oks78Zk3Z9rCzanH3ocuVLpG"
		}
	],
	"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 TLS Edge Mutual TLS Module

Request

GET /edges/tls/{id}/mutual_tls

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tls/edgtls_2k5okqxiV3BqKj5CMVKND122vqF/mutual_tls

Response

Returns a 200 response on success

Example Response

{
	"certificate_authorities": [
		{
			"id": "ca_2k5oks78Zk3Z9rCzanH3ocuVLpG",
			"uri": "https://api.ngrok.com/certificate_authorities/ca_2k5oks78Zk3Z9rCzanH3ocuVLpG"
		}
	],
	"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 TLS Edge Mutual TLS Module

Request

DELETE /edges/tls/{id}/mutual_tls

Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tls/edgtls_2k5okqxiV3BqKj5CMVKND122vqF/mutual_tls

Response

Returns a 204 response with no body on success