Update
curl --request PATCH \
--url https://api.ngrok.com/event_destinations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"metadata": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<string>"
}
}
}
'import requests
url = "https://api.ngrok.com/event_destinations/{id}"
payload = {
"id": "<string>",
"metadata": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<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>',
metadata: '<string>',
description: '<string>',
format: '<string>',
target: {
firehose: {auth: {}, delivery_stream_arn: '<string>'},
kinesis: {auth: {}, stream_arn: '<string>'},
cloudwatch_logs: {auth: {}, log_group_arn: '<string>'},
datadog: {
api_key: '<string>',
ddtags: '<string>',
service: '<string>',
ddsite: '<string>'
}
}
})
};
fetch('https://api.ngrok.com/event_destinations/{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/event_destinations/{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>',
'metadata' => '<string>',
'description' => '<string>',
'format' => '<string>',
'target' => [
'firehose' => [
'auth' => [
],
'delivery_stream_arn' => '<string>'
],
'kinesis' => [
'auth' => [
],
'stream_arn' => '<string>'
],
'cloudwatch_logs' => [
'auth' => [
],
'log_group_arn' => '<string>'
],
'datadog' => [
'api_key' => '<string>',
'ddtags' => '<string>',
'service' => '<string>',
'ddsite' => '<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/event_destinations/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<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/event_destinations/{id}")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/event_destinations/{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 \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"metadata": "<string>",
"created_at": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<string>"
},
"azure_logs_ingestion": {
"tenant_id": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"logs_ingestion_uri": "<string>",
"data_collection_rule_id": "<string>",
"data_collection_stream_name": "<string>"
}
},
"uri": "<string>"
}Event Destinations
Update
Update attributes of an Event Destination.
PATCH
/
event_destinations
/
{id}
Update
curl --request PATCH \
--url https://api.ngrok.com/event_destinations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"id": "<string>",
"metadata": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<string>"
}
}
}
'import requests
url = "https://api.ngrok.com/event_destinations/{id}"
payload = {
"id": "<string>",
"metadata": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<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>',
metadata: '<string>',
description: '<string>',
format: '<string>',
target: {
firehose: {auth: {}, delivery_stream_arn: '<string>'},
kinesis: {auth: {}, stream_arn: '<string>'},
cloudwatch_logs: {auth: {}, log_group_arn: '<string>'},
datadog: {
api_key: '<string>',
ddtags: '<string>',
service: '<string>',
ddsite: '<string>'
}
}
})
};
fetch('https://api.ngrok.com/event_destinations/{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/event_destinations/{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>',
'metadata' => '<string>',
'description' => '<string>',
'format' => '<string>',
'target' => [
'firehose' => [
'auth' => [
],
'delivery_stream_arn' => '<string>'
],
'kinesis' => [
'auth' => [
],
'stream_arn' => '<string>'
],
'cloudwatch_logs' => [
'auth' => [
],
'log_group_arn' => '<string>'
],
'datadog' => [
'api_key' => '<string>',
'ddtags' => '<string>',
'service' => '<string>',
'ddsite' => '<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/event_destinations/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<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/event_destinations/{id}")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/event_destinations/{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 \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"target\": {\n \"firehose\": {\n \"auth\": {},\n \"delivery_stream_arn\": \"<string>\"\n },\n \"kinesis\": {\n \"auth\": {},\n \"stream_arn\": \"<string>\"\n },\n \"cloudwatch_logs\": {\n \"auth\": {},\n \"log_group_arn\": \"<string>\"\n },\n \"datadog\": {\n \"api_key\": \"<string>\",\n \"ddtags\": \"<string>\",\n \"service\": \"<string>\",\n \"ddsite\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"metadata": "<string>",
"created_at": "<string>",
"description": "<string>",
"format": "<string>",
"target": {
"firehose": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"delivery_stream_arn": "<string>"
},
"kinesis": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"stream_arn": "<string>"
},
"cloudwatch_logs": {
"auth": {
"role": {
"role_arn": "<string>"
},
"creds": {
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>"
}
},
"log_group_arn": "<string>"
},
"datadog": {
"api_key": "<string>",
"ddtags": "<string>",
"service": "<string>",
"ddsite": "<string>"
},
"azure_logs_ingestion": {
"tenant_id": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"logs_ingestion_uri": "<string>",
"data_collection_rule_id": "<string>",
"data_collection_stream_name": "<string>"
}
},
"uri": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Unique identifier for this Event Destination.
Body
application/json
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
Show child attributes
Show child attributes
Response
200 - application/json
Update attributes of an Event Destination.
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
Show child attributes
Show child attributes
URI of the Event Destination API resource.
Was this page helpful?
⌘I