---
title: "Update"
method: PATCH
path: "/event_destinations/{id}"
tags: ["EventDestinations"]
---

# Update

`PATCH /event_destinations/{id}`

Update attributes of an Event Destination.

## Path parameters

- `id` string, required

## Headers

- `ngrok-version` integer, required

## Request body

- EventDestinationUpdate
  - `id` string — Unique identifier for this Event Destination.
  - `metadata` string — Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
  - `description` string — Human-readable description of the Event Destination. Optional, max 255 bytes.
  - `format` string — The output format you would like to serialize events into when sending to their target. Currently the only accepted value is `JSON`.
  - `target` EventTarget
    - `firehose` EventTargetFirehose
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `delivery_stream_arn` string — An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
    - `kinesis` EventTargetKinesis
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `stream_arn` string — An Amazon Resource Name specifying the Kinesis stream to deposit events into.
    - `cloudwatch_logs` EventTargetCloudwatchLogs
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `log_group_arn` string — An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
    - `datadog` EventTargetDatadog
      - `api_key` string — Datadog API key to use.
      - `ddtags` string — Tags to send with the event.
      - `service` string — Service name to send with the event.
      - `ddsite` string — Datadog site to send event to.
    - `azure_logs_ingestion` EventTargetAzureLogsIngestion
      - `tenant_id` string, required — Tenant ID for the Azure account
      - `client_id` string, required — Client ID for the application client
      - `client_secret` string, required — Client Secret for the application client
      - `logs_ingestion_uri` string, required — Data collection endpoint logs ingestion URI
      - `data_collection_rule_id` string, required — Data collection rule immutable ID
      - `data_collection_stream_name` string, required — Data collection stream name to use as destination, located inside the DCR

## Response `200`

Update attributes of an Event Destination.

- EventDestination
  - `id` string — Unique identifier for this Event Destination.
  - `metadata` string — Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
  - `created_at` string — Timestamp when the Event Destination was created, RFC 3339 format.
  - `description` string — Human-readable description of the Event Destination. Optional, max 255 bytes.
  - `format` string — The output format you would like to serialize events into when sending to their target. Currently the only accepted value is `JSON`.
  - `target` EventTarget
    - `firehose` EventTargetFirehose
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `delivery_stream_arn` string — An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
    - `kinesis` EventTargetKinesis
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `stream_arn` string — An Amazon Resource Name specifying the Kinesis stream to deposit events into.
    - `cloudwatch_logs` EventTargetCloudwatchLogs
      - `auth` AWSAuth
        - `role` AWSRole
          - `role_arn` string, required — An ARN that specifies the role that ngrok should use to deliver to the configured target.
        - `creds` AWSCredentials
          - `aws_access_key_id` string, required — The ID portion of an AWS access key.
          - `aws_secret_access_key` string, required — The secret portion of an AWS access key.
      - `log_group_arn` string — An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
    - `datadog` EventTargetDatadog
      - `api_key` string — Datadog API key to use.
      - `ddtags` string — Tags to send with the event.
      - `service` string — Service name to send with the event.
      - `ddsite` string — Datadog site to send event to.
    - `azure_logs_ingestion` EventTargetAzureLogsIngestion
      - `tenant_id` string, required — Tenant ID for the Azure account
      - `client_id` string, required — Client ID for the application client
      - `client_secret` string, required — Client Secret for the application client
      - `logs_ingestion_uri` string, required — Data collection endpoint logs ingestion URI
      - `data_collection_rule_id` string, required — Data collection rule immutable ID
      - `data_collection_stream_name` string, required — Data collection stream name to use as destination, located inside the DCR
  - `uri` string — URI of the Event Destination API resource.

---

[API](https://skmtc.net/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.net/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/versions/1994bbb04714/schema)