Built-in cmdlet

Invoke-RestMethod cmdlet

Sends an HTTP or HTTPS request to a RESTful web service.

Availability: PowerShell version and module availability vary; check the installed system中文

Syntax

Invoke-RestMethod [-Uri] <uri> [-Method <WebRequestMethod>]

This is a practical syntax summary, not every parameter set. Run Get-Command Invoke-RestMethod -Syntax and Get-Help Invoke-RestMethod -Full in the installed version for its complete syntax and parameter metadata. Common parameters and -WhatIf/-Confirm support depend on the command and PowerShell version.

Examples

Example usage of Invoke-RestMethod.

Invoke-RestMethod -Uri https://api.example.com/status

Read all available parameter sets and help for the installed module.

Get-Help Invoke-RestMethod -Full

Parameters, options and clauses

Option / clause	Description
`-Uri <uri>`	Specify the API endpoint.
`-Method <method>`	Choose the HTTP method.
`-Body <object>`	Provide request data in the format expected by the API.
`-ContentType <type>`	Set the request content type.
`-Headers <hashtable>`	Add authentication or other request headers.
`-Verbose`	Write additional diagnostic detail to the verbose stream.
`-Debug`	Write debugging messages to the debug stream.
`-ErrorAction <action>`	Control how a non-terminating error is handled.
`-ErrorVariable <name>`	Store error records in a variable.
`-WarningAction <action>`	Control how warnings are handled.
`-WarningVariable <name>`	Store warning messages in a variable.
`-InformationAction <action>`	Control how information messages are handled.
`-InformationVariable <name>`	Store information messages in a variable.
`-OutVariable <name>`	Store output in a variable as well as sending it onward.
`-OutBuffer <count>`	Set the number of objects to collect before the next command runs.
`-PipelineVariable <name>`	Store the current pipeline object in a variable during processing.
`-ProgressAction <action>`	Control progress reporting in versions that support this parameter.
`-WhatIf / -Confirm`	Risk-control parameters available only on commands that support ShouldProcess.

Related PowerShell references

PowerShell common parameters ↗

Safety note

Review a command and its target before running it. Commands that alter files, services, accounts, disks, permissions or databases may be difficult to reverse. Test in a safe environment and keep backups.

Official reference ↗Back to directory