Connectors

/

Postman

/

Publish or unpublish Postman collection docs
Write

Publish Postman docs without leaking secrets

For API teams who want Postman collection documentation published or unpublished by their AI assistant, with checks for secrets and broken links first.

Try PopdockAI free
Get a live demo
Publish or unpublish Postman collection docs
Publish the docs for our Public Orders API collection in Postman.
Public Orders API is the parent collection, not a fork. - Secret check: api_key in the Production environment holds a value - Environments checked: 2, used by its monitors - Action: publish the documentation Do you still want to publish?
Postman
Sample figures. Your results come from your own account.
postman-get-collections
postman-get-monitors
postman-get-environments
postman-get-environment-variables
postman-publish-collection-docs
postman-unpublish-collection-docs
postman-add-collection-comment

On this page

The problem

The problem

The prompt

Who it's for

How it works

Tools used

Connector

Postman

Postman
Run it on your own Postman data.

Connect Postman, pick your AI tool and paste the prompt.

Try PopdockAI free

The problem

Published docs that leak secrets

Publishing a collection's documentation makes it public, and published docs can show example values, including tokens left in the environments the collection runs with. Unpublishing breaks the public link for every partner who relies on it.

Without PopdockAI

  • Publish without checking environment variables
  • Leak a token in an example value
  • Unpublish without warning partners
  • Forget to tell collaborators what changed

With PopdockAI

  • Monitor environments are scanned for secret-like keys before publishing
  • A fork is flagged before its docs go public
  • A broken link warning comes before unpublishing
  • Only the action you asked for runs, once, after you confirm

The prompt

Use this prompt

Copy it into any AI tool connected to PopdockAI. Swap the values in braces for your own.

Prompt
**Objective:** `{action}` (publish or unpublish; no default, ask if empty) the public documentation for collection `{collection-name}`.

**Step 1: Resolve the collection**

Call `postman-get-collections` with `name` = `{collection-name}` (fall back to `name.contains`). If more than one matches, list name, owner, public and updated-at and ask which. Keep collection-id, collection-uid, public and owner.

**Step 2: Pre-flight checks for publish**

* Find the environments its monitors use: call `postman-get-monitors` with `collection-uid`, match each monitor's environment-uid to an environment-id with `postman-get-environments`, then call `postman-get-environment-variables` with that `environment-id`. If any enabled variable has a secret-like key (token, secret, password, apikey, auth, credential), warn that published docs can show example values and ask the user to confirm the collection holds no hard-coded secrets.
* If the collection is a fork (forked-from-collection-id set), warn that docs are normally published from the parent.

**Step 3: Pre-flight checks for unpublish**

Warn that the public documentation URL will stop working for anyone who has it, including external customers or partners.

**Step 4: Confirm, then act**

Show the collection, the action and the warnings. After a clear yes, call `postman-publish-collection-docs` (for publish) or `postman-unpublish-collection-docs` (for unpublish) once, with `collection-id`.

**Step 5: Report**

Confirm what was done. Optionally offer to leave a note for collaborators; if the user agrees, call `postman-add-collection-comment` once with `collection-uid` and the note text.

**Rules & Guidelines:**

* Call only the tool that matches `{action}`. Never call both.
* Never publish without the user confirming the secrets check.

**Validation:**

* If `{action}` is not publish or unpublish, ask which and stop.
* If the collection cannot be found, list close matches and stop.

Who it's for

One answer, three teams that use it

API product managers

Publish docs with confidence

Secret-like variables are flagged before the docs go public, so nothing sensitive leaks.

Publish the docs for the Partner Orders API collection in Postman.

Developer relations

Retire docs without surprises

You are warned that the public link will break before docs are taken down.

Unpublish the docs for the Legacy Billing API collection and leave a note for collaborators.

Security engineers

Check for tokens before release

Environment variables used by the collection's monitors are scanned for tokens, passwords and keys.

Check the Public Catalog API collection for secrets before we publish its docs.

How it works

What PopdockAI does when you ask

You name the collection and say publish or unpublish, and your AI assistant checks the risks first. You approve the action, and it can leave a note for collaborators.

01

Ask

You name the collection and say publish or unpublish.

Your AI tool

02

Check

It scans monitor environments for secret-like keys or warns about broken links.

postman-get-collections
postman-get-monitors
postman-get-environments
postman-get-environment-variables

03

Confirm

You see the warnings and approve the action.

No items found.

04

Act

It publishes or unpublishes once, with an optional note to collaborators.

Your AI tool

What PopdockAI provides

The tools behind the answer

Ready made tools for Postman and one secure connection to your AI tool. No code, no exports.

get-data

postman-get-collections

Returns Postman collections with their owner, ids, last update and fork details (parent collection, fork label, fork date). Filter by name, collection id or owner.
get-data

postman-get-monitors

Returns Postman monitors with the collection and environment each one runs, its owner and whether it is active. Filter by name, collection or owner.
get-data

postman-get-environments

Returns Postman environments with their name, ids, owner, whether they are public and when they were last updated. Filter by name or owner.
get-data

postman-get-environment-variables

Returns the variables defined in each Postman environment: key, value, whether it is enabled and whether the environment is public. Filter by environment.
run-action

postman-publish-collection-docs

Publishes a Postman collection's documentation publicly.
run-action

postman-unpublish-collection-docs

Removes a Postman collection's publicly published documentation, so its public URL stops working.
run-action

postman-add-collection-comment

Posts a comment on a Postman collection, either as a new thread or as a reply in an existing one.
Read only.Nothing in Postman Changes

This report is built from Get data tools only. PopdockAI applies the row, field and parameter rules your admin sets, and every query is written to the audit trail.

How Popdock AI secures your data

The outcome

Public docs without leaked secrets or surprises

Try PopdockAI free
Get a live demo

Related use cases

More ways to put this data to work

All Ramp use cases

One prompt template with infinite possibilities.

‍

Your AI assistant adapts its approach, tone, and capabilities to match each unique context while you maintain a single, manageable workflow.

Join forward-thinking companies that are transforming their operations with intelligent, secure AI automation.

Try PopdockAI Free
See Documentation