COconfluent
Connectors (usm/v1)

List connectors

Changed on

Default returns a native-compatible array of names. ?expand returns a map keyed by name. ?page_size switches to the paginated List envelope (Cloud-only), returning pagination metadata in headers rather than the response body so the native-compatible array/map shape is preserved (this differs from the inline-metadata pagination used by GET /usm/v1/connect-clusters; deliberate, see the Design Notes in the companion Confluence contract). ?show_deleted=true includes soft-deleted (DELETING) connectors.

get/usm/v1/connect-clusters/{connect_cluster_id}/connectors

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/usm/v1/connect-clusters/{connect_cluster_id}/connectors
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Query parameters

expandstring[]

Inlines the selected views into the list response.

page_sizeinteger

Cloud-only. Presence turns on paging without changing the response body shape; the next cursor is in the Link / X-Next-Page-Token headers. First request only.

page_tokenstring

Opaque cursor taken from the previous page's Link / X-Next-Page-Token header. Follow-up pages only.

show_deletedboolean

When true, includes soft-deleted (DELETING) connectors/records in the response. Default false hides them (on-prem parity).

Response

OK. Bare array of names, or the name-keyed map when ?expand is set. The next-page cursor (when ?page_size is set) is in the Link (rel="next") and X-Next-Page-Token response headers, never in the body.

string[] required
OR
UsmConnectV1ConnectorExpansionMap required

Example response

[
  "s3-sink-01",
  "jdbc-source-02"
]

Changes