Update
curl --request PATCH \
--url https://api.ngrok.com/edges/tls/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"hostports": [
"<string>"
],
"backend": {
"enabled": true,
"backend_id": "<string>"
},
"ip_restriction": {
"enabled": true,
"ip_policy_ids": [
"<string>"
]
},
"mutual_tls": {
"enabled": true,
"certificate_authority_ids": [
"<string>"
]
},
"tls_termination": {
"enabled": true,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": true,
"value": "<string>"
}
}
'import requests
url = "https://api.ngrok.com/edges/tls/{id}"
payload = {
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"hostports": ["<string>"],
"backend": {
"enabled": True,
"backend_id": "<string>"
},
"ip_restriction": {
"enabled": True,
"ip_policy_ids": ["<string>"]
},
"mutual_tls": {
"enabled": True,
"certificate_authority_ids": ["<string>"]
},
"tls_termination": {
"enabled": True,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": True,
"value": "<string>"
}
}
headers = {
"ngrok-version": "<ngrok-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'ngrok-version': '<ngrok-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: '<string>',
description: '<string>',
metadata: '<string>',
hostports: ['<string>'],
backend: {enabled: true, backend_id: '<string>'},
ip_restriction: {enabled: true, ip_policy_ids: ['<string>']},
mutual_tls: {enabled: true, certificate_authority_ids: ['<string>']},
tls_termination: {enabled: true, terminate_at: '<string>', min_version: '<string>'},
traffic_policy: {enabled: true, value: '<string>'}
})
};
fetch('https://api.ngrok.com/edges/tls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ngrok.com/edges/tls/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'description' => '<string>',
'metadata' => '<string>',
'hostports' => [
'<string>'
],
'backend' => [
'enabled' => true,
'backend_id' => '<string>'
],
'ip_restriction' => [
'enabled' => true,
'ip_policy_ids' => [
'<string>'
]
],
'mutual_tls' => [
'enabled' => true,
'certificate_authority_ids' => [
'<string>'
]
],
'tls_termination' => [
'enabled' => true,
'terminate_at' => '<string>',
'min_version' => '<string>'
],
'traffic_policy' => [
'enabled' => true,
'value' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"ngrok-version: <ngrok-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ngrok.com/edges/tls/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("ngrok-version", "<ngrok-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ngrok.com/edges/tls/{id}")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/edges/tls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"created_at": "<string>",
"uri": "<string>",
"hostports": [
"<string>"
],
"backend": {
"enabled": true,
"backend": {
"id": "<string>",
"uri": "<string>"
}
},
"ip_restriction": {
"enabled": true,
"ip_policies": [
{
"id": "<string>",
"uri": "<string>"
}
]
},
"mutual_tls": {
"enabled": true,
"certificate_authorities": [
{
"id": "<string>",
"uri": "<string>"
}
]
},
"tls_termination": {
"enabled": true,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": true,
"value": "<string>"
}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}Edges TLS
Update
Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
PATCH
/
edges
/
tls
/
{id}
Update
curl --request PATCH \
--url https://api.ngrok.com/edges/tls/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"hostports": [
"<string>"
],
"backend": {
"enabled": true,
"backend_id": "<string>"
},
"ip_restriction": {
"enabled": true,
"ip_policy_ids": [
"<string>"
]
},
"mutual_tls": {
"enabled": true,
"certificate_authority_ids": [
"<string>"
]
},
"tls_termination": {
"enabled": true,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": true,
"value": "<string>"
}
}
'import requests
url = "https://api.ngrok.com/edges/tls/{id}"
payload = {
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"hostports": ["<string>"],
"backend": {
"enabled": True,
"backend_id": "<string>"
},
"ip_restriction": {
"enabled": True,
"ip_policy_ids": ["<string>"]
},
"mutual_tls": {
"enabled": True,
"certificate_authority_ids": ["<string>"]
},
"tls_termination": {
"enabled": True,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": True,
"value": "<string>"
}
}
headers = {
"ngrok-version": "<ngrok-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'ngrok-version': '<ngrok-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: '<string>',
description: '<string>',
metadata: '<string>',
hostports: ['<string>'],
backend: {enabled: true, backend_id: '<string>'},
ip_restriction: {enabled: true, ip_policy_ids: ['<string>']},
mutual_tls: {enabled: true, certificate_authority_ids: ['<string>']},
tls_termination: {enabled: true, terminate_at: '<string>', min_version: '<string>'},
traffic_policy: {enabled: true, value: '<string>'}
})
};
fetch('https://api.ngrok.com/edges/tls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ngrok.com/edges/tls/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'description' => '<string>',
'metadata' => '<string>',
'hostports' => [
'<string>'
],
'backend' => [
'enabled' => true,
'backend_id' => '<string>'
],
'ip_restriction' => [
'enabled' => true,
'ip_policy_ids' => [
'<string>'
]
],
'mutual_tls' => [
'enabled' => true,
'certificate_authority_ids' => [
'<string>'
]
],
'tls_termination' => [
'enabled' => true,
'terminate_at' => '<string>',
'min_version' => '<string>'
],
'traffic_policy' => [
'enabled' => true,
'value' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"ngrok-version: <ngrok-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ngrok.com/edges/tls/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("ngrok-version", "<ngrok-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ngrok.com/edges/tls/{id}")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/edges/tls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"hostports\": [\n \"<string>\"\n ],\n \"backend\": {\n \"enabled\": true,\n \"backend_id\": \"<string>\"\n },\n \"ip_restriction\": {\n \"enabled\": true,\n \"ip_policy_ids\": [\n \"<string>\"\n ]\n },\n \"mutual_tls\": {\n \"enabled\": true,\n \"certificate_authority_ids\": [\n \"<string>\"\n ]\n },\n \"tls_termination\": {\n \"enabled\": true,\n \"terminate_at\": \"<string>\",\n \"min_version\": \"<string>\"\n },\n \"traffic_policy\": {\n \"enabled\": true,\n \"value\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"created_at": "<string>",
"uri": "<string>",
"hostports": [
"<string>"
],
"backend": {
"enabled": true,
"backend": {
"id": "<string>",
"uri": "<string>"
}
},
"ip_restriction": {
"enabled": true,
"ip_policies": [
{
"id": "<string>",
"uri": "<string>"
}
]
},
"mutual_tls": {
"enabled": true,
"certificate_authorities": [
{
"id": "<string>",
"uri": "<string>"
}
]
},
"tls_termination": {
"enabled": true,
"terminate_at": "<string>",
"min_version": "<string>"
},
"traffic_policy": {
"enabled": true,
"value": "<string>"
}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}Authorizations
Body
application/json
Response
Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
Was this page helpful?