Postman

Adds a collection to an API. To do this, use the following `operationType` values: - `COPY_COLLECTION` — Copies a collection from the workspace and adds it to an API. - `CREATE_NEW` — Creates a new collection by providing the new collection's content. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). - `GENERATE_FROM_SCHEMA` — Generates the collection from an API schema. - `options` — An **object** that contains advanced creation options and their values. You can find a complete list of properties and their values in Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive. For examples of each method, see the collection's response examples.

Publishes a workspace in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).

Adds discovered services to the API Catalog. Accepts up to 20 services in a single call.

Adds workspace-environment associations to a system environment.

Performs an analysis on the given definition and returns any issues based on your [predefined rulesets](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/). This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation. **Note:** - The maximum allowed size of the definition is 10 MB. - You must [import and enable](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-governance-rules/) Postman's [OWASP security rules](https://postman.postman.co/api-governance/libraries/postman_owasp/view) for this endpoint to return any security rule violations.

Approve or deny a team's access request.

Connects a Postman source element (collection or specification) to a Git repository for one SDK language. This creates a new connection in the `active` state. **Note:** - Each source and language pair maps to a single connection. If a connection already exists for the pair, this returns `409 Conflict` response. - To update an existing connection, use the PUT `/sdk-git-connections/{sdkGitConnectionId}` endpoint. - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users. If the user is on a **Team** plan, this value is always `false`.

Creates a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when creating a collection. For additional ways to create a collection, see the collection's examples. - If you do not include the `workspace` query parameter, the system creates the collection in the oldest personal Internal workspace you own.

Creates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters.

Creates a comment on an API's collection. To create a reply on an existing comment, include the `threadId` property in the request body. Include the following in request body: - `body` — (Required) A **string** that contains the comment. - `threadId` — An **integer** that contains the comment's thread ID. - `tags` — An **object** that contains information about users tagged in the `body` comment. Include the following in this object: - `userName` — (Required) An **object** that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. Include the following in this object: - `type` — (Required) A **string** that contains the `user` value. - `id` — (Required) An **integer** that contains the user's ID. **Note:** This endpoint accepts a max of 10,000 characters.

**This endpoint is deprecated in Postman v10 and higher.** Creates a collection and links it to an API as one or multiple relations. Include the following properties in the request body: - `name` — A **string** that contains the name of the collection. You can also include the following additional properties in the request body: - `relations` — An **array** that contains a list of relations to create: - `contracttest` — **Deprecated.** - `integrationtest` — **Deprecated.** - `testsuite` — **Deprecated.** - `documentation` - `options` — An **object** that contains advanced creation options and their values. You can find a complete list of properties and their values in Postman's [OpenAPI 3.0 to Postman Collection v2.1.0 Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). **These properties are case-sensitive.**

Creates a new component. The component is created in an active state with an initial draft. Use the POST `/components/{componentId}/versions` endpoint to publish a version.

Publishes a new version of a component from the current draft. **Note:** You can't publish a new version of an archived component. Unarchive the component before publishing a new version.

Creates a folder in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the `requests` field and the list of request objects in the request body. For more information, see the provided examples. **Note:** - This request uses example values in the request body for context when creating collection folders. For additional ways to create a folder, see the collection's examples. - It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

Creates a comment on a folder. **Note:** This endpoint accepts a max of 10,000 characters.

Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace.

Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) from an existing environment into a workspace.

Creates a new user group in Postman and creates a new account for each group member. Each account is added to your Postman team and authentication is activated for each user. If an existing Postman account uses an email that matches a group member's email ID, an [email invite](https://postman.postman.co/docs/administration/managing-your-team/managing-your-team/#invites) to join your Postman team is sent to that user. Once the user accepts the invite, they'll be added to your team. By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/#managing-team-roles).

Creates a mock server in a collection. **Note:** - You cannot create mocks for collections added to an API definition. - If you do not include the `workspaceId` query parameter, the system creates the mock server in the oldest personal Internal workspace you own.

Creates a monitor. **Note:** - You cannot create monitors for collections added to an API definition. - If you do not include the `workspace` query parameter, the system creates the monitor in the oldest personal Internal workspace you own.

Creates an access request for a team. Access requests include actions such as request to join a team, upgrading a user's role, adding members, and requesting team role access to another team. **Note:** If a team discovery is enabled, the team's access request is automatically approved.

Creates an API.

Creates a comment on an API. Include the following in request body: - `body` — (Required) A **string** that contains the comment. - `threadId` — An **integer** that contains the comment's thread ID. - `tags` — An **object** that contains information about users tagged in the `body` comment. Include the following in this object: - `userName` — (Required) An **object** that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. Include the following in this object: - `type` — (Required) A **string** that contains the `user` value. - `id` — (Required) An **integer** that contains the user's ID. **Note:** This endpoint accepts a max of 10,000 characters.

