---
title: "Update"
method: PATCH
path: "/endpoints/{id}"
tags: ["Endpoints"]
---

# Update

`PATCH /endpoints/{id}`

Update an Endpoint by ID, currently available only for cloud endpoints

## Path parameters

- `id` string, required

## Headers

- `ngrok-version` integer, required

## Request body

- EndpointUpdate
  - `id` string — unique endpoint resource identifier
  - `url` string — the url of the endpoint
  - `traffic_policy` string — The traffic policy attached to this endpoint
  - `description` string — user-supplied description of the associated tunnel
  - `metadata` string — user-supplied metadata of the associated tunnel or edge object
  - `bindings` string[] — the bindings associated with this endpoint
  - `pooling_enabled` boolean — n/a

## Response `200`

Update an Endpoint by ID, currently available only for cloud endpoints

- Endpoint
  - `id` string — unique endpoint resource identifier
  - `region` string — identifier of the region this endpoint belongs to
  - `created_at` string — timestamp when the endpoint was created in RFC 3339 format
  - `updated_at` string — timestamp when the endpoint was updated in RFC 3339 format
  - `public_url` string — deprecated [replaced by URL]: URL of the hostport served by this endpoint
  - `proto` string — protocol served by this endpoint. one of `http`, `https`, `tcp`, or `tls`
  - `scheme` string — n/a
  - `hostport` string — hostport served by this endpoint (hostname:port) -> soon to be deprecated
  - `host` string — n/a
  - `port` integer — n/a
  - `type` string — whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) or `cloud (represents a cloud endpoint)`
  - `metadata` string — user-supplied metadata of the associated tunnel or edge object
  - `description` string — user-supplied description of the associated tunnel
  - `domain` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `tcp_addr` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `tunnel` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `edge` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `upstream_url` string — the local address the tunnel forwards to
  - `upstream_protocol` string — the protocol the agent uses to forward with
  - `url` string — the url of the endpoint
  - `principal` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `traffic_policy` string — The traffic policy attached to this endpoint
  - `bindings` string[] — the bindings associated with this endpoint
  - `tunnel_session` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `uri` string — URI of the Cloud Endpoint API resource
  - `name` string — user supplied name for the endpoint
  - `pooling_enabled` boolean — whether the endpoint allows pooling

---

[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)