postman-cli 1.35.2 → 1.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/man/postman.1 +453 -13
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-05-
|
|
1
|
+
.TH POSTMAN 1 "2026-05-14" "v1.36.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -1160,7 +1160,10 @@ List SDK builds for a collection, extensible collection, or specification.
|
|
|
1160
1160
|
Download SDKs from a build by its ID.
|
|
1161
1161
|
.TP
|
|
1162
1162
|
.B sdk connect
|
|
1163
|
-
Connect a collection or specification to a
|
|
1163
|
+
Connect a collection or specification to a GitHub repository for automatic SDK pull requests
|
|
1164
|
+
.TP
|
|
1165
|
+
.B sdk connections
|
|
1166
|
+
Manage GitHub connections that drive automatic SDK pull requests
|
|
1164
1167
|
|
|
1165
1168
|
.SS "sdk init"
|
|
1166
1169
|
Create or update .postman/config.json with an SDK configuration stub.
|
|
@@ -1211,9 +1214,6 @@ Show detailed generation progress and logs
|
|
|
1211
1214
|
.B \-\-log\-level <level>
|
|
1212
1215
|
Set build log detail level. "warn" (default) shows errors/warnings inline and collapses info notes; "info" expands all log entries (default: warn)
|
|
1213
1216
|
.TP
|
|
1214
|
-
.B \-\-pr
|
|
1215
|
-
Create pull requests to configured GitHub repositories after SDK generation
|
|
1216
|
-
.TP
|
|
1217
1217
|
.B \-\-no\-track\-changes
|
|
1218
1218
|
Disable change tracking. By default, file hashes are written into .manifest.json to enable edit detection on the next regeneration.
|
|
1219
1219
|
.TP
|
|
@@ -1222,6 +1222,12 @@ Skip custom code merge even if user edits are detected. Forces a fresh generatio
|
|
|
1222
1222
|
.TP
|
|
1223
1223
|
.B \-\-conflict\-strategy <strategy>
|
|
1224
1224
|
Strategy for handling merge conflicts: "mark" inserts conflict markers (default), "ours" keeps user edits, "theirs" keeps generated code
|
|
1225
|
+
.TP
|
|
1226
|
+
.B \-\-no\-emit
|
|
1227
|
+
Skip downloading and saving SDK artifacts to disk. Useful in CI when the build only needs to trigger server\-side pull requests.
|
|
1228
|
+
.TP
|
|
1229
|
+
.B \-\-pr
|
|
1230
|
+
[DEPRECATED]
|
|
1225
1231
|
|
|
1226
1232
|
.TP Examples:
|
|
1227
1233
|
|
|
@@ -1387,7 +1393,7 @@ Examples:
|
|
|
1387
1393
|
|
|
1388
1394
|
|
|
1389
1395
|
.SS "sdk connect"
|
|
1390
|
-
Connect a collection or specification to a
|
|
1396
|
+
Connect a collection or specification to a GitHub repository for automatic SDK pull requests
|
|
1391
1397
|
|
|
1392
1398
|
.B Usage:
|
|
1393
1399
|
<provider> <id> [options]
|
|
@@ -1397,22 +1403,122 @@ Connect a collection or specification to a Git repository for automated SDK PRs
|
|
|
1397
1403
|
.B \-l, \-\-language <language>
|
|
1398
1404
|
SDK language (required) [choices: typescript, python, java, go, csharp, php, ruby, cli, kotlin, rust]
|
|
1399
1405
|
.TP
|
|
1406
|
+
.B \-r, \-\-repo <owner/name>
|
|
1407
|
+
GitHub repository in <owner>/<name> form (alternative to \-\-repo\-owner + \-\-repo\-name)
|
|
1408
|
+
.TP
|
|
1409
|
+
.B \-\-repo\-owner <owner>
|
|
1410
|
+
GitHub repository owner (user or org)
|
|
1411
|
+
.TP
|
|
1412
|
+
.B \-\-repo\-name <name>
|
|
1413
|
+
GitHub repository name
|
|
1414
|
+
.TP
|
|
1415
|
+
.B \-b, \-\-branch <branch>
|
|
1416
|
+
Target branch for SDK pull requests (default: main)
|
|
1417
|
+
.TP
|
|
1418
|
+
.B \-\-push\-to\-base
|
|
1419
|
+
Push SDK updates directly to the base branch instead of opening a pull request (default: false)
|
|
1420
|
+
.TP
|
|
1421
|
+
.B \-\-enable\-npm\-publishing
|
|
1422
|
+
Inject a GitHub Actions workflow that publishes to npm on merge (TypeScript only) (default: false)
|
|
1423
|
+
.TP
|
|
1424
|
+
.B \-\-auth\-provider <provider>
|
|
1425
|
+
OAuth provider used by the server when pushing (choices: githubapp, github) (default: githubapp)
|
|
1426
|
+
.TP
|
|
1427
|
+
.B \-\-verbose
|
|
1428
|
+
Show extra logging
|
|
1429
|
+
.TP
|
|
1400
1430
|
.B \-w, \-\-workspace <workspaceId>
|
|
1401
|
-
|
|
1431
|
+
[DEPRECATED]
|
|
1402
1432
|
|
|
1403
1433
|
.TP Examples:
|
|
1404
1434
|
|
|
1405
1435
|
Providers:
|
|
1406
|
-
github \- Connect to GitHub repository
|
|
1436
|
+
github \- Connect to a GitHub repository
|
|
1407
1437
|
|
|
1408
|
-
|
|
1438
|
+
Authentication:
|
|
1439
|
+
By default the server uses the installed Postman GitHub App (\-\-auth\-provider githubapp).
|
|
1440
|
+
Pass \-\-auth\-provider github to use a previously\-granted user OAuth token instead.
|
|
1441
|
+
If the server returns an auth error, install the GitHub App from your Postman workspace settings.
|
|
1409
1442
|
|
|
1410
1443
|
Examples:
|
|
1411
|
-
Connect a collection for TypeScript SDK
|
|
1412
|
-
postman sdk connect github 12345\-abcde\-67890 \-\-language typescript
|
|
1444
|
+
Connect a collection to a GitHub repo for TypeScript SDK PRs:
|
|
1445
|
+
postman sdk connect github 12345\-abcde\-67890 \-\-language typescript \-\-repo my\-org/my\-sdk
|
|
1446
|
+
|
|
1447
|
+
Connect a specification using a non\-default branch:
|
|
1448
|
+
postman sdk connect github 67890\-fghij\-12345 \-l python \-\-repo my\-org/python\-sdk \-\-branch develop
|
|
1449
|
+
|
|
1450
|
+
Push SDK updates straight to base instead of opening a pull request:
|
|
1451
|
+
postman sdk connect github 12345\-abcde\-67890 \-l java \-\-repo my\-org/java\-sdk \-\-push\-to\-base
|
|
1413
1452
|
|
|
1414
|
-
|
|
1415
|
-
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
.SS "sdk connections"
|
|
1456
|
+
Manage GitHub connections that drive automatic SDK pull requests
|
|
1457
|
+
|
|
1458
|
+
.B Usage:
|
|
1459
|
+
[options] [command]
|
|
1460
|
+
|
|
1461
|
+
.B Subcommands:
|
|
1462
|
+
.TP
|
|
1463
|
+
.B sdk connections list
|
|
1464
|
+
List GitHub connections for a collection or specification
|
|
1465
|
+
.TP
|
|
1466
|
+
.B sdk connections delete
|
|
1467
|
+
Delete a GitHub connection for a collection or specification
|
|
1468
|
+
|
|
1469
|
+
.SS "sdk connections list"
|
|
1470
|
+
List GitHub connections for a collection or specification
|
|
1471
|
+
|
|
1472
|
+
.B Usage:
|
|
1473
|
+
[options] <id>
|
|
1474
|
+
|
|
1475
|
+
.B Options:
|
|
1476
|
+
.TP
|
|
1477
|
+
.B \-\-refresh
|
|
1478
|
+
Refresh PR statuses from GitHub before listing (slower) (default: false)
|
|
1479
|
+
.TP
|
|
1480
|
+
.B \-\-json
|
|
1481
|
+
Output raw JSON instead of formatted text (default: false)
|
|
1482
|
+
.TP
|
|
1483
|
+
.B \-\-verbose
|
|
1484
|
+
Show extra logging
|
|
1485
|
+
|
|
1486
|
+
.TP Examples:
|
|
1487
|
+
|
|
1488
|
+
Examples:
|
|
1489
|
+
List connections for a collection:
|
|
1490
|
+
postman sdk connections list 12345\-abcde\-67890
|
|
1491
|
+
|
|
1492
|
+
Refresh PR statuses from GitHub before listing:
|
|
1493
|
+
postman sdk connections list 12345\-abcde\-67890 \-\-refresh
|
|
1494
|
+
|
|
1495
|
+
Output raw JSON for scripting:
|
|
1496
|
+
postman sdk connections list 12345\-abcde\-67890 \-\-json
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
.SS "sdk connections delete"
|
|
1501
|
+
Delete a GitHub connection for a collection or specification
|
|
1502
|
+
|
|
1503
|
+
.B Usage:
|
|
1504
|
+
[options] <id> <connectionId>
|
|
1505
|
+
|
|
1506
|
+
.B Options:
|
|
1507
|
+
.TP
|
|
1508
|
+
.B \-y, \-\-yes
|
|
1509
|
+
Skip the confirmation prompt (default: false)
|
|
1510
|
+
.TP
|
|
1511
|
+
.B \-\-verbose
|
|
1512
|
+
Show extra logging
|
|
1513
|
+
|
|
1514
|
+
.TP Examples:
|
|
1515
|
+
|
|
1516
|
+
Examples:
|
|
1517
|
+
Delete connection 42 from a collection (with confirmation):
|
|
1518
|
+
postman sdk connections delete 12345\-abcde\-67890 42
|
|
1519
|
+
|
|
1520
|
+
Skip the confirmation prompt:
|
|
1521
|
+
postman sdk connections delete 12345\-abcde\-67890 42 \-\-yes
|
|
1416
1522
|
|
|
1417
1523
|
|
|
1418
1524
|
|
|
@@ -1582,6 +1688,340 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
1582
1688
|
.B Usage:
|
|
1583
1689
|
[options] <filepath>
|
|
1584
1690
|
|
|
1691
|
+
.SS "search"
|
|
1692
|
+
Search for Postman element types (requests, collections, workspaces, and more).
|
|
1693
|
+
|
|
1694
|
+
.B Usage:
|
|
1695
|
+
[command] [options]
|
|
1696
|
+
|
|
1697
|
+
.B Options:
|
|
1698
|
+
.TP
|
|
1699
|
+
.B \-\-ownership <ownership>
|
|
1700
|
+
Ownership: organization (or org), external, all (default: organization)
|
|
1701
|
+
.TP
|
|
1702
|
+
.B \-n, \-\-limit <limit>
|
|
1703
|
+
Max results per page. Max allowed limit: 25 (default: 10)
|
|
1704
|
+
.TP
|
|
1705
|
+
.B \-\-cursor <cursor>
|
|
1706
|
+
Cursor for pagination
|
|
1707
|
+
.TP
|
|
1708
|
+
.B \-o, \-\-output <format>
|
|
1709
|
+
Output format: default (card list), json (detailed JSON) (default: default)
|
|
1710
|
+
.TP
|
|
1711
|
+
.B \-\-filter <expression>
|
|
1712
|
+
Filter expression (e.g. "workspaceId=ws\-123 AND visibility=public")
|
|
1713
|
+
.TP
|
|
1714
|
+
.B \-\-filter\-json <json>
|
|
1715
|
+
Filter as raw JSON.
|
|
1716
|
+
Only a top\-level "$and" list of condition objects is supported.
|
|
1717
|
+
"$or" and nested groups are not supported in \-\-filter\-json.
|
|
1718
|
+
Each condition: { "<property>": { "<operator>": <value> } }.
|
|
1719
|
+
If both \-\-filter and \-\-filter\-json are provided, \-\-filter\-json takes precedence.
|
|
1720
|
+
|
|
1721
|
+
.TP Examples:
|
|
1722
|
+
|
|
1723
|
+
Quick start:
|
|
1724
|
+
postman search requests "auth"
|
|
1725
|
+
postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
|
|
1726
|
+
|
|
1727
|
+
Element types: requests, collections, workspaces, flows, specs
|
|
1728
|
+
|
|
1729
|
+
Detailed help is split by element type:
|
|
1730
|
+
postman search requests \-\-help Request filters and examples
|
|
1731
|
+
postman search collections \-\-help Collection filters and examples
|
|
1732
|
+
postman search workspaces \-\-help Workspace filters and examples
|
|
1733
|
+
postman search flows \-\-help Flow filters and examples
|
|
1734
|
+
postman search specs \-\-help API spec filters and examples
|
|
1735
|
+
|
|
1736
|
+
Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
.B Subcommands:
|
|
1740
|
+
.TP
|
|
1741
|
+
.B search requests
|
|
1742
|
+
Search for requests by name or keyword.
|
|
1743
|
+
.TP
|
|
1744
|
+
.B search collections
|
|
1745
|
+
Search for collections by name or keyword.
|
|
1746
|
+
.TP
|
|
1747
|
+
.B search workspaces
|
|
1748
|
+
Search for workspaces by name or keyword.
|
|
1749
|
+
.TP
|
|
1750
|
+
.B search flows
|
|
1751
|
+
Search for flows by name or keyword.
|
|
1752
|
+
.TP
|
|
1753
|
+
.B search specs
|
|
1754
|
+
Search for API specs by name or keyword.
|
|
1755
|
+
|
|
1756
|
+
.SS "search requests"
|
|
1757
|
+
Search for requests by name or keyword.
|
|
1758
|
+
|
|
1759
|
+
.B Usage:
|
|
1760
|
+
[options] [query]
|
|
1761
|
+
|
|
1762
|
+
.TP Examples:
|
|
1763
|
+
|
|
1764
|
+
Use \-\-cursor from the previous response to paginate.
|
|
1765
|
+
Ownership:
|
|
1766
|
+
organization, org Search resources owned by your organization
|
|
1767
|
+
external Search resources outside your organization
|
|
1768
|
+
all Search both organization and external resources
|
|
1769
|
+
|
|
1770
|
+
Output modes:
|
|
1771
|
+
default Card list including basic overview and web link per result
|
|
1772
|
+
json Detailed JSON response with search metadata
|
|
1773
|
+
|
|
1774
|
+
Filter syntax:
|
|
1775
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
1776
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
1777
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
1778
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
1779
|
+
|
|
1780
|
+
\-\-filter\-json format:
|
|
1781
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
1782
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
1783
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
1784
|
+
|
|
1785
|
+
Shared filter fields:
|
|
1786
|
+
privateNetwork $eq, $ne (true/false)
|
|
1787
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
1788
|
+
visibility $eq, $ne (internal, public, partner)
|
|
1789
|
+
workspaceId $eq, $ne, $in, $nin
|
|
1790
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
1791
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
1792
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
1793
|
+
isGitConnected $eq, $ne (true/false)
|
|
1794
|
+
|
|
1795
|
+
Request\-only filter fields:
|
|
1796
|
+
collectionId $eq, $ne, $in, $nin
|
|
1797
|
+
method $eq, $ne, $in, $nin (GET, POST, PUT, PATCH, DELETE, etc.)
|
|
1798
|
+
requestId $eq, $ne, $in, $nin
|
|
1799
|
+
type $eq, $ne, $in, $nin
|
|
1800
|
+
Values can be like: http\-request, graphql\-request, grpc\-request, ws\-raw\-request,
|
|
1801
|
+
ws\-socketio\-request, mqtt\-request, llm\-request
|
|
1802
|
+
|
|
1803
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
1804
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
1805
|
+
|
|
1806
|
+
Examples:
|
|
1807
|
+
postman search requests "login"
|
|
1808
|
+
postman search requests "auth" \-\-filter "method=POST AND collectionId=collection\-uid\-1"
|
|
1809
|
+
postman search requests "upload" \-\-filter "method IN POST,PUT AND workspaceId=ws\-abc123"
|
|
1810
|
+
postman search requests "internal api" \-\-filter "method=POST AND privateNetwork=true"
|
|
1811
|
+
postman search requests "payment" \-\-ownership external \-\-limit 5 \-\-filter "visibility=public"
|
|
1812
|
+
postman search requests "auth" \-\-filter "method NIN GET" \-\-ownership org \-\-limit 10 \-\-output json
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
.SS "search collections"
|
|
1816
|
+
Search for collections by name or keyword.
|
|
1817
|
+
|
|
1818
|
+
.B Usage:
|
|
1819
|
+
[options] [query]
|
|
1820
|
+
|
|
1821
|
+
.TP Examples:
|
|
1822
|
+
|
|
1823
|
+
Use \-\-cursor from the previous response to paginate.
|
|
1824
|
+
Ownership:
|
|
1825
|
+
organization, org Search resources owned by your organization
|
|
1826
|
+
external Search resources outside your organization
|
|
1827
|
+
all Search both organization and external resources
|
|
1828
|
+
|
|
1829
|
+
Output modes:
|
|
1830
|
+
default Card list including basic overview and web link per result
|
|
1831
|
+
json Detailed JSON response with search metadata
|
|
1832
|
+
|
|
1833
|
+
Filter syntax:
|
|
1834
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
1835
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
1836
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
1837
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
1838
|
+
|
|
1839
|
+
\-\-filter\-json format:
|
|
1840
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
1841
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
1842
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
1843
|
+
|
|
1844
|
+
Shared filter fields:
|
|
1845
|
+
privateNetwork $eq, $ne (true/false)
|
|
1846
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
1847
|
+
visibility $eq, $ne (internal, public, partner)
|
|
1848
|
+
workspaceId $eq, $ne, $in, $nin
|
|
1849
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
1850
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
1851
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
1852
|
+
isGitConnected $eq, $ne (true/false)
|
|
1853
|
+
|
|
1854
|
+
Collection filter fields:
|
|
1855
|
+
collectionId $eq, $ne, $in, $nin
|
|
1856
|
+
tags $eq, $ne, $in, $nin
|
|
1857
|
+
|
|
1858
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
1859
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
1860
|
+
|
|
1861
|
+
Examples:
|
|
1862
|
+
postman search collections "payments"
|
|
1863
|
+
postman search collections "postman" \-\-filter "visibility=public"
|
|
1864
|
+
postman search collections "payments" \-\-ownership external \-\-limit 10 \-\-filter "visibility=public"
|
|
1865
|
+
postman search collections "internal" \-\-filter "workspaceId IN ws\-1,ws\-2"
|
|
1866
|
+
postman search collections "apis" \-\-filter "tags IN public,team\-api" \-\-output json
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
.SS "search workspaces"
|
|
1870
|
+
Search for workspaces by name or keyword.
|
|
1871
|
+
|
|
1872
|
+
.B Usage:
|
|
1873
|
+
[options] [query]
|
|
1874
|
+
|
|
1875
|
+
.TP Examples:
|
|
1876
|
+
|
|
1877
|
+
Use \-\-cursor from the previous response to paginate.
|
|
1878
|
+
Ownership:
|
|
1879
|
+
organization, org Search resources owned by your organization
|
|
1880
|
+
external Search resources outside your organization
|
|
1881
|
+
all Search both organization and external resources
|
|
1882
|
+
|
|
1883
|
+
Output modes:
|
|
1884
|
+
default Card list including basic overview and web link per result
|
|
1885
|
+
json Detailed JSON response with search metadata
|
|
1886
|
+
|
|
1887
|
+
Filter syntax:
|
|
1888
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
1889
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
1890
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
1891
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
1892
|
+
|
|
1893
|
+
\-\-filter\-json format:
|
|
1894
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
1895
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
1896
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
1897
|
+
|
|
1898
|
+
Shared filter fields:
|
|
1899
|
+
privateNetwork $eq, $ne (true/false)
|
|
1900
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
1901
|
+
visibility $eq, $ne (internal, public, partner)
|
|
1902
|
+
workspaceId $eq, $ne, $in, $nin
|
|
1903
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
1904
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
1905
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
1906
|
+
isGitConnected $eq, $ne (true/false)
|
|
1907
|
+
|
|
1908
|
+
Workspace filter fields:
|
|
1909
|
+
tags $eq, $ne, $in, $nin
|
|
1910
|
+
|
|
1911
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
1912
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
1913
|
+
|
|
1914
|
+
Examples:
|
|
1915
|
+
postman search workspaces "team"
|
|
1916
|
+
postman search workspaces "platform" \-\-ownership organization
|
|
1917
|
+
postman search workspaces "public apis" \-\-ownership external \-\-filter "visibility=public"
|
|
1918
|
+
postman search workspaces "trusted workspace" \-\-filter "privateNetwork=true"
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
.SS "search flows"
|
|
1922
|
+
Search for flows by name or keyword.
|
|
1923
|
+
|
|
1924
|
+
.B Usage:
|
|
1925
|
+
[options] [query]
|
|
1926
|
+
|
|
1927
|
+
.TP Examples:
|
|
1928
|
+
|
|
1929
|
+
Use \-\-cursor from the previous response to paginate.
|
|
1930
|
+
Ownership:
|
|
1931
|
+
organization, org Search resources owned by your organization
|
|
1932
|
+
external Search resources outside your organization
|
|
1933
|
+
all Search both organization and external resources
|
|
1934
|
+
|
|
1935
|
+
Output modes:
|
|
1936
|
+
default Card list including basic overview and web link per result
|
|
1937
|
+
json Detailed JSON response with search metadata
|
|
1938
|
+
|
|
1939
|
+
Filter syntax:
|
|
1940
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
1941
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
1942
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
1943
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
1944
|
+
|
|
1945
|
+
\-\-filter\-json format:
|
|
1946
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
1947
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
1948
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
1949
|
+
|
|
1950
|
+
Shared filter fields:
|
|
1951
|
+
privateNetwork $eq, $ne (true/false)
|
|
1952
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
1953
|
+
visibility $eq, $ne (internal, public, partner)
|
|
1954
|
+
workspaceId $eq, $ne, $in, $nin
|
|
1955
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
1956
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
1957
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
1958
|
+
isGitConnected $eq, $ne (true/false)
|
|
1959
|
+
|
|
1960
|
+
Flow filter fields:
|
|
1961
|
+
flowId $eq, $ne, $in, $nin
|
|
1962
|
+
|
|
1963
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
1964
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
1965
|
+
|
|
1966
|
+
Examples:
|
|
1967
|
+
postman search flows "onboarding"
|
|
1968
|
+
postman search flows "checkout" \-\-ownership organization \-\-limit 20
|
|
1969
|
+
postman search flows "billing" \-\-filter "workspaceId=ws\-abc123"
|
|
1970
|
+
postman search flows "internal" \-\-filter "flowId IN flow\-1,flow\-2"
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
.SS "search specs"
|
|
1974
|
+
Search for API specs by name or keyword.
|
|
1975
|
+
|
|
1976
|
+
.B Usage:
|
|
1977
|
+
[options] [query]
|
|
1978
|
+
|
|
1979
|
+
.TP Examples:
|
|
1980
|
+
|
|
1981
|
+
Use \-\-cursor from the previous response to paginate.
|
|
1982
|
+
Ownership:
|
|
1983
|
+
organization, org Search resources owned by your organization
|
|
1984
|
+
external Search resources outside your organization
|
|
1985
|
+
all Search both organization and external resources
|
|
1986
|
+
|
|
1987
|
+
Output modes:
|
|
1988
|
+
default Card list including basic overview and web link per result
|
|
1989
|
+
json Detailed JSON response with search metadata
|
|
1990
|
+
|
|
1991
|
+
Filter syntax:
|
|
1992
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
1993
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
1994
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
1995
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
1996
|
+
|
|
1997
|
+
\-\-filter\-json format:
|
|
1998
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
1999
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
2000
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
2001
|
+
|
|
2002
|
+
Shared filter fields:
|
|
2003
|
+
privateNetwork $eq, $ne (true/false)
|
|
2004
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
2005
|
+
visibility $eq, $ne (internal, public, partner)
|
|
2006
|
+
workspaceId $eq, $ne, $in, $nin
|
|
2007
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
2008
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
2009
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
2010
|
+
isGitConnected $eq, $ne (true/false)
|
|
2011
|
+
|
|
2012
|
+
API spec filter fields:
|
|
2013
|
+
specificationId $eq, $ne, $in, $nin
|
|
2014
|
+
|
|
2015
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
2016
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
2017
|
+
|
|
2018
|
+
Examples:
|
|
2019
|
+
postman search specs "openapi"
|
|
2020
|
+
postman search specs "my api spec" \-\-filter "specificationId=spec\-abc123"
|
|
2021
|
+
postman search specs "billing" \-\-ownership external
|
|
2022
|
+
postman search specs "payments" \-\-ownership external \-\-filter "publisherIsVerified=true AND visibility=public"
|
|
2023
|
+
|
|
2024
|
+
|
|
1585
2025
|
.SH SEE ALSO
|
|
1586
2026
|
Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
|
|
1587
2027
|
.SH AUTHOR
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.36.0",
|
|
4
4
|
"description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"postman",
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
"man/"
|
|
59
59
|
],
|
|
60
60
|
"optionalDependencies": {
|
|
61
|
-
"@postman/pm-bin-macos-arm64": "1.
|
|
62
|
-
"@postman/pm-bin-macos-x64": "1.
|
|
63
|
-
"@postman/pm-bin-linux-x64": "1.
|
|
64
|
-
"@postman/pm-bin-linux-arm64": "1.
|
|
65
|
-
"@postman/pm-bin-windows-x64": "1.
|
|
61
|
+
"@postman/pm-bin-macos-arm64": "1.36.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.36.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.36.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.36.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.36.0"
|
|
66
66
|
}
|
|
67
67
|
}
|