postman-cs/Postman Onboarding: Insights Linking

Link Postman Insights discovered services to workspaces and git repos. Part of the Postman API Onboarding suite.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
project-nameService name or Jira/Xray project key to match against the final discovered-service segmentyes
workspace-idPostman workspace ID to link the discovered service toyes
environment-idPostman environment UID for the onboarding associationyes
system-environment-idPostman system environment UUID for service-level Insights acknowledgmentno
cluster-nameInsights cluster name. When set, matches {cluster-name}/{project-name} exactly in discovered servicesno
repo-urlRepository URL for Git onboarding. Auto-detected from CI context when omitted.no
postman-access-tokenRequired human-user session access token (x-access-token) for Bifrost and Akita linking calls. Service-account tokens are rejected and this action never mints or refreshes a token from a PMAK.no
postman-team-idExplicit Postman team ID for org-mode integration request headers. When omitted, x-entity-team-id is not sent.no
github-tokenOptional GitHub token passed as git_api_key when repository auth is required by onboarding/gitno
postman-api-keyHuman-user Postman API key (PMAK-*) for observability application binding. It must resolve to the same human user as postman-access-token; service-account PMAKs are rejected.no
create-api-keyExplicit opt-in to create a durable Bifrost API key when postman-api-key is omitted or invalid. Default false — never creates timestamp-named orphan keys on ordinary runs. Supported values: true, false.nofalse
credential-preflightCredential identity preflight policy. Both modes require a human-user access token with consumerType=user; enforce additionally fails on parent-org mismatch.noenforce
service-not-found-policyBehavior when the discovered service is absent after polling. fail (default) aborts full linking; warn returns status=not-found without writes. Supported values: fail, warn.nofail
poll-timeout-secondsMaximum seconds to wait for the service to appear in the discovered listno120
poll-interval-secondsSeconds between discovery polling attemptsno10
postman-regionPostman data residency region for public API calls. One of: us or eu.nous
postman-stackPostman stack profile. Defaults to the public production stack. Marketplace workflows should leave this as prod.noprod
branch-strategyBranch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and skips on other branches; preview additionally maintains suffixed per-branch preview asset sets.nolegacy
canonical-branchExplicit canonical branch (the sole writer of canonical assets). Defaults to the provider-resolved default branch.no
channelsComma-separated channel map for long-lived promotion branches.no
namedescription
discovered-service-idNumeric ID from the API Catalog discovered-services list
discovered-service-nameFull cluster/service name of the discovered service
collection-idCollection ID returned by the prepare-collection step
application-idInsights application binding ID from the observability API
verification-tokenInsights team verification token (tvt_*) for DaemonSet telemetry
statusOnboarding result: success, not-found, or error
sync-statusBranch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy.
branch-decisionSerialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION).