Skip to content

Document the new Query value for the -Method parameter of Invoke-WebRequest #13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soroshsabz wants to merge 3 commits into
base: main
Choose a base branch
from
+40 −4
Open

Document the new Query value for the -Method parameter of Invoke-WebRequest #13307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a00f82
Document the new Query value for the -Method parameter of Invoke-WebR…
soroshsabz Sep 25, 2026
0d59f16
Remove some extra sentences
soroshsabz Sep 25, 2026
44cdb46
Make example normal form
soroshsabz Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions reference/7.7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Utility
ms.date: 01/20/2026
ms.date: 09/26/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/invoke-restmethod?view=powershell-7.7&WT.mc_id=ps-gethelp
schema: 2.0.0
aliases:
Expand Down Expand Up @@ -337,6 +337,20 @@ Unix socket.
Invoke-RestMethod -Uri http://localhost/v1.40/images/json -UnixSocket '/var/run/docker.sock'
```

### Example 10: Send a search request using the HTTP QUERY method

This example sends a search request using the HTTP QUERY method. The QUERY method is safe and
idempotent like GET, but it carries the query parameters in the request body instead of the URI.
Because the `Query` method isn't given a default content-type, the example explicitly sets the
**ContentType** parameter.

```powershell
$uri = 'https://api.contoso.com/search'
$body = @{ term = 'powershell'; limit = 10 }
$contentType = 'application/x-www-form-urlencoded'
Invoke-RestMethod -Uri $uri -Method Query -Body $body -ContentType $contentType
```

## PARAMETERS

### -AllowInsecureRedirect
Expand Down Expand Up @@ -854,16 +868,20 @@ Specifies the method used for the web request. The acceptable values for this pa
- `Options`
- `Patch`
- `Post`
- `Query`
- `Put`
- `Trace`

> [!NOTE]
> The `Query` value was added in PowerShell 7.7.

The **CustomMethod** parameter can be used for Request Methods not listed above.

```yaml
Type: Microsoft.PowerShell.Commands.WebRequestMethod
Parameter Sets: StandardMethod, StandardMethodNoProxy
Aliases:
Accepted values: Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Accepted values: Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch, Query

Required: False
Position: Named
Expand Down
22 changes: 20 additions & 2 deletions reference/7.7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Utility
ms.date: 01/20/2026
ms.date: 09/26/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/invoke-webrequest?view=powershell-7.7&WT.mc_id=ps-gethelp
schema: 2.0.0
aliases:
Expand Down Expand Up @@ -418,6 +418,20 @@ Unix socket.
Invoke-WebRequest -Uri http://localhost/v1.40/images/json -UnixSocket '/var/run/docker.sock'
```

### Example 12: Send a search request using the HTTP QUERY method

This example sends a search request using the HTTP QUERY method. The QUERY method is safe and
idempotent like GET, but it carries the query parameters in the request body instead of the URI.
Because the `Query` method isn't given a default content-type, the example explicitly sets the
**ContentType** parameter.

```powershell
$uri = 'https://api.contoso.com/search'
$body = @{ term = 'powershell'; limit = 10 }
$contentType = 'application/x-www-form-urlencoded'
Invoke-WebRequest -Uri $uri -Method Query -Body $body -ContentType $contentType
```

## PARAMETERS

### -AllowInsecureRedirect
Expand Down Expand Up @@ -887,16 +901,20 @@ Specifies the method used for the web request. The acceptable values for this pa
- `Options`
- `Patch`
- `Post`
- `Query`
- `Put`
- `Trace`

> [!NOTE]
> The `Query` value was added in PowerShell 7.7.

The **CustomMethod** parameter can be used for Request Methods not listed above.

```yaml
Type: Microsoft.PowerShell.Commands.WebRequestMethod
Parameter Sets: StandardMethod, StandardMethodNoProxy
Aliases:
Accepted values: Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Accepted values: Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch, Query

Required: False
Position: Named
Expand Down