Skip to navigation
ObservePostman API CatalogConnect to your services

Connect with Cluster Watcher

View as Markdown

Cluster Watcher discovers Kubernetes deployments and adds their metadata and Git information to the API Catalog. It uses the Kubernetes API and doesn’t capture live traffic or endpoint details.

To use Cluster Watcher, reach out to Postman support to have it enabled for your organization.

Use Cluster Watcher when you:

  • Deploy APIs in Kubernetes environments.
  • Need quick onboarding without extensive configuration.
  • Can’t or don’t want to grant elevated cluster access.
  • Want to connect your deployments to Git repositories.
  • Prioritize shipping speed over spec-first development.

Cluster Watcher operates as a Custom Resource Definition (CRD) that:

  • Installs at cluster control plane level — No sidecars, pods, or traffic interception needed.
  • Reads Kubernetes APIs only — Discovers deployments through standard API calls.
  • Sends metadata to Postman — Automatically populates the API Catalog.
  • Links deployments to Git — Captures commit IDs and branch information for CI integration.

Get started

Before you start, make sure you have:

  • A Kubernetes cluster with API access.
  • A Postman organization with API Catalog enabled.
  • Git repositories connected to your deployments.

To set up Cluster Watcher, do the following:

  1. Contact Postman support to enable Cluster Watcher for your organization and get the installation instructions.

  2. Install the Cluster Watcher custom resource in your Kubernetes cluster by following the instructions from Postman Support.

  3. In Postman, open API Catalog, click Service discovery, and then click Cluster Watcher as the source.

  4. Confirm that your deployments appear. Select the deployments to add, then click Import Service.

  5. Verify that the imported services include the expected commit and branch information.

Cluster Watcher works alongside other discovery methods. You can start here and add more comprehensive monitoring later as your API governance matures.

Cluster Watcher captures the following information about your deployments:

  • Deployment metadata — Names, namespaces, and cluster information.
  • Git information — Commit IDs and branch details for each deployment.
  • CI linkage — Connects deployments back to your CI pipeline and Git repositories.

Cluster Watcher focuses on deployment discovery and Git integration. It doesn’t capture live traffic or endpoint details like other discovery methods.

Choose another discovery method

Cluster Watcher doesn’t capture live traffic or endpoint details. For those capabilities, use Postman Insights Agent. If your API specifications are managed by an API gateway, use cloud connectors.