NGngrok
EventDestinations

Update

Changed on

Update attributes of an Event Destination.

patch/event_destinations/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/event_destinations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for this Event Destination.

Headers

ngrok-versioninteger required

Request body

idstring

Unique identifier for this Event Destination.

metadatastring

Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

descriptionstring

Human-readable description of the Event Destination. Optional, max 255 bytes.

formatstring

The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

Response

Update attributes of an Event Destination.

idstring

Unique identifier for this Event Destination.

metadatastring

Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

created_atstring

Timestamp when the Event Destination was created, RFC 3339 format.

descriptionstring

Human-readable description of the Event Destination. Optional, max 255 bytes.

formatstring

The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

uristring

URI of the Event Destination API resource.

Changes

  • 8418dcf65430Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status