---
title: "Update Connector"
method: PATCH
path: "/v3/connectors/{connector_id}"
tags: ["integrations-v3"]
---

# Update Connector

`PATCH /v3/connectors/{connector_id}`

Update an active Connector owned by the caller's organization.

## Path parameters

- `connector_id` string, required

## Request body

- UpdateConnectorRequest
  - `name` string, nullable — Updated Connector display name
  - `description` string, nullable — Updated Connector description; null clears it

## Response `200`

Successful Response

- ConnectorResponse
  - `id` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `kind` 'LEGACY' | 'SELF_SERVE', required
  - `created_at` string, date-time, required
  - `controller_url` string, required — Public Edge Controller URL that customer Connectors dial. This is the environment's edge.<base-domain> host, not the in-cluster URL stored on org_connectors.url.
  - `status` union, required — Last-known Connector health from the newest persisted status check. A completed check returns its result (connected, waiting_for_connection, or offline). Pending, failed, and missing checks return null — they are not inferred from last_connected_at or certificates. Live probes stay on POST /v3/connector/status; in-flight checks stay on GET /v3/connector/status/active.
    - ConnectedConnectorStatus
      - `status` 'connected', required
      - `observed_at` string, date-time, required
      - `active_connection_count` integer, nullable
      - `requests_processed_last_hour` integer, nullable
      - `request_success_rate_last_hour` number, nullable
    - WaitingForConnectionConnectorStatus
      - `status` 'waiting_for_connection', required
      - `observed_at` string, date-time, required
    - OfflineConnectorStatus
      - `status` 'offline', required
      - `observed_at` string, date-time, required
      - `last_connected_at` string, date-time, required

## Other responses

- `422` — Validation Error

## Changes

> 57 revisions in range; 9 not diffed.

- **2026-09-17** `4a4435773444` — 2 breaking
  - the response property `status/anyOf[subschema #1]/oneOf[subschema #1: ConnectedConnectorStatus]/active_connection_count` became optional for the status `200`
  - response property `status/anyOf[subschema #1]/oneOf[subschema #1: ConnectedConnectorStatus]/active_connection_count` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
- **2026-09-17** `cc0d29e474a3` — 1 info
  - added the required property `controller_url` to the response with the `200` status

[Change history](https://skmtc.dev/traversal/apis/fastapi/changes/v3/connectors/:connector_id/patch.md)

---

[API](https://skmtc.dev/traversal/apis/fastapi.md) · [All operations](https://skmtc.dev/traversal/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc.dev/traversal/apis/fastapi/revisions/c3bd9dec6c16?raw)