# 将 Postman 接入 Open Flow

Source: https://openflow.run/zh-cn/integrations/postman/

[全部集成](https://openflow.run/zh-cn/integrations/)

查看故障涉及的请求，或在发布前运行检查。

*   [135 个工具](https://openflow.run/zh-cn/integrations/postman/#integration-actions)
*   API 密钥
*   开发工具

[连接 Postman](https://console.openflow.run/connections/postman)

每月 20,000 次免费应用调用（付费服务另计）

## 可以做什么

可操作连接有权访问的工作区中的请求、集合、环境、规范和监控。

### 查看 API 请求

解释已保存请求的认证、内容和检查项。

### 运行 API 监控

发布前运行监控，核对测试汇总。

## 所有工具

135 个工具

### Create An Api

在 Postman 中创建新 API 的工具。当您需要在 Postman 工作区中创建具有名称、摘要和描述的 API 时使用。

`postman.create_an_api`

### Create An Environment

在 Postman 工作区中创建新环境的工具。当您需要为不同设置（开发、生产、测试等）创建具有变量的新环境时使用。成功创建后返回所创建环境的 ID、名称和 UID。

`postman.create_an_environment`

### Create A Collection

在特定工作区或默认工作区中创建新 Postman 集合的工具。当您需要创建具有工作区规范的集合时使用。有关完整集合格式详细信息，请参阅 Postman Collection Format 文档。

`postman.create_a_collection`

### Create A Collection Comment

在 API 的集合上创建评论的工具。当您需要向 API 中的特定集合添加评论时使用。要在现有评论上创建回复，请在请求中包含 thread\_id。

`postman.create_a_collection_comment`

### Create A Collection From A Schema

从 schema 创建集合并将其链接到具有指定关系的 API 的工具。注意：此端点在 Postman v10 及更高版本中已弃用。当您需要从 API schema 生成集合并建立契约测试或文档等关系时使用。

`postman.create_a_collection_from_a_schema`

### Create A Folder

在 Postman 集合中创建文件夹的工具。当您需要通过创建新文件夹来组织请求时使用。有关完整详细信息，请参阅 Postman Collection Format 文档。

`postman.create_a_folder`

### Create A Folder Comment

在文件夹上创建评论的工具。当您需要向集合中的特定文件夹添加评论时使用。

`postman.create_a_folder_comment`

### Create A Fork2

从现有环境创建分支到工作区的工具。当您需要将环境分支到指定工作区时使用。

`postman.create_a_fork2`

### Create A Mock Server

在 Postman 集合中创建新模拟服务器的工具。当您需要创建模拟服务器来模拟 API 端点以进行测试或开发时使用。返回已创建模拟服务器的详细信息，包括可用于发出请求的 mockUrl。

`postman.create_a_mock_server`

### Create A Monitor

在特定工作区中创建新监视器以按计划运行集合的工具。当您需要使用 cron 表达式在工作区内设置按指定间隔自动运行集合时使用。

`postman.create_a_monitor`

### Create A Pull Request

为分支集合向其父集合创建拉取请求的工具。当您需要提议将分支集合的更改合并到父集合时使用。创建拉取请求之前，分支集合必须存在。

`postman.create_a_pull_request`

### Create A Request

在 Postman 集合中创建新请求的工具。当您需要使用指定的方法、URL、标头和正文向现有集合添加请求时使用。

`postman.create_a_request`

### Create A Request Comment

用于在请求上创建评论的工具。当您需要在集合中的特定请求上添加评论或回复现有评论线程时使用。

`postman.create_a_request_comment`

### Create A Response

用于在 Postman 集合中创建请求响应的工具。当您需要在集合中的特定请求上添加保存的响应示例时使用。

`postman.create_a_response`

### Create A Response Comment

用于在响应上创建评论的工具。当您需要在集合中的特定响应上添加评论或回复现有评论线程时使用。

`postman.create_a_response_comment`

### Create A Schema

用于在 Postman 中为 API 创建模式的工具。当您需要向现有 API 添加模式定义（如 OpenAPI、GraphQL 或 Protocol Buffers）时使用。模式可以由单个或多个文件组成。成功创建后返回所创建模式的 ID 和元数据。

`postman.create_a_schema`

### Create A Server Response

用于在 Postman 模拟服务器上创建服务器响应的工具。当您需要模拟 5xx 服务器级响应（500、503 等）以测试错误条件时使用。

`postman.create_a_server_response`

### Create A Spec

用于在 Postman 的 Spec Hub 中创建 API 规范的工具。当您需要在工作区中创建单文件或多文件规范时使用。支持各种规范类型，包括 OpenAPI 3.0、OpenAPI 3.1 和 AsyncAPI 2.0。

`postman.create_a_spec`

### Create A Spec File

用于在 API 规范中创建新文件的工具。当您需要向现有规范添加新文件（如模式定义、路径配置或组件）时使用。

`postman.create_a_spec_file`

### Create A Webhook

用于创建 Webhook 以使用自定义载荷触发集合的工具。当您需要设置一个可以触发 Postman 集合运行的 Webhook 端点时使用。Webhook URL 在响应的 webhookUrl 属性中可用。

`postman.create_a_webhook`

### Create A Workspace

用于在 Postman 中创建新工作区的工具。当您需要使用指定的名称、类型（个人、团队、私有或公共）以及可选描述创建工作区时使用。成功创建后返回所创建工作区的 ID、名称和类型。

`postman.create_a_workspace`

### Create Or Update A Schema File

用于在 Postman 中创建或更新 API 模式文件的工具。当您需要在 API 模式中添加新的模式文件或修改现有文件时使用。需要 API ID、模式 ID、文件路径以及字符串化的 JSON 内容。

`postman.create_or_update_a_schema_file`

### Create Relations

用于为 API 版本创建新关系的工具。当您需要将集合或模拟服务器链接到 API 版本作为契约测试、测试套件、文档或模拟时使用。

`postman.create_relations`

### Delete An Api

用于从 Postman 删除 API 的工具。当您需要永久移除 API 时使用。成功时，返回 HTTP 204 无内容响应。

`postman.delete_an_api`

### Delete An Apis Comment

用于从 API 删除评论的工具。当您需要从特定 API 移除评论时使用。成功时，返回 HTTP 204 无内容响应，表示评论已成功删除。

`postman.delete_an_apis_comment`

### Delete An Environment

用于永久删除 Postman 中的环境的工具。当您需要移除不再需要的环境时使用。

`postman.delete_an_environment`

### Delete A Collection

用于从 Postman 永久删除集合的工具。当您需要移除不再需要的集合时使用。

`postman.delete_a_collection`

### Delete A Collections Comment

用于从 API 的集合中删除评论的工具。当您需要从集合中移除特定评论时使用。成功时，返回 HTTP 204 无内容。

`postman.delete_a_collections_comment`

### Delete A Folder

用于删除 Postman 集合中的文件夹的工具。当您需要从集合中移除文件夹及其所有内容时使用。文件夹 ID 不应包含空格，以避免 404 错误。

`postman.delete_a_folder`

### Delete A Folders Comment

用于从文件夹删除评论的工具。当您需要从文件夹中移除特定评论时使用。成功删除时返回 HTTP 204 无内容。

`postman.delete_a_folders_comment`

### Delete A Requests Comment

用于从请求删除评论的工具。当您需要从请求中移除特定评论时使用。成功时，返回 HTTP 204 无内容响应。

`postman.delete_a_requests_comment`

### Delete A Response

用于删除 Postman 集合中的响应的工具。当您需要从集合中移除已保存的响应时使用。

`postman.delete_a_response`

### Delete A Responses Comment

用于从响应删除评论的工具。当您需要从集合响应中移除特定评论时使用。成功删除时，返回 HTTP 204 无内容。

`postman.delete_a_responses_comment`

### Delete A Schema File

用于删除 API 模式中的文件的工具。当您需要从模式中移除特定文件时使用。成功时，返回 HTTP 204 无内容响应。

`postman.delete_a_schema_file`

### Delete A Server Response

用于删除模拟服务器的服务器响应的工具。当您需要从 Postman 模拟服务器中移除特定响应时使用。

`postman.delete_a_server_response`

### Delete A Spec

用于从 Postman 删除 API 规范的工具。当您需要永久移除规范时使用。成功时，返回 HTTP 204 无内容响应。

`postman.delete_a_spec`

### Delete A Spec File

用于从 API 规范中删除文件的工具。当您需要从多文件规范中移除特定文件时使用。

`postman.delete_a_spec_file`

### Delete A Workspace

用于永久删除 Postman 工作空间的工具。当您需要移除工作空间及其所有内容时使用。删除是永久性的，无法撤销。

`postman.delete_a_workspace`

### Delete Monitor

用于按 ID 删除监控器的工具。当您需要从 Postman 永久移除监控器时使用。必须提供监控器 ID 以标识要删除的监控器。

`postman.delete_monitor`

### Duplicate A Collection

用于在另一个工作空间中创建集合副本的工具。当您需要将现有集合复制到不同工作空间时使用。返回一个异步任务，可使用重复任务状态端点进行跟踪。

`postman.duplicate_a_collection`

### Fork Collection

用于在指定工作空间中创建集合分支的工具。当您需要将现有集合分支到工作空间时使用。

`postman.fork_collection`

### Generate A Collection From Spec

用于从 OpenAPI 2.0、3.0 或 3.1 规范生成 Postman 集合的工具。当您需要从现有 API 规范创建集合时使用。该操作是异步的，返回任务 ID 和轮询 URL 以检查生成状态。

`postman.generate_a_collection_from_spec`

### Generate Spec From Collection

用于从 Postman 集合生成 API 规范的工具。当您需要从现有集合创建 OpenAPI 3.0 规范时使用。该操作是异步的，返回任务 ID 和轮询 URL 以检查生成状态。

`postman.generate_spec_from_collection`

### Get Accounts

用于检索经过身份验证的团队的 Postman 计费账户详细信息的工具。当您需要访问账户信息（如账户 ID、团队 ID、账户状态、计费槽位、销售渠道或计费电子邮件）时使用。

`postman.get_accounts`

### Get All Apis

用于获取经过身份验证的用户可访问的所有 APIs，并可选择按工作空间过滤。当您需要列出或检索 Postman 中的 APIs 时使用。返回 API 对象数组，包含其 IDs、名称、摘要和其他元数据。

`postman.get_all_apis`

### Get All Api Releases

工具：获取 Postman 中特定 API 版本的所有发布。当需要列出某个 API 版本的发布时使用。注意：此端点在 Postman v10 及更高版本中已弃用。

`postman.get_all_api_releases`

### Get All Collections2

工具：获取认证用户可访问的所有集合。当需要检索所有集合（包括已订阅的集合）时使用。返回每个集合的详细信息，包括所有者、创建/更新时间戳和可见性。

`postman.get_all_collections2`

### Get All Environments

工具：获取认证用户可访问的所有环境，可进行可选的工作区过滤。当需要列出或检索 Postman 中的环境时使用。返回环境对象数组，包含其 IDs、名称和 UID。

`postman.get_all_environments`

### Get All Forked Collections

工具：检索认证用户的所有分叉集合。当需要列出或访问用户已分叉的所有集合时使用。

`postman.get_all_forked_collections`

### Get All Groups

工具：获取 Postman 团队中的所有用户组。当需要列出所有组及其详细信息（包括成员计数和时间戳）时使用。返回组对象数组，包含其 IDs、名称、团队 IDs、用户计数以及创建/更新时间戳。

`postman.get_all_groups`

### Get All Linked Relations

工具：检索 Postman 中特定 API 版本的所有关联关系。当需要发现哪些集合、文档、模拟或监视器链接到某个 API 版本时使用。

`postman.get_all_linked_relations`

### Get All Mock Servers

工具：获取认证用户可访问的所有活动模拟服务器。当需要列出或检索 Postman 中的模拟服务器时使用。默认情况下，仅返回您在所有工作区中创建的模拟服务器。可按工作区 ID 过滤以获取特定工作区的模拟服务器。

`postman.get_all_mock_servers`

### Get All Monitors

工具：获取认证用户可访问的所有监视器，可进行可选的工作区过滤。当需要列出或检索 Postman 中的监视器时使用。返回监视器对象数组，包含其 IDs、名称和 UID。

`postman.get_all_monitors`

### Get All Specs

工具：获取工作区中的所有 API 规范。当需要列出或检索特定 Postman 工作区中的 API 规范时使用。返回规范对象数组，包含其 IDs、名称、类型和时间戳，以及分页元数据。

`postman.get_all_specs`

### Get All Team Users

工具：获取 Postman 团队中所有用户的信息。当需要列出所有团队成员及其详细信息（包括角色和加入日期）时使用。返回用户对象数组，包含其 IDs、名称、用户名、电子邮件、角色和加入时间戳。

`postman.get_all_team_users`

### Get All Test Relations

工具：检索特定 API 版本的所有测试关系。当需要获取与某个 API 版本关联的测试关系时使用。注意：此端点在 Postman v10 及更高版本中已弃用。

`postman.get_all_test_relations`

### Get All Versions

工具：获取 Postman 中特定 API 的所有已发布版本。当需要列出或检索某个 API 的版本信息时使用。返回版本对象数组，包含其 IDs 和名称。

`postman.get_all_versions`

### Get All Workspaces

工具：获取认证用户可访问的所有工作区，可进行可选的类型过滤。当需要列出或检索 Postman 中的工作区时使用。返回工作区对象数组，包含其 IDs、名称和类型。

`postman.get_all_workspaces`

### Get An Api

工具：检索 Postman 中特定 API 的信息。当需要获取 API 详细信息（包括名称、描述、版本和模式）时使用。

`postman.get_an_api`

### Get An Apis Comments

工具：检索用户在某个 API 中留下的所有评论。当需要获取与特定 API 关联的所有评论时使用。

`postman.get_an_apis_comments`

### Get An Api Version

用于获取 Postman 中特定 API 版本信息的工具。当您需要检索特定版本 API 的详细信息时使用。返回版本详细信息，包括 ID、名称、创建日期和关联的架构。

`postman.get_an_api_version`

### Get An Environment

用于检索 Postman 中特定环境详细信息的工具。当您需要获取环境详细信息（包括名称、ID、所有者和所有环境变量）时使用。

`postman.get_an_environment`

### Get An Environments Forks

用于检索特定环境的所有分叉环境的工具。当您需要列出从特定环境分叉出的所有环境时使用。

`postman.get_an_environments_forks`

### Get Async Collection Update Status

用于获取异步集合更新任务状态的工具。当您需要检查先前发起的异步集合更新是否仍在处理、已成功完成或已失败时使用。任务 ID 从使用 Prefer: respond-async 标头的 PUT /collections/{collectionId} 端点获取。

`postman.get_async_collection_update_status`

### Get Authenticated User

用于获取已认证用户信息的工具。当您需要检索当前已认证用户的详细信息（包括其用户 ID、用户名和电子邮件地址）时使用。

`postman.get_authenticated_user`

### Get A Collections Comments

用于检索用户在 API 集合中留下的所有评论的工具。当您需要获取与 API 中特定集合关联的所有评论时使用。

`postman.get_a_collections_comments`

### Get A Collections Forks

用于获取特定集合的所有分叉的工具。当您需要检索谁分叉了集合的信息（包括分叉 IDs、用户和创建日期）时使用。

`postman.get_a_collections_forks`

### Get A Collections Pull Requests

用于获取集合拉取请求信息的工具，包括源和目标 IDs、状态和 URL。当您需要检索特定集合的拉取请求详细信息时使用。

`postman.get_a_collections_pull_requests`

### Get A Collections Roles

用于获取集合中所有角色信息的工具。当您需要检索有权查看或编辑集合的所有用户、团队和组的 IDs 时使用。

`postman.get_a_collections_roles`

### Get A Folder

用于检索 Postman 集合中文件夹信息的工具。当您需要获取特定文件夹的详细信息（包括其名称、描述、所有者和时间戳）时使用。

`postman.get_a_folder`

### Get A Folders Comments

用于检索用户在文件夹中留下的所有评论的工具。当您需要获取与集合中特定文件夹关联的所有评论时使用。

`postman.get_a_folders_comments`

### Get A Monitor

用于检索 Postman 中特定监控器信息的工具。当您需要获取监控器详细信息（包括计划、集合、环境和运行状态）时使用。

`postman.get_a_monitor`

### Get A Request

用于检索 Postman 集合中特定请求信息的工具。当您需要获取请求的详细信息（包括其方法、URL、标头、正文、身份验证和关联脚本）时使用。

`postman.get_a_request`

### Get A Requests Comments

工具，用于检索用户在请求中留下的所有评论。当您需要获取集合中特定请求关联的所有评论时使用。

`postman.get_a_requests_comments`

### Get A Response

工具，用于检索 Postman 集合中已保存响应的信息。当您需要获取特定响应的详细信息（包括状态、请求头、请求体和元数据）时使用。

`postman.get_a_response`

### Get A Responses Comments

工具，用于检索用户在响应中留下的所有评论。当您需要获取集合中特定响应关联的所有评论时使用。

`postman.get_a_responses_comments`

### Get A Schema

工具，用于从 Postman 检索 API 模式的信息。当您需要获取特定 API 的模式详细信息时使用。可选地指定版本 ID 以获取在特定 API 版本中发布的模式。

`postman.get_a_schema`

### Get A Spec

工具，用于检索 Postman 中 API 规范的信息。当您需要获取规范详细信息（包括名称、类型和时间戳）时使用。

`postman.get_a_spec`

### Get A Specs Definition

工具，用于获取 API 规范定义的完整内容。当您需要检索规范的完整 OpenAPI/Swagger 规范内容时使用。返回原始定义内容作为字符串。

`postman.get_a_specs_definition`

### Get A Specs Files

工具，用于从 Postman 检索 API 规范中的所有文件。当您需要列出或查看特定规范 ID 的规范文件时使用。返回文件元数据，包括 IDs、名称、路径、类型和时间戳。

`postman.get_a_specs_files`

### Get A Specs Generated Collections

工具，用于从 Postman 检索由 API 规范生成的所有集合。当您需要获取从规范自动生成的集合时使用。返回元数据和生成的集合数组。

`postman.get_a_specs_generated_collections`

### Get A Spec File

工具，用于获取 API 规范文件的内容。当您需要检索规范中特定文件的实际内容和元数据时使用。

`postman.get_a_spec_file`

### Get A Team User

工具，用于获取 Postman 团队中用户的信息。当您需要检索特定团队成员详细信息（包括其 ID、姓名、电子邮件、角色和加入日期）时使用。

`postman.get_a_team_user`

### Get A Workspace

工具，用于通过其 ID 获取特定工作区的详细信息。当您需要检索工作区的完整结构（包括所有集合、环境、APIs、模拟服务器和监视器）时使用。

`postman.get_a_workspace`

### Get A Workspaces Activity Feed

工具，用于获取工作区的活动源，显示谁添加或删除了集合、环境或元素，以及用户加入或离开。当您需要跟踪工作区更改和用户活动时使用。

`postman.get_a_workspaces_activity_feed`

### Get A Workspaces Roles

工具，用于获取工作区中用户、用户组和合作伙伴的角色。当您需要检索角色分配并了解谁对特定工作区拥有何种访问级别时使用。

`postman.get_a_workspaces_roles`

### Get Collection Access Keys

工具，用于检索已认证用户的所有个人和团队集合访问密钥。当您需要列出或管理集合访问密钥时使用。返回访问密钥对象数组，包含其 IDs、令牌、状态和关联的集合信息。

`postman.get_collection_access_keys`

### Get Contract Test Relations

工具，用于检索特定 API 版本的契约测试关系。当您需要检查契约测试关联时使用。注意：此端点已弃用，可能返回有限或无数据。

`postman.get_contract_test_relations`

### Get Documentation Relations

工具：获取特定 API 版本的文档关系。此端点在 Postman v10 及更高版本中已弃用。

`postman.get_documentation_relations`

### Get Duplication Task Status

用于获取集合复制任务状态的操作。当需要检查之前发起的集合复制是否仍在处理中或已完成时使用。任务 ID 必须首先从 POST /collections/{collectionId}/duplicates 端点获取。

`postman.get_duplication_task_status`

### Get Environment Relations

用于获取特定 API 版本的环境关系的操作。此端点在 Postman v10 及更高版本中已弃用。

`postman.get_environment_relations`

### Get Generated Spec

用于检索为 Postman 集合生成的 API 规范的操作。当需要获取从集合自动生成的 OpenAPI/Swagger 规范时使用。返回元数据和生成的规范数组。

`postman.get_generated_spec`

### Get Global Variables

用于获取工作区全局变量的操作。当需要检索工作区中可用的全局变量，以便在集合、请求、脚本和环境之间访问时使用。请注意，此端点仅适用于个人或团队工作区，不适用于公共工作区。

`postman.get_global_variables`

### Get Integration Test Relations

用于获取特定 API 版本的集成测试关系的操作。此端点已弃用，可能不会返回活动数据。

`postman.get_integration_test_relations`

### Get Resource Types

用于获取 Postman 的 SCIM API 支持的所有资源类型的操作。当需要发现 SCIM API 中可用的资源类型（例如，User、Group）及其对应的端点和模式时使用。

`postman.get_resource_types`

### Get Schema Files

用于从 Postman 检索 API 模式中的文件的操作。当需要列出或查看特定 API 和模式 ID 的模式文件时使用。可选地按版本 ID 过滤，以获取特定 API 版本的文件。

`postman.get_schema_files`

### Get Schema File Contents

用于获取指定路径下 API 模式文件内容的操作。当需要检索模式文件的实际内容时使用。可选地指定版本 ID 以获取特定 API 版本的文件内容。

`postman.get_schema_file_contents`

### Get Service Provider Configuration

用于获取 Postman 的 SCIM API 服务提供商配置信息的操作。当需要发现支持的 SCIM 操作、功能和身份验证方案时使用。此端点返回配置详情，包括对 PATCH、批量操作、过滤、排序和 ETag 处理的支持。

`postman.get_service_provider_configuration`

### Get Source Collections Status

用于检查分叉集合与其父（源）集合之间是否有更改的操作。当需要确定源集合是否有尚未在分叉集合中的更新时使用。此端点仅适用于分叉集合；尝试将其用于常规集合将导致错误。

`postman.get_source_collections_status`

### Get Test Suite Relations

用于获取特定 API 版本的测试套件关系的操作。当需要检索与 API 版本关联的测试套件时使用。注意：此端点已弃用，仅适用于旧版 v9 APIs。对于 v10+ APIs，此端点返回空数组。

`postman.get_test_suite_relations`

### Get Unclassified Relations

用于获取 Postman 中 API 版本的未分类关系的操作。当需要检索特定 API 版本的未分类关系时使用。此端点适用于 Postman v10 及更高版本。

`postman.get_unclassified_relations`

### Import Openapi

用于将 OpenAPI 规范导入 Postman 作为新集合的操作。当需要将 OpenAPI 3.0+规范转换为特定工作区中的 Postman 集合时使用。导入的规范将自动转换为 Postman 集合，包含所有端点、请求参数和文档。

`postman.import_openapi`

### List Account Invoices

用于获取 Postman 计费账户按状态过滤的所有发票的操作。当需要检索账户的发票历史时使用。账户 ID 必须首先从 GET /accounts 端点获取。

`postman.list_account_invoices`

### Merge A Fork

用于将分叉集合合并回其父集合的操作。此端点已弃用。当需要将分叉集合的更改合并到父集合中时使用。

`postman.merge_a_fork`

### Merge A Fork2

用于将分叉环境合并回其父环境的操作。当需要将分叉环境的更改合并到父环境中时使用。

`postman.merge_a_fork2`

### Publish A Mock Server

用于在 Postman 中发布模拟服务器的操作。当需要使模拟服务器可公开访问时使用。发布会将模拟服务器的访问控制配置设置为公共。

`postman.publish_a_mock_server`

### Pull Source Changes2

用于将父（源）集合的更改拉取到分叉集合中的操作。当需要将分叉集合与其父集合同步时使用。

`postman.pull_source_changes2`

### Replace An Environments Data

用于完全替换环境数据的工具，使用新的变量和值。当您需要更新整个环境并替换其所有内容时使用。此操作会将请求中提供的变量替换所有现有变量。

`postman.replace_an_environments_data`

### Replace Collections Data Asynchronously

用于异步替换集合全部内容的工具。当您需要完全替换集合为新数据时使用。重要提示：在 item、variable 和其他嵌套对象中包含集合的 ID 值以保留它们。如果不包含 IDs，现有项目将被移除并创建新项目。

`postman.replace_collections_data_asynchronously`

### Resolve A Comment Thread

用于解决评论线程及其所有相关回复的工具。当您需要将评论线程标记为已解决时使用。成功时，此操作返回 HTTP 204 无内容响应。

`postman.resolve_a_comment_thread`

### Review A Pull Request

通过批准、拒绝或取消批准来更新拉取请求的审查状态的工具。当您需要对 Postman 拉取请求执行审查操作时使用。

`postman.review_a_pull_request`

### Run A Monitor

用于触发监视器立即运行并检索其执行结果的工具。当您需要在计划运行之外手动执行监视器时使用。

`postman.run_a_monitor`

### Sync Collection With Schema

用于将附加到 API 的集合与 API schema 同步的工具。这是一个异步端点，返回 HTTP 202 已接受。当您需要将集合与 API schema 的更改同步时使用。集合必须已附加到 API。返回可用于检查同步操作状态的任务 ID。

`postman.sync_collection_with_schema`

### Sync Collection With Spec

用于同步从 API 规范生成的集合的工具。这是一个异步操作，返回 HTTP 202 已接受。当您需要更新集合以匹配其源 API 规范的最新版本时使用。集合必须是从规范生成的。

`postman.sync_collection_with_spec`

### Sync Spec With Collection

用于将 API 规范与关联集合同步的工具。这是一个异步操作，返回 HTTP 202 已接受并带有任务跟踪信息。当您需要将生成的集合中的更改同步回其源规范时使用。前提条件：集合必须从规范生成，且规范必须是单文件。

`postman.sync_spec_with_collection`

### Transfer Folders

用于将文件夹复制或移动到集合或文件夹中的工具。当您需要通过将文件夹在集合之间或文件夹之间转移来重新组织集合时使用。

`postman.transfer_folders`

### Transform Collection To Openapi

用于将现有 Postman 集合转换为字符串化的 OpenAPI 3.0.3 定义的工具。当您需要将集合转换为 OpenAPI 格式以用于 API 文档或与其他工具互操作时使用。

`postman.transform_collection_to_openapi`

### Update An Api

用于更新 Postman 中现有 API 的工具。当您需要修改 API 的名称、摘要或描述时使用。

`postman.update_an_api`

### Update An Apis Comment

用于更新 API 上评论的工具。当您需要修改特定 API 上现有评论的文本内容时使用。

`postman.update_an_apis_comment`

### Update An Environment

使用 JSON Patch 操作（RFC 6902）更新特定环境属性的工具。当您需要修改环境名称或变量而不替换整个环境时使用。

`postman.update_an_environment`

### Update A Folder

用于更新 Postman 集合中文件夹的工具。当您需要修改现有文件夹的名称或描述时使用。有关完整属性和信息，请参阅 Postman Collection Format 文档。

`postman.update_a_folder`

### Update A Folders Comment

用于更新文件夹上评论的工具。当您需要修改集合中特定文件夹上现有评论的文本内容时使用。

`postman.update_a_folders_comment`

### Update A Mock Server

用于更新现有模拟服务器的工具。当您需要更改模拟服务器的名称、集合、环境或隐私设置时使用。所有更新都需要集合 UID。

`postman.update_a_mock_server`

### Update A Monitor

用于更新 Postman 中现有监控器的工具。当需要修改监控器的属性（如名称、活动状态、集合、环境、选项、通知或分发设置）时使用。

`postman.update_a_monitor`

### Update A Pull Request

用于更新 Postman 中打开的拉取请求的工具。当需要修改现有拉取请求的标题、描述、源、目标或审阅者时使用。请求中必须提供所有字段。

`postman.update_a_pull_request`

### Update A Request

用于更新 Postman 集合中请求的工具。当需要按照 Postman Collection Format 修改现有请求的名称、方法、URL、标头或请求体时使用。

`postman.update_a_request`

### Update A Requests Comment

用于更新请求评论的工具。当需要修改集合中特定请求上现有评论的文本内容时使用。

`postman.update_a_requests_comment`

### Update A Response

用于更新 Postman 集合中响应的工具。当需要修改现有已保存响应示例的属性（如名称、状态、代码、标头、Cookie 或请求体）时使用。

`postman.update_a_response`

### Update A Responses Comment

用于更新响应评论的工具。当需要修改集合中特定响应上现有评论的文本内容时使用。

`postman.update_a_responses_comment`

### Update A Server Response

用于更新模拟服务器服务器响应的工具。当需要修改现有服务器响应的属性（如名称、状态代码、语言、请求体或标头）时使用。更新请求中必须至少包含一个属性。

`postman.update_a_server_response`

### Update A Specs Properties

用于更新 API 规范属性（如其名称）的工具。当需要修改现有规范的元数据时使用。

`postman.update_a_specs_properties`

### Update A Spec File

用于更新 API 规范文件内容的工具。当需要修改规范中特定文件的内容时使用。

`postman.update_a_spec_file`

### Update A Workspace

用于更新 Postman 中现有工作区的工具。当需要修改工作区的名称、类型或描述时使用。所有更新都需要 'type' 字段。

`postman.update_a_workspace`

### Update Global Variables

用于更新和替换工作区全局变量的工具。当需要设置或替换工作区中的所有全局变量时使用。注意：此端点会用提供的列表替换所有现有全局变量。

`postman.update_global_variables`

### Update Part Of A Collection

用于更新特定集合属性（如名称、描述、认证、变量或事件）的工具。当需要部分更新集合而不替换整个集合结构时使用。应用更改后返回更新后的集合信息。

`postman.update_part_of_a_collection`

没有符合搜索条件的工具。

## 将 Postman 接入 Open Flow

[连接 Postman](https://console.openflow.run/connections/postman)

每月 20,000 次免费应用调用（付费服务另计）
