Skip to main content
GET
/
event_destinations
List
curl --request GET \
  --url https://api.ngrok.com/event_destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "event_destinations": [
    {
      "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>"
    }
  ],
  "uri": "<string>",
  "next_page_uri": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Query Parameters

before_id
string
limit
string

Response

200 - application/json

List all Event Destinations on this account.

event_destinations
object[]

The list of all Event Destinations on this account.

uri
string

URI of the Event Destinations list API resource.

next_page_uri
string

URI of the next page, or null if there is no next page.