Create
curl --request POST \
--url https://api.ngrok.com/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"url": "<string>",
"type": "<string>",
"traffic_policy": "<string>",
"description": "<string>",
"metadata": "<string>",
"bindings": [
"<string>"
],
"pooling_enabled": true
}
'import requests
url = "https://api.ngrok.com/endpoints"
payload = {
"url": "<string>",
"type": "<string>",
"traffic_policy": "<string>",
"description": "<string>",
"metadata": "<string>",
"bindings": ["<string>"],
"pooling_enabled": True
}
headers = {
"ngrok-version": "<ngrok-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'ngrok-version': '<ngrok-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: '<string>',
type: '<string>',
traffic_policy: '<string>',
description: '<string>',
metadata: '<string>',
bindings: ['<string>'],
pooling_enabled: true
})
};
fetch('https://api.ngrok.com/endpoints', 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/endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'type' => '<string>',
'traffic_policy' => '<string>',
'description' => '<string>',
'metadata' => '<string>',
'bindings' => [
'<string>'
],
'pooling_enabled' => true
]),
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/endpoints"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.ngrok.com/endpoints")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"region": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"public_url": "<string>",
"proto": "<string>",
"scheme": "<string>",
"hostport": "<string>",
"host": "<string>",
"port": 123,
"type": "<string>",
"metadata": "<string>",
"description": "<string>",
"domain": {
"id": "<string>",
"uri": "<string>"
},
"tcp_addr": {
"id": "<string>",
"uri": "<string>"
},
"tunnel": {
"id": "<string>",
"uri": "<string>"
},
"edge": {
"id": "<string>",
"uri": "<string>"
},
"upstream_url": "<string>",
"upstream_protocol": "<string>",
"url": "<string>",
"principal": {
"id": "<string>",
"uri": "<string>"
},
"traffic_policy": "<string>",
"bindings": [
"<string>"
],
"tunnel_session": {
"id": "<string>",
"uri": "<string>"
},
"uri": "<string>",
"name": "<string>",
"pooling_enabled": true
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}Endpoints
Create
Create an endpoint, currently available only for Cloud Endpoints
POST
/
endpoints
Create
curl --request POST \
--url https://api.ngrok.com/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"url": "<string>",
"type": "<string>",
"traffic_policy": "<string>",
"description": "<string>",
"metadata": "<string>",
"bindings": [
"<string>"
],
"pooling_enabled": true
}
'import requests
url = "https://api.ngrok.com/endpoints"
payload = {
"url": "<string>",
"type": "<string>",
"traffic_policy": "<string>",
"description": "<string>",
"metadata": "<string>",
"bindings": ["<string>"],
"pooling_enabled": True
}
headers = {
"ngrok-version": "<ngrok-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'ngrok-version': '<ngrok-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: '<string>',
type: '<string>',
traffic_policy: '<string>',
description: '<string>',
metadata: '<string>',
bindings: ['<string>'],
pooling_enabled: true
})
};
fetch('https://api.ngrok.com/endpoints', 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/endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'type' => '<string>',
'traffic_policy' => '<string>',
'description' => '<string>',
'metadata' => '<string>',
'bindings' => [
'<string>'
],
'pooling_enabled' => true
]),
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/endpoints"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.ngrok.com/endpoints")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"traffic_policy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"bindings\": [\n \"<string>\"\n ],\n \"pooling_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"region": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"public_url": "<string>",
"proto": "<string>",
"scheme": "<string>",
"hostport": "<string>",
"host": "<string>",
"port": 123,
"type": "<string>",
"metadata": "<string>",
"description": "<string>",
"domain": {
"id": "<string>",
"uri": "<string>"
},
"tcp_addr": {
"id": "<string>",
"uri": "<string>"
},
"tunnel": {
"id": "<string>",
"uri": "<string>"
},
"edge": {
"id": "<string>",
"uri": "<string>"
},
"upstream_url": "<string>",
"upstream_protocol": "<string>",
"url": "<string>",
"principal": {
"id": "<string>",
"uri": "<string>"
},
"traffic_policy": "<string>",
"bindings": [
"<string>"
],
"tunnel_session": {
"id": "<string>",
"uri": "<string>"
},
"uri": "<string>",
"name": "<string>",
"pooling_enabled": true
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}{
"status_code": 123,
"msg": "<string>",
"error_code": "<string>",
"details": {}
}Authorizations
Body
application/json
Response
Create an endpoint, currently available only for Cloud Endpoints
Was this page helpful?