**This endpoint is deprecated in Postman v10 and higher.** Creates a new API version release. Include the following properties in the `release` object: - `name` — A **string** value that contains the release name. - `visibility` — A **string** value that contains the release's visibility. One of: - `private` — The release is private. - `public` — The release is public. You can include the following optional properties: - `summary` — A **string** value that contains the release's summary. - `description` — A **string** value that contains the release's description. - `gitTag` — A **string** value that contains a valid [Git tag](https://docs.github.com/en/rest/git/tags) ID. The tag must exist in the API's connected Git repository.

Creates an environment. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - If you do not include the `workspace` query parameter, the system creates the environment in the oldest personal Internal workspace you own. - Only [<u>shared variable</u>](https://learning.postman.com/docs/sending-requests/variables/variables#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.

Creates a package and its index script as a Postman Package Library resource.

Creates a pull request for a forked collection into its parent collection.

Creates a request in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when creating detailed collection requests. For additional ways to create a request, see the collection's examples. - It is recommended to include at least the `name` property in the request to avoid creating a request with a blank name.

Creates a comment on a request. **Note:** This endpoint accepts a max of 10,000 characters.

Creates a request response in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when creating detailed collection responses. For additional ways to create a response, see the collection's examples. - It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

Creates a comment on a response. **Note:** This endpoint accepts a max of 10,000 characters.

Creates a schema for an API. Include the following in the the request body: - `type` — A **string** value that contains the API schema's type. One of: - `openapi:3_1` - `openapi:3` - `openapi:2` - `openapi:1` - `raml:0_8` - `raml:1` - `wsdl:1` - `wsdl:2` - `graphql` - `proto:2` - `proto:3` - `asyncapi:2` - `files` — An **array** of schema files that contains the following: - `path` — A **string** value that contains the schema file's path. - `content` — A **string** value that contains the schema file's stringified contents.

**This endpoint is deprecated in Postman v10 and higher.** Creates an API definition. The request body must contain a `schema` object with the following properties: - `type` — A **string** value that contains the API definition's type. One of: - `openapi3_1` - `openapi3` - `openapi2` - `openapi1` - `raml` - `raml1` - `wsdl1` - `wsdl2` - `graphql` - `proto2` - `graphql` - `proto3` - `language` — A **string** value that contains the API definition's language. One of: - OpenAPI and RAML — `json` or `yaml` - GraphQL — `graphql` - WSDL — `xml` - Protobuf — `proto` - `schema` — A **string** value that contains the API definition's contents.

Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503. Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior on a mock server. You do not need to define each error for all exposed paths on the mock server. If you set a server response as active, then all the calls to the mock server return with that active server response. **Note:** You can create multiple server responses for a mock server, but only one mock server can be set as active.

Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications. - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Multi-file specifications can only have one root file and only support OpenAPI 2.0, 3.0, and 3.1 and protobuf 2 and protobuf 3 specifications. - Files cannot exceed a maximum of 12 MB in size.

Creates a file for OpenAPI specifications and protobuf 2 and 3 specifications. **Note:** - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Creating a spec file assigns it the `DEFAULT` file type. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 10 MB in size.

Creates a system environment for the authenticated team.

[Creates](https://learning.postman.com/docs/administration/managing-your-team/create-teams/) a Postman team in your organization.

Creates a new user account in Postman and adds the user to your organization's Postman team. - If the account does not exist, this also activates the user so they can authenticate in to your Postman team. - If an account matching the email ID exists, the user receives [email invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites) to join the Postman team. The user joins the team when they accept the invite. - If the user's email domain matches your team's verified domains, the user is immediately added to the team. By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-team-roles). **Note:** - Users must join the team before you can assign them to any groups. - If the user is a member of a different team during SCIM provisioning and their email domain is **not** verified with your Postman team, then the user is **not** provisioned. The endpoint returns an HTTP `409 Conflict` response.

Creates a version tag for a specification. Version tags are snapshots of a specification at a point in time that let you to track changes to your specifications over time. **Note:** Conflicts can occur if you try to create a version tag for a changelog group that already has a version tag. To resolve this, make new changes to the specification to create a new changelog group, then create a version tag on that new changelog group.

Creates a webhook that triggers a collection with a custom payload. You can get the webhook's URL from the `webhookUrl` property in the endpoint's response. **Note:** If you do not include the `workspace` query parameter, the system creates the webhook in the oldest personal Internal workspace you own.

Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces. - Private and [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [<b>Team</b> and <b>Enterprise</b> plans](https://www.postman.com/pricing). - There are rate limits when publishing public workspaces. - Public team workspace names must be unique. - The `teamId` property must be passed in the request body if [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) is enabled.

Creates a [workspace update](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/workspace-updates) in the given workspace. Workspace updates keep workspace watchers informed about changes, such as new features, bug fixes, breaking changes, and announcements.

Creates or updates an API schema file. Include the following in the request body: - `content` — A **string** value that contains the schema file's stringified contents. **Note:** - If the provided file path exists, the file is updated with the new contents. - If the provided file path does <u>not</u> exist, then a new schema file is created. - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the file path is the `dir/schema.json` value, then a `dir` folder is created with the `schema.json` file inside. - You can only update the `root` tag for protobuf specifications.

Creates a new relation for an API version. Include the following in the request body: - `relationType` — An **array** that contains entity relations. The key value for this array must be the `unclassified` value. You must include the following properties in the `relationType` array: - `entityId` — The collection's UID value. **Note:** The following is **deprecated** in Postman API v10 and higher: | **`relationType`** | **`entityId`** | | --- | --- | | `documentation` and `test` | A collection UID value. | | `environment` | An environment UID value. | | `mock` | A mock ID value. | | `monitor` | A monitor ID value. | The endpoint accepts multiple `relationType` arrays in a single call. For an example, see the example response documentation. The `documentation` and `test` values returned in the response are the relation ID values, **not** the collection ID values.

Deletes a collection.

Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

Deletes a comment from an API's collection. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

Deletes a folder in a collection.

Deletes a comment from a folder. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response. User accounts that were in the deleted group are deactivated in Postman if the app is assigned to the user only with the deleted group. User accounts and the data corresponding to them are **not** deleted. To permanently delete user accounts and their data, [contact Postman support](https://www.postman.com/support/).

Deletes a mock server.

Deletes a monitor.

**This endpoint is deprecated in Postman v10 and higher.** Deletes an API version's release.

Deletes a comment from an API. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

**This endpoint is deprecated in Postman v10 and higher.** Deletes an API version.

Deletes an environment.

Deletes an SDK record and its stored archive. On success, this returns a `204 No Content` response. **Note:** You can't use this endpoint to cancel a generation job that's still in progress.

Deletes the package and its associated index script content. On success, this returns an HTTP `204 No Content` response. **Note:** The endpoint returns an HTTP `204 No Content` response even if the package no longer exists.

Deletes a request in a collection.

Deletes a comment from a request. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

Deletes a response in a collection. On success, this returns an HTTP `204 No Content` response.

Deletes a comment from a response. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

Deletes a file in an API schema. On success, this returns an HTTP `204 No Content` response.

Deletes a mock server's server response.

Deletes an API specification. On success, this returns an HTTP `204 No Content` response.

Deletes a file in an API specification. On success, this returns an HTTP `204 No Content` response.

Deletes an API version. On success, this returns an HTTP `204 No Content` response. **Note:** This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.

Deletes an existing workspace.

Deletes a workspace update. On success, this returns an HTTP `204 No Content` response.

Creates a duplicate of the given collection in another workspace. Use the GET `/collection-duplicate-tasks/{taskId}` endpoint to get the duplication task's current status.

Creates a collection from the given OpenAPI 2.0, 3.0, 3.1 specification or Smithy specification. The response contains a polling link to the task status.

Creates an asynchronous generation job for a single SDK (in one language) from a collection or specification. To get the status of an SDK's generation, use the GET `/sdks/{sdkId}` endpoint and track its `buildStatus`. When the status is the `succeeded` value, the SDK is ready to download. You can also use the URL in the POST response's `Location` header. **Note:** The request body is determined by the given `language` value, so only provide the properties relevant to that language's SDK.

Generates code for an AI agent tool using a collection and request from the Public API Network. For more information, see [<b>Tool Generation Demo</b>](http://postman.com/explore/toolgen) in Postman's Public API Network. Include the following in your request: - `collectionId` — A **string** value that contains the Public API Network collection's ID. - `requestId` — A **string** value that contains the public request ID. - `config` — An **object** that contains the following properties: - `language` — A **string** value that contains the programming language to use to generate the request. Accepts `javascript`, `typescript`, or `python`. - `agentFramework` — A **string** value that contains the AI agent framework to use. Accepts `openai`, `mistral`, `gemini`, `anthropic`, `langchain`, or `autogen` (Python only). ### Important - This endpoint has a rate limit of **300 calls every 3 hours**. This does not accrue Postbot usage. - This endpoint only supports public Postman Collections and requests.

Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status.

Gets Postman billing account details for the given team.

Gets information about a collection. For a complete list of this endpoint's possible values, use the [collection.json schema file](https://schema.postman.com/json/collection/v2.1.0/collection.json).

Gets all comments left by users in a collection.

Gets all comments left by users in an API's collection.

Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date.

Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.

Gets information about all [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection.

Gets all the tags associated with a collection.

Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version. **Note:** - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers. - You can get a collection published in an API version with the `versionId` query parameter. - The `versionId` query parameter is a **required** parameter for API viewers.

Gets information about a component. Use the `include` and `expand` query parameters to return additional information, such as `hasVersions` and the latest published version.

Gets information about the current working draft of a component, including its content and format. Drafts represent the latest unpublished edits of a component, which may be different from the most recently published version.

Gets a published version of a component.

Gets detailed information about a discovered service, including a base64-encoded OpenAPI specification and an array of endpoints.

Gets information about a folder in a collection.

Gets all comments left by users in a folder.

Gets information about a Postman group within the team.

Gets information about a Postman [user group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).

Gets all requests to add workspaces to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).

**This endpoint is deprecated in Postman v10 and higher.** Gets information about all of an API version's releases.

Gets information about all APIs in a workspace. **Note:** This endpoint only returns APIs created or migrated in Postman v10 and higher.

Gets a complete list of all available audit log event actions.

Gets all of your [collections](https://www.getpostman.com/docs/collections). The response includes all of your subscribed collections. **Note:** - It's recommended that you use pagination with this endpoint. Pagination improves endpoint performance. Unpaginated calls are considered deprecated and are subject to change. - Filtering with the `name` parameter when you also pass the `limit` and `offset` parameters is not supported. - If you do not include the `workspace` query parameter, this endpoint searches all collections in your team’s workspace. If there are a lot of results, this will return a timeout error.

Gets a list of a component's published versions.

Gets a list of all components in the team's component library.

Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).

Gets a list of all the authenticated user's forked collections.

Gets all Postman groups within the team.

Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).

Gets all of an API version's relations. **Note:** In Postman v10 and higher, this endpoint returns the following: - The `unclassified` relation is for documentation and testing. This is the default relation type. - The `apiDefinition` relation is the relation used for API definitions.

Gets all active mock servers. By default, this endpoint returns only mock servers you created across all workspaces. **Note:** If you pass both the `teamId` and `workspace` query parameters, this endpoint only accepts the `workspace` query.

Gets all monitors.

Gets all active packages available to the authenticated user. **Note:** Script content isn't included in response.

Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/).

Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that share the same runner ID and key. **Note:** You can get a runner's ID in the Postman UI if you have an Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL.

Gets all Git repository connections the authenticated user has access to in the given workspace. Each connection links one Postman Collection or specification and one SDK language to a target Git repository.

Lists all SDKs the authenticated user has access to. **Note:** - Use the `sdkIds` parameter to get the generation build status of multiple SDKs in a single call. - When you pass the `sdkIds` value, other filters are ignored and the response contains only the accessible SDKs from this list.

Gets all of a mock server's server responses.

Gets a list of services in a system environment. The response includes details about analytics, compliance, and governance metadata.

Gets all API specifications in a workspace.

Gets all of the authenticated team's system environments.

Gets information about all users on the [Postman team](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/).

Gets all Postman teams in your organization.

**This endpoint is deprecated in Postman v10 and higher.** Gets all of an API version's test relations.

Gets information about all Postman team members.

Gets all the published versions of an API.

Gets a list of workspace updates for the given workspace.

Gets information workspaces added to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).

Gets all [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The response includes your workspaces and any workspaces that you have access to. **Note:** This endpoint's response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace: - `personal` — Only you can access the workspace. - `team` — All team members can access the workspace. - `private` — Only invited team members can access the workspace ([<b>Team</b> and <b>Enterprise</b> plans only](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([<b>Team</b> and <b>Enterprise</b> plans only](https://www.postman.com/pricing)).

Gets information about a mock server.

Gets a mock server's call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit is met first in one API call. Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use case. **Note:** Call logs have a retention period based on your [Postman plan](https://www.postman.com/pricing/#mock-calls). For more information, see [this article](https://support.postman.com/hc/en-us/articles/21219973964951-I-can-t-see-my-mock-server-logs-history) in the [Postman Support Center](https://support.postman.com/).

Gets information about a monitor.

Gets information about an API. **Note:** - Git-connected APIs will **only** return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files. - API viewers can only use the `versions` option in the `include` query parameter.

**This endpoint is deprecated in Postman v10 and higher.** Gets information about an API version's release.

Gets all comments left by users in an API.

Gets all the tags associated with an API.

Gets information about an API version. **In Postman v9 and earlier:** When you create an API, the system creates a single, default API version. You can use this version’s ID with any endpoints that require an API version ID.

Gets information about an environment.

Gets all of an environment's forked environments.

Returns information about the SDK, including the current build job status.

Gets information about an SDK's Git connection. The response includes the SDK currently sent to the targetBranch and the most recent SDK-update pull request.

Lists all SDK update pull requests for the Git connection, in order of newest first by its `updatedAt` property. **Note:** Direct push requests to the base branch are not returned in the response if a Git connection is configured to push only some changes directly to a base branch.

Gets a short-lived signed URL for the generated SDK archive (zip). The generated URL is created on demand and expires within a few minutes. **Note:** The API doesn't stream the archive directly to keep responses small and predictable. Use the returned URL to download the SDK zip file.

Returns a catalog of analytics resources and their corresponding metrics for use with the GET `/analytics` endpoint. These metrics provide insights on API usage, success, workspace, and team trends in Postman.

Gets an active package's metadata and its current index script content.

Gets information about a pull request, such as the source and destination details, who reviewed the pull request, the merge's current status, and whether the element is accessible.

Gets information about a request in a collection.

Gets all comments left by users in a request.

Gets information about a response in a collection.

Gets all comments left by users in a response.

Gets information about API schema. You can use the `versionId` query parameter to get a schema published in an API version. You can use this API to do the following: - Get a schema's metadata. - Get all the files in a schema. This only returns the first file in the schema. The endpoint response contains a link to the next set of response results. - Get a schema's contents in multi-file or bundled format. **Note:** The `versionId` query parameter is a **required** parameter for API viewers.

**This endpoint is deprecated in Postman v10 and higher.** Gets information about an API's definition.

Gets information about a server response.

Gets information about a service, including its health, traffic, compliance, ownership, and dependencies.

Gets a list of CI collection runs for a service that includes summary statistics, pipeline details, and Git metadata.

Get a list of observed API endpoints for a service and its performance metrics.

Gets a list of scheduled monitor runs for a service that includes summary statistics.

Gets a list of API specification lint runs for a service that includes summary statistics and per-severity issue counts.

Gets information about an API specification.

Gets the contents of an API specification's file.

Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.

Gets all the files in an API specification.

Gets all of an API specification's generated collections.

Gets a list of a specification's version tags.

Gets the status of an asynchronous collection update task.

Gets information about a system environment.

Gets the workspace-environment associations for a system environment.

Gets information about a Postman team.

Gets a team's pending access requests.

Gets a team's settings.

Gets information about a user on the Postman team.

Gets information about a Postman team member.

Gets information about the authenticated user. **Note:** - This API returns a different response for users with the [Guest and Partner roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). - The `flow_count` response only returns for users on [Free plans](https://www.postman.com/pricing/).

Gets information about an API version. **Note:** - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It also returns the `/apis/{apiId}/tasks/{taskId}` task status response header. - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending.

Gets information about a specification's version tag. The response returns a snapshot of a specification at a point in time that lets you track changes to your specifications over time.

Gets information about a workspace. **Note:** This endpoint's response also contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace: - `personal` — Only you can access the workspace. - `team` — All team members can access the workspace. - `private` — Only invited team members can access the workspace ([<b>Team</b> and <b>Enterprise</b> plans only](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([<b>Team</b> and <b>Enterprise</b> plans only](https://www.postman.com/pricing)).

Gets a workspace's [activity feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/changelog-and-restoring-collections/#view-workspace-activity). Activity feeds return information about who added or removed collections, environments, or elements from a workspace, and users that join or leave a workspace.

Gets the roles of users, user groups, and partners in a workspace. **Note:** Partner roles don't support SCIM IDs.

Gets all the tags associated with a workspace.

Gets information about a workspace update.

**This endpoint is deprecated.**

Gets the locations of secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/).

Gets a list of all [discovered services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) in the API Catalog.

**This endpoint is deprecated in Postman v10 and higher.** Gets an API version's documentation relations.

Gets the status of a collection duplication task.

Gets Postman elements (entities) by a given tag. Tags enable you to organize and search [workspaces ](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace) and [collections](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection) that contain shared tags. **Note:** Tagging is available on Postman [<b>Solo</b>, <b>Team</b>, and <b>Enterprise</b> plans plans](https://www.postman.com/pricing/).

**This endpoint is deprecated in Postman v10 and higher.** Gets an API version's environment relations.

Gets the API specification generated for the given collection.

Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). Global variables enable you to access data between collections, requests, scripts, and environments and are available throughout a workspace.

**This endpoint is deprecated.**

Gets the status of a collection's merge or a pull changes task. **Note:** After a merge's success or failure, the task's status is only available for a period of 24 hours. Afterwards, this endpoint returns an HTTP `404 Not Found` response.

**This endpoint is deprecated in Postman v10 and higher.** Gets an API version's monitor relations.

Gets all the resource types supported by Postman's SCIM API.

Gets the Postman server-side metrics for a runner instance. Metrics include information such as monitor run queues and last polling date. **Note:** You can get a runner's ID in the Postman UI if you have a Team Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL.

Gets an API schema file contents at the defined path. You can use the `versionId` query parameter to get schema file contents published in an API version. **Note:** The `versionId` query parameter is a **required** parameter for API viewers.

Gets the files in an API schema. You can use the `versionId` query parameter to get schema files published in an API version. **Note:** The `versionId` query parameter is a **required** parameter for API viewers.

Gets the metadata of the secret types supported by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). You can use a secret type's ID in the response to query data with the POST `/detected-secrets/{secretId}` endpoint.

Gets the Postman SCIM API configuration information. This includes a list of supported operations.

Checks whether there is a change between the forked collection and its parent (source) collection. If the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the forked collection and its source collection. **Note:** This endpoint may take a few minutes to return an updated `isSourceAhead` status.

Gets the status of an asynchronous API specification creation task.

Gets the status of an asynchronous task.

Returns the status of an API Builder definition’s migration to Spec Hub.

Gets a list of your team's generated audit events. For a complete list of all audit events, see [Audit logs](https://learning.postman.com/docs/administration/audit-logs/).

**This endpoint is deprecated.**

**This endpoint is for Postman v10 and higher.** Gets all of an API version's unclassified relations. Unclassified relations are used for documentation and testing. This is the default relation type.

Gets all invoices for a Postman billing account filtered by the status of the invoice.

Manages invitations and access to your team's [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/). You can use this endpoint to: - Send Partner Workspace invitations to the given email addresses. Users who already exist in the partnership are added directly, while new users receive an invitation email. - Remove partners from a workspace. - Remove partners from a partnership and all of its workspaces. **Note:** - Partner Workspaces are available on the Postman **Team** and **Enterprise** [plans](https://www.postman.com/pricing/). - This endpoint requires the following [roles](https://learning.postman.com/docs/administration/roles-and-permissions/), based on your plan: - **Team** — Requires the **Workspace Editor** role to invite or remove partners from workspaces. The **Admin** role is required for removing partners from all workspaces. - **Enterprise** — The **Partner Manager** role can perform all operations. The **Workspace Editor** role and **Admin** roles have the same permissions on this plan as they do on the Team plan. It's recommended to use the **Partner Manager** role if you're on an Enterprise plan.

Adds or removes roles in groups, teams, organizations, as well as individual users' roles. **Note:** If you remove a role from a group or team, then all members lose the that role's permissions.

**This endpoint is deprecated.** Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork. Include the following required properties in the request body: - `source` — A **string** value that contains the source collection's unique ID. - `destination` — A **string** value that contains the destination (parent) collection's unique ID. You can also include the following optional properties in the request body: - `strategy` — A **string** value that contains the fork's merge strategy. One of: - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You must have Editor access to both the parent and forked collections. - `updateSourceWithDestination` — (Default) Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork.

[Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment.

[Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked (source) collection and its parent (destination) collection asynchronously. To pull changes into a fork, pass the forked collection's ID as the `destination` value and the parent collection ID as the `source` value. The response returns a task `id` value, which you can use to track the merge's status with the GET `/collection-merges-tasks/{taskId}` endpoint.

Migrates an API Builder definition to a [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview) specification. You can migrate the definition to an existing workspace, or create a new workspace to migrate the definition into. On success, this returns an HTTP `202 Created` response. You can use the GET `/apis/{apiId}/spec-migrations` endpoint to check the migration status. **Note:** - This returns an HTTP `200 OK` response if the given API ID isn't an API Builder definition. - To migrate a Git-linked API Builder definition to Spec Hub, you must create a new workspace. Migration to an existing workspace isn't supported.

Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.

Publishes a collection's documentation. This makes it publicly available to anyone with the link to the documentation. **Note:** - Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints: - For **Free** and **Solo** users, you must have permissions to edit the collection. - If [API Governance and Security](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [<b>Enterprise</b>](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation. - Publishing is only supported for collections with HTTP requests. - You cannot publish a collection added to an API.

Pulls the changes from a parent (source) collection into the forked collection. In the endpoint's response: - The `destinationId` is the ID of the forked collection. - The `sourceId` is the ID of the source collection.

[Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment.

Removes an element or delete a folder from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). **Note:** Removing an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.

Removes a workspace from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). **Note:** Removing a workspace does not delete it. It only removes it from the Private API Network folder.

Removes workspace-environment associations from a system environment.

Removes entities, such as users or organizations, from your Postman team. On success, this returns an HTTP `204 No Content` response.

Replaces the contents of a collection. Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items and creates new items. - For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). - For protocol profile behavior, refer to Postman's [Protocol Profile Behavior](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md) documentation. **Note:** - The maximum collection size this endpoint accepts cannot exceed 100 MB. - This request uses example values in the request body for context when replacing a collection's data. For additional ways to replace collection data, see the collection's examples. - If you don't include the collection items' ID values from the request body, the endpoint **removes** the existing items and recreates the items with new ID values. - To copy another collection's contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id` values.

Replaces all the contents of an environment with the given information. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - Only [<u>shared variable</u>](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.

Resolves a comment and any associated replies. On success, this returns an HTTP `204 No Content` response. Comment thread IDs return in the GET `/comments` response for [collections](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-a6582e0a-9382-4760-8b91-53a8aa6cb8d7) and [collection items](https://www.postman.com/postman/workspace/postman-public-workspace/folder/12959542-efeda219-66e1-474c-a83b-253d15723bf7).

Responds to a user's request to add a workspace to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can approve or deny a request. Once approved, the workspace will appear in the team's Private API Network.

Updates the [review](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/) status of a pull request.

Returns all secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/), grouped by workspace or resource. If you pass an empty request body, this endpoint returns all results. You can include the following properties in the request body: - `secretTypes` — An **array** that contains a list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint. - `resolved` — A **boolean** value that, if true, return secrets with a `resolved` status. - `statuses` — An **array** that contains a list of the secret resolution status type: - `FALSE_POSITIVE` — The discovered secret is not an actual secret. - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue. - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it. - `resources` — An **array of objects** that contains a list of resources to query: - `type` — The type of resource: - `collection` - `environment` - `extensible-collection` - `globals` - `example` - `request` - `folder` - `extensible-collection-meta` - `extensible-request` - `extensible-folder` - `extensible-example` - `extensible-message` - `api-definition-file` - `api-definition` - `ids` — An **array of string** containing the element IDs to search. - `workspaceIds` — An **array** that contains a list of workspaces IDs to query. - `workspaceVisibilities` — An **array** that contains a list of workspace [visibility settings](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) to query. This currently supports the `team` and `public` settings. **Note:** The `workspaceIds` and `resources` properties are mutually exclusive. You can only use one in a request. If you pass both, the API returns an HTTP 400 `Bad Request` response.

Searches Postman for resources such as workspaces, collections, requests, and other resource types. You can filter results by ownership, visibility, tags, and other criteria. **Note:** If you call this endpoint without an API key, the response only returns publicly-available resources.

Syncs an API version's relation with the API's definition.

Syncs a collection attached to an API with the API schema. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the Location header. **Note:** This endpoint only supports the OpenAPI 3 schema type.

Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given specification ID.

Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync specs generated from the given collection ID.

Transfers a [Postman element](https://learning.postman.com/docs/getting-started/basics/postman-elements/) from one workspace to another workspace. Supported elements include collections, environments, mocks, monitors, and Flows modules and actions. When copying an element between workspaces, the [activity feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/workspace-activity/) for both workspaces update to reflect the change. **Note:** This endpoint does not support transferring elements from team workspaces to personal workspaces.

Copies or moves folders into a collection or folder.

Copies or moves requests into a collection or folder.

Copies or moves responses into a request.

Transfers a workspace from one team (`source`) to another team (`destination`). **Note:** - This endpoint is only available with [Postman Enterprise plans](https://www.postman.com/pricing/) with [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) enabled. - Team user roles are modified when workspaces are transferred. For example, if a user has the Admin role in the `source` team but not the `destination` team, then their role is removed from the workspace after it's transferred to the `destination` team.

Transforms an existing Postman Collection into a stringified OpenAPI definition. **Note:** This does **not** create an API.

Unpublishes a mock server. Unpublishing a mock server sets its **Access Control** configuration setting to private.

Updates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters.

Updates a comment on an API's collection. Include the following in request body: - `body` — (Required) A **string** that contains the updated comment. - `tags` — An **object** that contains information about users tagged in the `body` comment. Include the following in this object: - `userName` — (Required) An **object** that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. Include the following in this object: - `type` — (Required) A **string** that contains the user value. - `id` — (Required) An **integer** that contains the user's ID. **Note:** This endpoint accepts a max of 10,000 characters.

Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response. **Note:** - Only users assigned the `EDITOR` [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint. - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

Updates a collection's associated tags. This endpoint replaces all existing tags with those you pass in the request body. **Note:** - You can only add a maximum of five tags to a collection. - Tags must be between 2 and 64 characters long. - Tags must follow the `^[a-z][a-z0-9-]\\\\\\*[a-z0-9]+$` pattern.

Updates a component: - `name` — Rename the component. The new name must be unique within the team. Archived components can't be renamed. - `status` — Changes the component's lifecycle state: - `archive` — Marks the component as read-only. Archived components aren't deleted and can't be edited or published, but their existing versions remain accessible. - `active` — Restores the component. Only active components can be edited and published. **Note:** You can't update a name and archived state in a single call. To change both properties, make separate calls to update the name and status.

Updates a component's draft. Component drafts contain unpublished edits to a component, which may be different from a recently published version. **Note:** You can't update archived components.

Updates a folder in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when updating collection folders. For additional ways to update a folder, see the collection's examples. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does **not** update the entire resource.

Updates a comment on a folder. **Note:** This endpoint accepts a max of 10,000 characters.

Updates a group's information. Using this endpoint you can: - Update a group's name. - Add or remove members from a Postman group.

Updates a mock server's properties, such as its name or collection.

Updates a monitor.

Updates an API.

**This endpoint is deprecated in Postman v10 and higher.** Updates an API version's release. Include at least one of the following properties in the `release` object: - `name` — A **string** value that contains the release name. - `visibility` — A **string** value that contains the release's visibility. One of: - `private` — The release is private. - `public` — The release is public. - `summary` — A **string** value that contains the release's summary. - `description` — A **string** value that contains the release's description. - `gitTag` — A **string** value that contains a valid [Git tag](https://docs.github.com/en/rest/git/tags) ID. The tag must exist in the API's connected Git repository.

Updates a comment on an API. Include the following in request body: - `body` — (Required) A **string** that contains the updated comment. - `tags` — An **object** that contains information about users tagged in the `body` comment. Include the following in this object: - `userName` — (Required) An **object** that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. Include the following in this object: - `type` — (Required) A **string** that contains the user value. - `id` — (Required) An **integer** that contains the user's ID. **Note:** This endpoint accepts a max of 10,000 characters.

Gets all the tags associated with an API. This endpoint replaces all existing tags with those you pass in the request body. **Note:** - You can only add a maximum of five tags to an API. - Tags must be between 2 and 64 characters long. - Tags must follow the `^[a-z][a-z0-9-]\\\\\*[a-z0-9]+$` pattern.

**This endpoint is deprecated in Postman v10 and higher.** Updates an API version. Include the following request body properties in the `version` object: - `name` — A **string** that contains the API version's name.

Updates an element or folder in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). When you call this endpoint, the `elementType` property must be the `api`, `folder`, `collection`, or `workspace` value. The `elementId` value is the `api`, `folder`, or `workspace` element's ID. For `collection`, this value is the collection's UID (`userId`\-`collectionId`). Include the following in the request body object: - `elementType` — The Private API Network element type. The object's name must be one of the following: - `api` - `folder` - `collection` - `workspace` In the `elementType` object, include the following values: - `parentFolderId` — A **string** value that contains the element's new Private API Network folder ID. **For Collections:** - `summary` — A **string** value that contains the collection's new summary. **For Private API Network Folders:** You can include the following optional properties: - `description` — A **string** value that contains the folder's new description. - `name` — A **string** value that contains the folder's new name.

Updates specific environment properties, such as its name and variables. **Note:** - You can only perform one type of operation at a time. For example, you cannot perform an `add` and `replace` operation in the same call. - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - To add a description to an existing variable, use the `add` operation. - Only [<u>shared variable</u>](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.

Updates the Git connection's lifecycle status: - `active` — Connects or reconnects the repository. All auto-update pull requests resume. - `disconnected` — Disconnects the repository, and no further auto-update pull requests are opened. The historical pull request record is preserved and remains queryable. **Note:** - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users. If the user is on a **Team** plan, this value is always `false`. - This action is idempotent. Setting the fields to their current values is a no-op and still returns the connection. - The `inaccessible` status is system-determined and can't be set with this endpoint.

Updates a package's description and/or index script content.

Updates an open pull request.

Updates a request in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when updating collection requests. For additional ways to create a request, see the collection's examples. - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does **not** update the entire resource. - This endpoint does not support changing the folder of a request.

Updates a comment on a request. **Note:** This endpoint accepts a max of 10,000 characters.

Updates a response in a collection. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - This request uses example values in the request body for context when updating collection responses. For additional ways to create a response, see the collection's examples. - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does **not** update the entire resource.

Updates a comment on a response. **Note:** This endpoint accepts a max of 10,000 characters.

**This endpoint is deprecated in Postman v10 and higher.** Updates an API definition. The request body must contain a `schema` object with the following properties: - `type` — A **string** value that contains the API definition's type. One of: - `openapi3_1` - `openapi3` - `openapi2` - `openapi1` - `raml` - `raml1` - `wsdl1` - `wsdl2` - `graphql` - `proto2` - `graphql` - `proto3` - `language` — A **string** value that contains the API definition's language. One of: - OpenAPI and RAML — `json` or `yaml` - GraphQL — `graphql` - WSDL — `xml` - Protobuf — `proto` - `schema` — Optional. A **string** value that contains the API definition's contents.

Updates a mock server's server response.

Updates a file for an OpenAPI specifications and protobuf 2 and 3 specifications. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time. - Multi-file specifications can only have one root file. - When updating a file type to `ROOT`, the previous root file is updated to the `DEFAULT` file type. - Files cannot exceed a maximum of 10 MB in size.

Updates an API specification's properties, such as its name.

Updates a system environment's information. You can update one or more fields in a single call. **Note:** If you update the name, it must be unique within the team.

Updates a user in Postman. ### Reactivating users By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.

Updates a user in Postman. ### Reactivating users By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team.

Updates an API version. Include at least one of the following properties in the request body: - `name` — A **string** value that contains the version name. - `releaseNotes` — A **string** value that contains the Markdown-supported release notes. **Note:** This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.

Updates a workspace's property, such as its name or visibility. **Note:** - This endpoint does <u>not</u> support the following workspace visibility changes: - `private` to `public`, `public` to `private`, and `private` to `personal` for **Free** and **Solo** [plans](https://www.postman.com/pricing/). - `public` to `personal` for team users only. - There are rate limits when publishing public workspaces. - Public team workspace names must be unique.

Updates a workspace's associated tags. This endpoint replaces all existing tags with those you pass in the request body. **Note:** - You can only add a maximum of five tags to an API. - Tags must be between 2 and 64 characters long. - Tags must follow the `^[a-z][a-z0-9-]\\\\\\*[a-z0-9]+$` pattern.

Updates a workspace update. **Note:** This endpoint requires the `application/merge-patch+json` Content-Type header.

Updates the resolution status of a secret detected in a workspace.

Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body.

Updates specific collection information, such as its authentication, name, events, or variables. For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** This request uses example values in the request body for context when replacing a collection's data. For additional ways to replace collection data, see the collection's examples.

Updates the [sync options](https://learning.postman.com/docs/design-apis/specifications/generate-collections/#configure-sync-settings) for a specification's generated collection.

Updates a team's settings.

Updates the roles of users, [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/), or partners in a workspace. To get a list of roles, use the [GET /workspace-roles](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-f4250b7c-87a6-46ba-a58b-02081131a67c) endpoint. **Note:** - User groups are available on Postman [Enterprise plans](https://www.postman.com/pricing). - To use SCIM IDs for users and user groups, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, use the `include=scim` query parameter when calling the [GET /workspaces/{workspaceId}](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-3a56b6f8-8d0c-410f-a933-03e26589c742?ctx=documentation) or [GET /workspaces](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-f027a0fa-9012-4654-a65d-2b751a3154a9) endpoints. - You can't set roles for users in personal workspaces. - This endpoint doesn't support the external [Guest role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). - The partner **Editor** and **Editor and Partner Lead** roles aren't supported in multi-partner workspaces. - You can't update partner and user roles in the same operation. - This endpoint is restricted to 50 operations per call. - The request body must contain one unique action per user, user group, or partner. For example, you cannot add and remove multiple roles for a user in the same request body.