Update
curl --request PATCH \
--url https://api.ngrok.com/reserved_domains/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"certificate_id": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"resolves_to": [
{
"value": "<string>"
}
]
}
'import requests
url = "https://api.ngrok.com/reserved_domains/{id}"
payload = {
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"certificate_id": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"resolves_to": [{ "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>',
certificate_id: '<string>',
certificate_management_policy: {authority: '<string>', private_key_type: '<string>'},
resolves_to: [{value: '<string>'}]
})
};
fetch('https://api.ngrok.com/reserved_domains/{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/reserved_domains/{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>',
'certificate_id' => '<string>',
'certificate_management_policy' => [
'authority' => '<string>',
'private_key_type' => '<string>'
],
'resolves_to' => [
[
'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/reserved_domains/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\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/reserved_domains/{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 \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/reserved_domains/{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 \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"uri": "<string>",
"created_at": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"region": "<string>",
"cname_target": "<string>",
"certificate": {
"id": "<string>",
"uri": "<string>"
},
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
},
"acme_challenge_cname_target": "<string>",
"resolves_to": [
{
"value": "<string>"
}
]
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}Reserved Domains
Update
Update the attributes of a reserved domain.
PATCH
/
reserved_domains
/
{id}
Update
curl --request PATCH \
--url https://api.ngrok.com/reserved_domains/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"certificate_id": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"resolves_to": [
{
"value": "<string>"
}
]
}
'import requests
url = "https://api.ngrok.com/reserved_domains/{id}"
payload = {
"id": "<string>",
"description": "<string>",
"metadata": "<string>",
"certificate_id": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"resolves_to": [{ "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>',
certificate_id: '<string>',
certificate_management_policy: {authority: '<string>', private_key_type: '<string>'},
resolves_to: [{value: '<string>'}]
})
};
fetch('https://api.ngrok.com/reserved_domains/{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/reserved_domains/{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>',
'certificate_id' => '<string>',
'certificate_management_policy' => [
'authority' => '<string>',
'private_key_type' => '<string>'
],
'resolves_to' => [
[
'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/reserved_domains/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\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/reserved_domains/{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 \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/reserved_domains/{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 \"certificate_id\": \"<string>\",\n \"certificate_management_policy\": {\n \"authority\": \"<string>\",\n \"private_key_type\": \"<string>\"\n },\n \"resolves_to\": [\n {\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"uri": "<string>",
"created_at": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"region": "<string>",
"cname_target": "<string>",
"certificate": {
"id": "<string>",
"uri": "<string>"
},
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
},
"acme_challenge_cname_target": "<string>",
"resolves_to": [
{
"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
Update the attributes of a reserved domain.
Was this page helpful?