curl --request GET \
--url https://api.ngrok.com/event_destinations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"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>"
}Get detailed information about an Event Destination by ID.
curl --request GET \
--url https://api.ngrok.com/event_destinations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"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>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
a resource identifier
Get detailed information about an Event Destination by ID.
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
Configuration used to send events to Amazon Kinesis Data Firehose.
Show child attributes
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
Show child attributes
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
Configuration used to send events to Amazon Kinesis.
Show child attributes
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
Show child attributes
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
Configuration used to send events to Amazon CloudWatch Logs.
Show child attributes
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
Show child attributes
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
n/a
Show child attributes
Tenant ID for the Azure account
Client ID for the application client
Client Secret for the application client
Data collection endpoint logs ingestion URI
Data collection rule immutable ID
Data collection stream name to use as destination, located inside the DCR
URI of the Event Destination API resource.
Was this page helpful?