Postman

This extension is currently in its beta phase. We appreciate your feedback and patience as we fine-tune its capabilities.

The Postman VS Code extension enables you to develop and test your APIs in Postman directly from Visual Studio Code.

Signing in to Postman

The Postman VS Code extension is available on Free, Basic, and Professional plans.

Sign in to Postman, and select a team to access workspaces in the team. When you select a workspace, you'll be able to see the request history for that workspace in the sidebar. You must sign in to Postman to use the VS Code extension.

1. Open the VS Code extension.
2. Select Sign In in the sidebar. The extension will open a new screen that directs you to sign in from your browser.
3. In your browser, select a Postman team then sign in to Postman. After you sign in, you can close the browser tab and return to the extension.

To learn more about signing in to Postman, see Postman's documentation.

If you don't have a Postman account, create an account to sign in to use the VS Code extension:

1. Open the VS Code extension.
2. Select Create Account in the sidebar. The extension will open a new screen that directs you to create an account from your browser.
3. In your browser, enter your information then select Create free account.

To learn more about signing up for Postman, see Postman's documentation.

Sending requests

You can create and send HTTP requests.

1. Select a workspace from the workspace dropdown menu in the sidebar.

   You can also create a new workspace from the VS Code extension.

2. Select the request dropdown menu in the sidebar, then select HTTP.

   If you previously selected HTTP from the request dropdown menu, you can create another HTTP request by selecting New HTTP Request in the sidebar.

3. Specify the details you need for your request.

4. Select Send.

Requests sent in the VS Code extension appear in your workspace's request history in both the extension and the Postman app.

To learn more about creating and sending HTTP requests, see Postman's documentation.

You can can also use the Postman: Create a new HTTP Request command from the Command Palette to send a request.

Sending multiprotocol requests

You can create and send raw WebSocket and gRPC requests.

1. When you create a request, select the request dropdown menu first, and select WebSocket or gRPC instead of HTTP.

1. For WebSocket:

   1. Enter the WebSocket server URL. A WebSocket URL begins with ws:// or wss://.
   2. Select Connect.
   3. To disconnect your WebSocket request's connection, select Disconnect.

1. For gRPC:

   1. Enter a URL into Server URL.
   2. Select the Method selection dropdown to select the method you want to invoke.
   3. Configure a service definition.
   4. Select Invoke.

To learn more about creating and sending WebSocket requests, see Postman's documentation.

To learn more about creating and sending gRPC requests, see Postman's documentation.

Sending requests from your history

You can send requests previously sent in a workspace using the VS Code extension and the Postman app.

1. Select a workspace from the workspace dropdown menu in the sidebar.
2. Select a request from your history, and edit the request if you'd like.
3. Send the request.

Using cookies

You can view and edit cookies associated with different domains. You can then use the cookies stored in the cookie jar when sending HTTP requests in Postman.

To manage cookies in the VS Code extension, open an HTTP request, then select Cookies (below Send).

You can also open the cookie editor with the Postman: Open cookies editor command in the Command Palette.

To learn more about using cookies, see Postman's documentation.

Importing with cURL commands

You can use cURL commands to import data and create requests from the data.

1. Select a workspace from the workspace dropdown menu in the sidebar.

   You can also create a new workspace from the VS Code extension.

2. Select the request dropdown menu in the sidebar, then select Import cURL.

3. Enter your cURL command into the input field, then press Enter. The VS Code extension opens a request in a new tab.

   To cancel entering a cURL command, press Escape.

Sharing feedback

You can create a bug or feature request for the VS Code extension.

1. Select the Report Bug / Share Feedback icon at the top of the sidebar. The extension will open a new screen that directs you to GitHub in your browser.
2. In your browser, select Get started to create a bug or feature request.
3. Enter the bug or feature request details, then select Submit new issue.

Features coming soon

The following features are coming soon to the VS Code extension:

Support for working with collections and environments in your workspace.

Viewing the extension log

The extension log displays events related to the VS Code extension.

1. Select the Views and More Actions icon at the top of the sidebar.
2. Select Open Extension Log. The extension log will open in a new tab.

Viewing the version

To view the version of the VS Code extension you're using, do the following:

1. Select the Views and More Actions icon at the top of the sidebar.
2. Select Version.